Remove-AzKeyVaultRoleDefinition

リファレンス

モジュール:: Az.KeyVault

HSM からカスタムロール定義を削除します。

構文

Remove-AzKeyVaultRoleDefinition
      [-HsmName] <String>
      [-Scope <String>]
      -RoleName <String>
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzKeyVaultRoleDefinition
      [-HsmName] <String>
      [-Scope <String>]
      -InputObject <PSKeyVaultRoleDefinition>
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

このコマンドレットは Remove-AzKeyVaultRoleDefinition 、Azure KeyVault マネージド HSM の Azure ロールベースのアクセス制御でカスタムロールを削除します。既存の -RoleName カスタムロールまたはロールオブジェクトのパラメーターを指定して、そのカスタムロールを削除します。既定では、 Remove-AzKeyVaultRoleDefinition 確認を求められます。プロンプトを表示しない場合は、パラメーターを -Force 使用します。

例

例 1

Remove-AzKeyVaultRoleDefinition -HsmName myHsm -RoleName "my role"

この例では、"my role" という名前のカスタムロールを削除します。

例 2

$role = Get-AzKeyVaultRoleDefinition -HsmName myHsm -RoleName "my role"
$role | Remove-AzKeyVaultRoleDefinition -HsmName myHsm -Force

次の使用例は、ロールオブジェクトをパイプ処理して、"my role" という名前のカスタムロールを削除します。また、プロンプトが表示されないようにします -Force。

パラメーター

-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

-Force

確認を求めないでください。

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

-PassThru

このコマンドレットは、既定ではオブジェクトを返しません。このスイッチを指定すると、成功した場合は true が返されます。

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

-RoleName

取得するロール定義の名前。

Type:	String
Aliases:	RoleDefinitionName
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

-WhatIf

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

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

入力

PSKeyVaultRoleDefinition

出力

Boolean