Set-EntraDirectoryRoleDefinition
Atualize um papel existente do Microsoft Entra IDDefinição.
Sintaxe
Default (Predefinição)
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>]
Descrição
Atualiza um objeto Microsoft Entra roleDefinition identificado por ID. Não podes atualizar os papéis integrados. Esta funcionalidade requer uma licença Microsoft Entra ID P1 ou P2.
Em cenários delegados, o utilizador iniciado deve ter um papel Microsoft Entra suportado ou um papel personalizado com as permissões necessárias. Os papéis mínimos exigidos para esta operação são:
- Administrador de Função Privilegiada
Exemplos
Exemplo 1: Atualizar uma função Definição
Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$roleDefinition = Get-EntraDirectoryRoleDefinition -Filter "DisplayName eq '<Role-Definition-Name>'"
Set-EntraDirectoryRoleDefinition -UnifiedRoleDefinitionId $roleDefinition.Id -DisplayName 'UpdatedDisplayName'
Este exemplo atualiza a definição de função especificada no Microsoft Entra ID.
-
-UnifiedRoleDefinitionIdo parâmetro especifica o ID do objeto roleDefinition. -
-DisplayNameO parâmetro especifica o nome de exibição para a definição do papel.
Exemplo 2: Atualizar uma Definição de Função com Descrição
Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$roleDefinition = Get-EntraDirectoryRoleDefinition -Filter "DisplayName eq '<Role-Definition-Name>'"
Set-EntraDirectoryRoleDefinition -UnifiedRoleDefinitionId $roleDefinition.Id -Description 'MYROLEUPDATE1S'
Este exemplo atualiza a Descrição da definição de função especificada no Microsoft Entra ID.
-
-UnifiedRoleDefinitionIdo parâmetro especifica o ID do objeto roleDefinition. -
-DescriptionO parâmetro especifica a descrição para a definição do papel.
Exemplo 3: Atualize uma Definição de Papel com IsEnabled
Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$roleDefinition = Get-EntraDirectoryRoleDefinition -Filter "DisplayName eq '<Role-Definition-Name>'"
Set-EntraDirectoryRoleDefinition -UnifiedRoleDefinitionId $roleDefinition.Id -IsEnabled $true
Este exemplo atualiza o IsEnabled da definição de função especificada no Microsoft Entra ID.
-
-UnifiedRoleDefinitionIdo parâmetro especifica o ID do objeto roleDefinition. -
-IsEnabledO parâmetro especifica se a definição do papel está ativada.
Exemplo 4: Atualizar uma função Definição
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
Este exemplo atualiza os RolePermissions, TemplateId, TemplateId, ResourceScopes da definição de função especificada no Microsoft Entra ID.
-
-UnifiedRoleDefinitionIdo parâmetro especifica o ID do objeto roleDefinition. -
-RolePermissionsparâmetro especifica as permissões para a definição do papel. -
-IsEnabledO parâmetro especifica se a definição do papel está ativada. -
-DisplayNameO parâmetro especifica o nome de exibição para a definição do papel. -
-DescriptionO parâmetro especifica a descrição para a definição do papel. -
-ResourceScopesO parâmetro especifica os escopos de recursos para a definição do papel. -
-TemplateIdo parâmetro especifica o ID do modelo para a definição do papel. -
-VersionO parâmetro especifica a versão para a definição do papel.
Parâmetros
-Description
Especifica uma descrição para a definição do papel.
Propriedades dos parâmetros
| Tipo: | System.String |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-DisplayName
Especifica um nome de exibição para a definição do papel.
Propriedades dos parâmetros
| Tipo: | System.String |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-IsEnabled
Especifica se a definição de função está ativada. Flag a indicar se a função está ativada para atribuição. Se for falso, a função não está disponível para atribuição. Só leitura quando isBuiltIn é verdade.
Propriedades dos parâmetros
| Tipo: | System.Boolean |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-ResourceScopes
Especifica os escopos de recursos para a definição do papel.
Propriedades dos parâmetros
| Tipo: | System.Collections.Generic.List`1[System.String] |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-RolePermissions
Especifica permissões para a definição do papel. Lista de permissões incluídas no cargo. Só leitura quando isBuiltIn é true.
Propriedades dos parâmetros
| Tipo: | System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RolePermission] |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-TemplateId
Especifica o ID do modelo para a definição do papel. Um ID de template personalizado pode ser definido quando isBuiltIn é false. Este ID é normalmente usado para manter o mesmo identificador em diferentes diretórios. É apenas de leitura quando isBuiltIn é true.
Propriedades dos parâmetros
| Tipo: | System.String |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-UnifiedRoleDefinitionId
Especifica o ID do objeto roleDefinition.
Propriedades dos parâmetros
| Tipo: | System.String |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Id |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
-Version
Especifica a versão para a definição do papel. Indica a versão da definição do papel. Só leitura quando isBuiltIn é true.
Propriedades dos parâmetros
| Tipo: | System.String |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
System.String
Saídas
System.Object
Notas
Set-EntraRoleDefinition é um alias para Set-EntraDirectoryRoleDefintion.