Remove-AzKeyVaultRoleAssignment

リファレンス

モジュール:: Az.KeyVault

特定のスコープで特定のロールに割り当てられている、指定したプリンシパルへのロールの割り当てを削除します。

構文

Remove-AzKeyVaultRoleAssignment
      [-HsmName] <String>
      [-Scope <String>]
      -RoleDefinitionName <String>
      -SignInName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzKeyVaultRoleAssignment
      [-HsmName] <String>
      [-Scope <String>]
      -RoleDefinitionName <String>
      -ApplicationId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzKeyVaultRoleAssignment
      [-HsmName] <String>
      [-Scope <String>]
      -RoleDefinitionName <String>
      -ObjectId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzKeyVaultRoleAssignment
      [-HsmName] <String>
      [-Scope <String>]
      -RoleDefinitionId <String>
      -ApplicationId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzKeyVaultRoleAssignment
      [-HsmName] <String>
      [-Scope <String>]
      -RoleDefinitionId <String>
      -ObjectId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzKeyVaultRoleAssignment
      [-HsmName] <String>
      [-Scope <String>]
      -RoleDefinitionId <String>
      -SignInName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzKeyVaultRoleAssignment
      [-HsmName] <String>
      [-Scope <String>]
      [-PassThru]
      -RoleAssignmentName <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzKeyVaultRoleAssignment
      [-Scope <String>]
      [-PassThru]
      -InputObject <PSKeyVaultRoleAssignment>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

コマンドレットを使用して、特定の Remove-AzKeyVaultRoleAssignment スコープと特定のロールで任意のプリンシパルへのアクセスを取り消します。割り当てのオブジェクト、つまりプリンシパルを指定する必要があります。プリンシパルには、ユーザー (SignInName パラメーターまたは ObjectId パラメーターを使用してユーザーを識別する)、セキュリティグループ (ObjectId パラメーターを使用してグループを識別する) またはサービスプリンシパル (ApplicationId パラメーターまたは ObjectId パラメーターを使用して ServicePrincipal を識別する) を指定できます。プリンシパルが割り当てられているロールは、RoleDefinitionName パラメーターまたは RoleDefinitionId パラメーターを使用して指定する必要があります。

このコマンドレットは、入力パラメーターに従って、以下の Microsoft Graph API を呼び出す場合があります。

GET /users/{id}
GET /servicePrincipals

例

例 1

Remove-AzKeyVaultRoleAssignment -HsmName myHsm -RoleDefinitionName "Managed HSM Policy Administrator" -SignInName user1@microsoft.com -Scope "/keys"

この例では、"/keys" スコープで "Managed HSM Policy 管理istrator" ロールをuser1@microsoft.com取り消します。

例 2

Get-AzKeyVaultRoleAssignment -HsmName myHsm -SignInName user1@microsoft.com | Remove-AzKeyVaultRoleAssignment

この例では、すべてのスコープで "user1@microsoft.com" のすべてのロールを取り消します。

パラメーター

-ApplicationId

アプリ SPN。

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:	SwitchParameter
Aliases:	cf
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

-InputObject

ロールの割り当てオブジェクト。

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

-ObjectId

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

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

-PassThru

HSM が復元されたときに true を返します。

Type:	SwitchParameter
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

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

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

-RoleDefinitionName

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

Type:	String
Aliases:	RoleName
Position:	Named
Default value:	None
Required:	True
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:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

PSKeyVaultRoleAssignment

出力