Get-AzKeyVaultRoleAssignment

モジュール:

Az.KeyVault

マネージド HSM のロールの割り当てを取得または一覧表示します。 それぞれのパラメーターを使用して、特定のユーザーまたはロール定義への割り当てを一覧表示します。

構文

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>]

説明

Get-AzKeyVaultRoleAssignment コマンドを使用して、スコープで有効なすべてのロールの割り当てを一覧表示します。 パラメーターを指定しない場合、このコマンドはマネージド HSM で行われたすべてのロールの割り当てを返します。 この一覧は、プリンシパル、ロール、スコープのフィルター 処理パラメーターを使用してフィルター処理できます。 割り当ての件名を指定する必要があります。 ユーザーを指定するには、SignInName パラメーターまたは Microsoft Entra ObjectId パラメーターを使用します。 セキュリティ グループを指定するには、Microsoft Entra ObjectId パラメーターを使用します。 また、Microsoft Entra アプリケーションを指定するには、ApplicationId または ObjectId パラメーターを使用します。 割り当てられているロールは、RoleDefinitionName パラメーターまたは RoleDefinitionId パラメーターを使用して指定する必要があります。 アクセスを許可するスコープを指定できます。 既定値は "/" です。

このコマンドレットは、入力パラメーターに従って、以下の 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。

型:	String
Aliases:	SPN, ServicePrincipalName
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-HsmName

HSM の名前。

型:	String
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ObjectId

ユーザーまたはグループ オブジェクト ID。

型:	String
Aliases:	Id, PrincipalId
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RoleAssignmentName

ロールの割り当ての名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RoleDefinitionId

プリンシパルが割り当てられているロール ID。

型:	String
Aliases:	RoleId
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RoleDefinitionName

プリンシパルを割り当てる RBAC ロールの名前。

型:	String
Aliases:	RoleName
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Scope

ロールの割り当てまたは定義が適用されるスコープ (たとえば、'/' や '/keys' や '/keys/{keyName}' など)。 '/' は省略時に使用されます。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SignInName

ユーザーの SignInName。

型:	String
Aliases:	Email, UserPrincipalName
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

None

出力

PSKeyVaultRoleAssignment