Remove-AzKeyVaultRoleDefinition
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
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
| 型: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Force
確認を求めないでください。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-HsmName
HSM の名前。
| 型: | String |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InputObject
削除するロール定義を表すオブジェクト。
| 型: | PSKeyVaultRoleDefinition |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PassThru
このコマンドレットは、既定ではオブジェクトを返しません。 このスイッチを指定すると、成功した場合は true が返されます。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-RoleName
取得するロール定義の名前。
| 型: | String |
| Aliases: | RoleDefinitionName |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Scope
ロールの割り当てまたは定義が適用されるスコープ (たとえば、'/' や '/keys' や '/keys/{keyName}' など)。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |