Remove-AzKeyVaultManagedHsm
マネージド HSM を削除/消去します。
構文
Remove-AzKeyVaultManagedHsm
[-Name] <String>
[[-ResourceGroupName] <String>]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>] Remove-AzKeyVaultManagedHsm
[-Name] <String>
[-Location] <String>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>] Remove-AzKeyVaultManagedHsm
[-InputObject] <PSManagedHsm>
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>] Remove-AzKeyVaultManagedHsm
[-InputObject] <PSManagedHsm>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>] Remove-AzKeyVaultManagedHsm
[-ResourceId] <String>
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>] Remove-AzKeyVaultManagedHsm
[-ResourceId] <String>
[-Location] <String>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>] 説明
Remove-AzKeyVaultManagedHsm コマンドレットは、指定されたマネージド HSM を削除します。 また、そのインスタンスに含まれるすべてのキーも削除されます。 このコマンドレットではリソース グループの指定は省略可能ですが、パフォーマンスを向上させるには、リソース グループを指定する必要があることに注意してください。
例
例 1: マネージド HSM を削除する
Remove-AzKeyVaultManagedHsm -HsmName 'myhsm' -Force
Trueこのコマンドは、myhsm という名前のマネージド HSM を現在のサブスクリプションから削除します。
例 2: 指定したリソース グループからマネージド HSM を削除する
Remove-AzKeyVaultManagedHsm -HsmName 'myhsm' -ResourceGroupName "myrg1" -PassThru
Trueこのコマンドは、myrg1 という名前のリソース グループから myhsm という名前のマネージド HSM を削除します。 リソース グループ名を指定しない場合、コマンドレットは、現在のサブスクリプションで削除する名前付きマネージド HSM を検索します。
例 3: 削除されたマネージド HSM を消去する
Remove-AzKeyVaultManagedHsm -Name 'myhsm' -Location "eastus" -Force -PassThru
Trueこのコマンドは、eastus にある myhsm という名前のマネージド HSM を消去します。
パラメーター
-AsJob
バックグラウンドでコマンドレットを実行する
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
| 型: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Force
コマンドレットが確認を求めないことを示します。 既定では、このコマンドレットは、マネージド HSM を削除することを確認するメッセージを表示します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InputObject
削除するマネージド HSM オブジェクト。
| 型: | PSManagedHsm |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-InRemovedState
以前に削除したマネージド HSM プールを完全に削除します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Location
削除されたマネージド HSM プールの場所。
| 型: | String |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Name
削除するマネージド HSM の名前を指定します。
| 型: | String |
| Aliases: | HsmName |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-PassThru
このコマンドレットは、既定ではオブジェクトを返しません。 このスイッチを指定すると、成功した場合は true が返されます。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ResourceGroupName
削除する Azure Managed HSM のリソース グループの名前を指定します。
| 型: | String |
| 配置: | 1 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ResourceId
ManagedHsm リソース ID。
| 型: | String |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-SubscriptionId
サブスクリプションの ID です。 既定では、コマンドレットは現在のコンテキストで設定されているサブスクリプションで実行されます。 ユーザーが別のサブスクリプションを指定した場合、現在のコマンドレットはユーザーが指定したサブスクリプションで実行されます。 サブスクリプションのオーバーライドは、現在のコマンドレットのライフサイクル中にのみ有効になります。 コンテキスト内のサブスクリプションは変更されず、後続のコマンドレットには影響しません。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |