Edit

Share via

Set-EntraPolicy

  • Reference
Module:
Microsoft.Graph.Entra

Updates a policy.

Syntax

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

Description

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

Examples

Example 1: Update a policy display name

Connect-Entra -Scopes 'Policy.ReadWrite.ApplicationConfiguration'
$params = @{
    Id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'
    DisplayName = 'NewUpdated'
}
Set-EntraPolicy @params

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.

Example 2: Update a policy definition

Connect-Entra -Scopes 'Policy.ReadWrite.ApplicationConfiguration'
$params = @{
    Id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'
    Definition = @('{"activityBasedTimeoutPolicies":{"AlternateLoginIDLookup":true, "IncludedUserIds":["UserID"]}}')
}
Set-EntraPolicy @params

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.

Example 3: Update a policy organization default

Connect-Entra -Scopes 'Policy.ReadWrite.ApplicationConfiguration'
$params = @{
    Id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'
    IsOrganizationDefault = $false
}
Set-EntraPolicy @params

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.

Example 4: Update policy type

Connect-Entra -Scopes 'Policy.ReadWrite.ApplicationConfiguration'
$params = @{
    Id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'
    Type = 'ActivityBasedTimeoutPolicy'
}
Set-EntraPolicy @params

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.

Parameters

-Definition

Specifies the array of stringified JSON that contains all the rules of the policy. For example -Definition @('{"TokenLifetimePolicy":{"Version":1,"MaxInactiveTime":"20:00:00"}}').

Type:System.Collections.Generic.List`1[System.String]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayName

Specifies the display name.

Type:System.String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

The ID of the policy for which you want to set values.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-IsOrganizationDefault

True if this policy is the organizational default.

Type:System.Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Type

Specifies the type of policy. For token lifetimes, use "TokenLifetimePolicy."

Type:System.String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False