Get-AzKeyVaultRoleAssignment
Obtenha ou liste atribuições de função de um HSM gerenciado. Use os respetivos parâmetros para listar atribuições para um usuário específico ou uma definição de função.
Sintaxe
Get-AzKeyVaultRoleAssignment
[-HsmName] <String>
[-Scope <String>]
[-RoleDefinitionName <String>]
[-RoleDefinitionId <String>]
[-ObjectId <String>]
[-SignInName <String>]
[-ApplicationId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzKeyVaultRoleAssignment
[-HsmName] <String>
[-Scope <String>]
-RoleAssignmentName <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Use o Get-AzKeyVaultRoleAssignment
comando para listar todas as atribuições de função que são efetivas em um escopo.
Sem parâmetros, esse comando retorna todas as atribuições de função feitas no HSM gerenciado.
Essa lista pode ser filtrada usando parâmetros de filtragem para principal, função e escopo.
O assunto da atribuição deve ser especificado.
Para especificar um usuário, use os parâmetros SignInName ou Microsoft Entra ObjectId.
Para especificar um grupo de segurança, use o parâmetro Microsoft Entra ObjectId.
E para especificar um aplicativo Microsoft Entra, use parâmetros ApplicationId ou ObjectId.
A função que está sendo atribuída deve ser especificada usando o parâmetro RoleDefinitionName ou RoleDefinitionId.
O âmbito em que o acesso está a ser concedido pode ser especificado. O padrão é "/".
O cmdlet pode chamar abaixo a API do Microsoft Graph de acordo com os parâmetros de entrada:
- GET /directoryObjects/{id}
- GET /users/{id}
- GET /servicePrincipals/{id}
- GET /groups/{id}
Exemplos
Exemplo 1
Get-AzKeyVaultRoleAssignment -HsmName myHsm
RoleDefinitionName DisplayName ObjectType Scope
------------------ ----------- ---------- -----
Managed HSM Administrator User 1 (user1@microsoft.com) User /
Managed HSM Crypto Auditor User 2 (user2@microsoft.com) User /keys
Managed HSM Backup User 2 (user2@microsoft.com) User /
Managed HSM Administrator User 2 (user2@microsoft.com) User /
Este exemplo lista todas as atribuições de função de "myHsm" em todo o escopo.
Exemplo 2
Get-AzKeyVaultRoleAssignment -HsmName myHsm -SignInName user1@microsoft.com -Scope "/keys"
RoleDefinitionName DisplayName ObjectType Scope
------------------ ----------- ---------- -----
Managed HSM Crypto Auditor User 1 (user1@microsoft.com) User /keys
Managed HSM Backup User 1 (user1@microsoft.com) User /keys
Este exemplo lista todas as atribuições de função de "myHsm" no escopo "/keys" e filtra o resultado pelo nome de entrada do usuário.
Parâmetros
-ApplicationId
O aplicativo SPN.
Tipo: | String |
Aliases: | SPN, ServicePrincipalName |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.
Tipo: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-HsmName
Nome do HSM.
Tipo: | String |
Position: | 1 |
Default value: | None |
Necessário: | True |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-ObjectId
A ID do objeto do usuário ou grupo.
Tipo: | String |
Aliases: | Id, PrincipalId |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-RoleAssignmentName
Nome da atribuição de função.
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | True |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-RoleDefinitionId
ID da função à qual a entidade de segurança está atribuída.
Tipo: | String |
Aliases: | RoleId |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-RoleDefinitionName
Nome da função RBAC à qual atribuir o principal.
Tipo: | String |
Aliases: | RoleName |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-Scope
Âmbito ao qual a atribuição ou definição de função se aplica, por exemplo, '/' ou '/keys' ou '/keys/{keyName}'. '/' é utilizado quando omitido.
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-SignInName
O usuário SignInName.
Tipo: | String |
Aliases: | Email, UserPrincipalName |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
Entradas
None
Saídas
Azure PowerShell