Set-EntraDirectoryRoleDefinition
Atualize um roleDefinition Microsoft Entra ID existente.
Sintaxe
Default (Default)
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>]
Description
Atualiza um objeto Microsoft Entra roleDefinition identificado pela ID. Você não pode atualizar funções internas. Esta funcionalidade requer uma licença P1 ou P2 Microsoft Entra ID.
Em cenários delegados, o usuário conectado deve ter uma função de Microsoft Entra com suporte ou uma função personalizada com as permissões necessárias. As funções mínimas necessárias para esta operação são:
- Administrador de Função Privilégiada
Exemplos
Exemplo 1: Atualizar um roleDefinition
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 a ID do objeto roleDefinition. -
-DisplayNameo parâmetro especifica o nome de exibição para a definição de função.
Exemplo 2: Atualizar um roleDefinition 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 a ID do objeto roleDefinition. -
-Descriptiono parâmetro especifica a descrição da definição de função.
Exemplo 3: Atualizar um roleDefinition 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 a ID do objeto roleDefinition. -
-IsEnabledo parâmetro especifica se a definição de função está habilitada.
Exemplo 4: Atualizar um roleDefinition
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 rolepermissions, TemplateId, TemplateId, ResourceScopes da definição de função especificada em Microsoft Entra ID.
-
-UnifiedRoleDefinitionIdo parâmetro especifica a ID do objeto roleDefinition. -
-RolePermissionso parâmetro especifica as permissões para a definição de função. -
-IsEnabledo parâmetro especifica se a definição de função está habilitada. -
-DisplayNameo parâmetro especifica o nome de exibição para a definição de função. -
-Descriptiono parâmetro especifica a descrição da definição de função. -
-ResourceScopeso parâmetro especifica os escopos de recurso para a definição de função. -
-TemplateIdo parâmetro especifica a ID do modelo para a definição de função. -
-Versiono parâmetro especifica a versão para a definição de função.
Parâmetros
-Description
Especifica uma descrição para a definição de função.
Propriedades do parâmetro
| Tipo: | System.String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-DisplayName
Especifica um nome a apresentar para a definição de função.
Propriedades do parâmetro
| Tipo: | System.String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-IsEnabled
Especifica se a definição de função está ativada. Sinalizador a indicar se a função está ativada para atribuição. Se for false, a função não estará disponível para atribuição. Somente leitura quando isBuiltIn for verdadeiro.
Propriedades do parâmetro
| Tipo: | System.Boolean |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ResourceScopes
Especifica os âmbitos de recursos para a definição de função.
Propriedades do parâmetro
| Tipo: | System.Collections.Generic.List`1[System.String] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-RolePermissions
Especifica permissões para a definição de função. Lista de permissões incluídas na função. Somente leitura quando isBuiltIn for true.
Propriedades do parâmetro
| Tipo: | System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RolePermission] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-TemplateId
Especifica a ID do modelo para a definição de função. Uma ID de modelo personalizada pode ser definida quando isBuiltIn for false. Essa ID normalmente é usada para manter o mesmo identificador em diretórios diferentes. É somente leitura quando isBuiltIn é true.
Propriedades do parâmetro
| Tipo: | System.String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-UnifiedRoleDefinitionId
Especifica a ID do objeto roleDefinition.
Propriedades do parâmetro
| Tipo: | System.String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | ID |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-Version
Especifica a versão para a definição de função. Indica a versão da definição de função. Somente leitura quando isBuiltIn for true.
Propriedades do parâmetro
| Tipo: | System.String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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
Observações
Set-EntraRoleDefinition é um alias para Set-EntraDirectoryRoleDefintion.