Edit

Share via

Set-EntraPermissionGrantPolicy

Module:
Microsoft.Entra Module v1.1

Updates a permission grant policy.

Syntax

Default (Default) 

Set-EntraPermissionGrantPolicy

    -Id <String>
    [-DisplayName <String>]
    [-Description <String>]
    [<CommonParameters>]

Description

The Set-EntraPermissionGrantPolicy command updates a Microsoft Entra ID permission grant policy.

Examples

Example 1: Update description of permission grant policy

Connect-Entra -Scopes 'Policy.ReadWrite.PermissionGrant'
$policy = Get-EntraPermissionGrantPolicy | Where-Object { $_.DisplayName -eq 'Microsoft User Default Recommended Policy' }
Set-EntraPermissionGrantPolicy -Id $policy.Id -Description 'Updated description'

This command updates the description of the specified permission grant policy.

  • -Id parameter specifies the unique identifier of the permission grant policy.
  • -Description parameter specifies the description for the permission grant policy.

Example 2: Update display name of permission grant policy

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

This command updates the display name of the specified permission grant policy.

  • -Id parameter specifies the unique identifier of the permission grant policy.
  • -DisplayName parameter specifies the display name for the permission grant policy.

Parameters

-Description

Specifies the description of the permission grant policy.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayName

Specifies the display name of the permission grant policy.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Specifies the unique identifier of the permission grant policy.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

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.