Share via


Get-AzKeyVaultRoleAssignment

取得或列出受控 HSM 的角色指派。 使用個別參數來列出特定使用者或角色定義的指派。

Syntax

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

Get-AzKeyVaultRoleAssignment使用 命令來列出在範圍上生效的所有角色指派。 如果沒有任何參數,此命令會傳回在Managed HSM下所做的所有角色指派。 您可以使用主體、角色和範圍的篩選參數來篩選此清單。 必須指定指派的主旨。 若要指定使用者,請使用 SignInName 或 Microsoft Entra ObjectId 參數。 若要指定安全組,請使用 Microsoft Entra ObjectId 參數。 若要指定 Microsoft Entra 應用程式,請使用 ApplicationId 或 ObjectId 參數。 指派的角色必須使用 RoleDefinitionName 或 RoleDefinitionId 參數來指定。 可以指定授與存取權的範圍。 預設為 “/”。

Cmdlet 可能會根據輸入參數呼叫下列 Microsoft Graph API:

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

範例

範例 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       /

此範例會列出所有範圍上 「myHsm」 的所有角色指派。

範例 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

此範例會列出 「/keys」 範圍上 「myHsm」 的所有角色指派,並依使用者登入名稱篩選結果。

參數

-ApplicationId

應用程式SPN。

Type:String
Aliases:SPN, ServicePrincipalName
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HsmName

HSM 的名稱。

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ObjectId

使用者或群組物件標識碼。

Type:String
Aliases:Id, PrincipalId
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RoleAssignmentName

角色指派的名稱。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RoleDefinitionId

指派主體的角色標識碼。

Type:String
Aliases:RoleId
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RoleDefinitionName

要為其指派主體的 RBAC 角色名稱。

Type:String
Aliases:RoleName
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

角色指派或定義套用至的範圍,例如 '/' 或 '/keys' 或 '/keys/{keyName}'。 省略時會使用 『/』。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SignInName

使用者 SignInName。

Type:String
Aliases:Email, UserPrincipalName
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

輸入

None

輸出

PSKeyVaultRoleAssignment