Set-EntraDirectoryRoleDefinition

Zaktualizuj istniejącą Microsoft Entra ID roleDefinition.

Składnia

Default (domyślnie)

Set-EntraDirectoryRoleDefinition

    [-TemplateId <String>]
    [-DisplayName <String>]
    [-RolePermissions <System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RolePermission]>]
    -UnifiedRoleDefinitionId <String>
    [-Description <String>]
    [-Version <String>]
    [-IsEnabled <Boolean>]
    [-ResourceScopes <System.Collections.Generic.List`1[System.String]>]
    [<CommonParameters>]

Opis

Aktualizuje obiekt Microsoft Entra roleDefinition zidentyfikowany przez identyfikator. Nie można zaktualizować wbudowanych ról. Ta funkcja wymaga licencji Microsoft Entra ID P1 lub P2.

W scenariuszach delegowanych zalogowany użytkownik musi mieć obsługiwaną rolę Microsoft Entra lub rolę niestandardową z niezbędnymi uprawnieniami. Minimalne role wymagane dla tej operacji to:

  • Administrator ról uprzywilejowanych

Przykłady

Przykład 1. Aktualizowanie roliDefinition

Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$roleDefinition = Get-EntraDirectoryRoleDefinition -Filter "DisplayName eq '<Role-Definition-Name>'"
Set-EntraDirectoryRoleDefinition -UnifiedRoleDefinitionId $roleDefinition.Id -DisplayName 'UpdatedDisplayName'

W tym przykładzie zaktualizowano określoną definicję roli w Microsoft Entra ID.

  • -UnifiedRoleDefinitionId parametr określa identyfikator obiektu roleDefinition.
  • -DisplayName parametr określa nazwę wyświetlaną definicji roli.

Przykład 2. Aktualizowanie definicji roli za pomocą opisu

Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$roleDefinition = Get-EntraDirectoryRoleDefinition -Filter "DisplayName eq '<Role-Definition-Name>'"
Set-EntraDirectoryRoleDefinition -UnifiedRoleDefinitionId $roleDefinition.Id -Description 'MYROLEUPDATE1S'

W tym przykładzie zaktualizowano opis określonej definicji roli w Microsoft Entra ID.

  • -UnifiedRoleDefinitionId parametr określa identyfikator obiektu roleDefinition.
  • -Description parametr określa opis definicji roli.

Przykład 3. Aktualizowanie elementu roleDefinition za pomocą elementu IsEnabled

Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$roleDefinition = Get-EntraDirectoryRoleDefinition -Filter "DisplayName eq '<Role-Definition-Name>'"
Set-EntraDirectoryRoleDefinition -UnifiedRoleDefinitionId $roleDefinition.Id -IsEnabled $true

W tym przykładzie zaktualizowano parametr IsEnabled określonej definicji roli w Microsoft Entra ID.

  • -UnifiedRoleDefinitionId parametr określa identyfikator obiektu roleDefinition.
  • -IsEnabled Parametr określa, czy definicja roli jest włączona.

Przykład 4. Aktualizowanie roliDefinition

Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$roleDefinition = Get-EntraDirectoryRoleDefinition -Filter "DisplayName eq '<Role-Definition-Name>'"
$rolePermissions = New-object Microsoft.Open.MSGraph.Model.RolePermission
$rolePermissions.AllowedResourceActions = @("microsoft.directory/applications/standard/read")
$params = @{
    UnifiedRoleDefinitionId = $roleDefinition.Id
    Description             = 'Update'
    DisplayName             = 'Update'
    ResourceScopes          = '/'
    IsEnabled               = $false
    RolePermissions         = $rolePermissions
    TemplateId              = 'f2ef992c-3afb-46b9-b7cf-a126ee74c451'
    Version                 = 2
}
Set-EntraDirectoryRoleDefinition @params

W tym przykładzie zaktualizowano rolePermissions, TemplateId, TemplateId, ResourceScopes określonej definicji roli w Microsoft Entra ID.

  • -UnifiedRoleDefinitionId parametr określa identyfikator obiektu roleDefinition.
  • -RolePermissions parametr określa uprawnienia definicji roli.
  • -IsEnabled Parametr określa, czy definicja roli jest włączona.
  • -DisplayName parametr określa nazwę wyświetlaną definicji roli.
  • -Description parametr określa opis definicji roli.
  • -ResourceScopes parametr określa zakresy zasobów dla definicji roli.
  • -TemplateId parametr określa identyfikator szablonu dla definicji roli.
  • -Version parametr określa wersję definicji roli.

Parametry

-Description

Określa opis definicji roli.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-DisplayName

Określa nazwę wyświetlaną definicji roli.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-IsEnabled

Określa, czy definicja roli jest włączona. Flaga wskazująca, czy rola jest włączona dla przypisania. Jeśli wartość false, rola nie jest dostępna dla przypisania. Tylko do odczytu, jeśli isBuiltIn ma wartość true.

Właściwości parametru

Typ:System.Boolean
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ResourceScopes

Określa zakresy zasobów dla definicji roli.

Właściwości parametru

Typ:

System.Collections.Generic.List`1[System.String]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-RolePermissions

Określa uprawnienia dla definicji roli. Lista uprawnień uwzględnionych w roli. Tylko do odczytu, gdy isBuiltIn ma wartość true.

Właściwości parametru

Typ:

System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RolePermission]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-TemplateId

Określa identyfikator szablonu dla definicji roli. Identyfikator szablonu niestandardowego można ustawić, gdy isBuiltIn ma wartość false. Ten identyfikator jest zwykle używany do przechowywania tego samego identyfikatora w różnych katalogach. Jest tylko do odczytu, gdy isBuiltIn ma wartość true.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-UnifiedRoleDefinitionId

Określa identyfikator obiektu roleDefinition.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Id

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-Version

Określa wersję definicji roli. Wskazuje wersję definicji roli. Tylko do odczytu, gdy isBuiltIn ma wartość true.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

System.String

Dane wyjściowe

System.Object

Notatki

Set-EntraRoleDefinition to alias dla elementu Set-EntraDirectoryRoleDefintion.