Partager via


Get-AzKeyVaultRoleAssignment

Obtenir ou répertorier les attributions de rôles d’un HSM managé. Utilisez les paramètres respectifs pour répertorier les attributions à un utilisateur spécifique ou une définition de rôle.

Syntaxe

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

Utilisez la commande Get-AzKeyVaultRoleAssignment pour répertorier toutes les attributions de rôles effectives sur une étendue. Sans aucun paramètre, cette commande retourne toutes les attributions de rôle effectuées sous le HSM managé. Cette liste peut être filtrée à l’aide de paramètres de filtrage pour le principal, le rôle et l’étendue. L’objet de l’affectation doit être spécifié. Pour spécifier un utilisateur, utilisez les paramètres SignInName ou Microsoft Entra ObjectId. Pour spécifier un groupe de sécurité, utilisez le paramètre Microsoft Entra ObjectId. Pour spécifier une application Microsoft Entra, utilisez les paramètres ApplicationId ou ObjectId. Le rôle affecté doit être spécifié à l’aide du paramètre RoleDefinitionName ou RoleDefinitionId. L’étendue à laquelle l’accès est accordé peut être spécifié. La valeur par défaut est « / ».

L’applet de commande peut appeler sous l’API Microsoft Graph en fonction des paramètres d’entrée :

  • GET /directoryObjects/{id}
  • GET /users/{id}
  • GET /servicePrincipals/{id}
  • GET /groups/{id}

Exemples

Exemple 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       /

Cet exemple répertorie toutes les attributions de rôles de « myHsm » sur toute l’étendue.

Exemple 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

Cet exemple répertorie toutes les attributions de rôles de « myHsm » dans l’étendue « /keys » et filtre le résultat par nom de connexion utilisateur.

Paramètres

-ApplicationId

SPN d’application.

Type:String
Alias:SPN, ServicePrincipalName
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-HsmName

Nom du HSM.

Type:String
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ObjectId

ID d’objet utilisateur ou groupe.

Type:String
Alias:Id, PrincipalId
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RoleAssignmentName

Nom de l’attribution de rôle.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RoleDefinitionId

ID de rôle auquel le principal est affecté.

Type:String
Alias:RoleId
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RoleDefinitionName

Nom du rôle RBAC auquel attribuer le principal.

Type:String
Alias:RoleName
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Scope

Étendue à laquelle l’attribution ou la définition de rôle s’applique, par exemple, « / » ou « /keys » ou « /keys/{keyName} ». '/' est utilisé lorsqu’il est omis.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-SignInName

Utilisateur SignInName.

Type:String
Alias:Email, UserPrincipalName
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

None

Sorties

PSKeyVaultRoleAssignment