Set-EntraPolicy

Set-EntraPolicy

    -Id <String>
    [-Definition <System.Collections.Generic.List`1[System.String]>]
    [-DisplayName <String>]
    [-Type <String>]
    [-IsOrganizationDefault <Boolean>]
    [<CommonParameters>]

The Set-EntraPolicy cmdlet sets a policy in Microsoft Entra ID. Specify Id parameter to updates specific policy.

Connect-Entra -Scopes 'Policy.ReadWrite.ApplicationConfiguration'
$policy = Get-EntraPolicy | Where-Object { $_.DisplayName -eq 'Microsoft User Default Recommended Policy' }
Set-EntraPolicy -Id $policy.Id -DisplayName 'NewUpdated'

This command updates display name of the specified policy in Microsoft Entra ID.

• -Id specifies the ID of the policy for which you want to set values.
• DisplayName specifies the display name.

Connect-Entra -Scopes 'Policy.ReadWrite.ApplicationConfiguration'
$policy = Get-EntraPolicy | Where-Object { $_.DisplayName -eq 'Microsoft User Default Recommended Policy' }
$definition = @('{"activityBasedTimeoutPolicies":{"AlternateLoginIDLookup":true, "IncludedUserIds":["UserID"]}}')
Set-EntraPolicy -Id $policy.Id -Definition $definition

This command updates definition of the specified policy in Microsoft Entra ID.

• -Id specifies the ID of the policy for which you want to set values.
• Definition specifies the array of stringified JSON that contains all the rules of the policy. In this example, @('{"activityBasedTimeoutPolicies":{"AlternateLoginIDLookup":true, "IncludedUserIds":["UserID"]}}') represents definition of the activityBasedTimeoutPolicy.

Connect-Entra -Scopes 'Policy.ReadWrite.ApplicationConfiguration'
$policy = Get-EntraPolicy | Where-Object { $_.DisplayName -eq 'Microsoft User Default Recommended Policy' }
Set-EntraPolicy -Id $policy.Id -IsOrganizationDefault $false

This command updates organization default of the specified policy in Microsoft Entra ID.

• -Id specifies the ID of the policy for which you want to set values.
• -IsOrganizationDefault If true, activates this policy. Only one policy of the same type can be the organization default. Optional, default is false.

Connect-Entra -Scopes 'Policy.ReadWrite.ApplicationConfiguration'
$policy = Get-EntraPolicy | Where-Object { $_.DisplayName -eq 'Microsoft User Default Recommended Policy' }
Set-EntraPolicy -Id $policy.Id -Type 'ActivityBasedTimeoutPolicy'

This example demonstrates how to update the type property of a specified policy in Microsoft Entra ID.

• -Id specifies the ID of the policy for which you want to set values.
• -Type specifies the type of policy. In this example, ActivityBasedTimeoutPolicy represents the type of policy.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.