Edit

Share via

Set-EntraPermissionGrantPolicy

  • Reference
Module:
Microsoft.Graph.Entra

Updates a permission grant policy.

Syntax

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'}
$params = @{
    Id = $policy.Id
    Description = 'Updated description'
}

Set-EntraPermissionGrantPolicy @params

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'}
$params = @{
    Id = $policy.Id
    DisplayName = 'Updated DisplayName'
}

Set-EntraPermissionGrantPolicy @params

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.

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

-DisplayName

Specifies the display name of the permission grant policy.

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

-Id

Specifies the unique identifier of the permission grant policy.

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