Remove-AzKeyVault
キー コンテナーを削除します。
構文
Remove-AzKeyVault
[-VaultName] <String>
[[-ResourceGroupName] <String>]
[[-Location] <String>]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Remove-AzKeyVault
[-VaultName] <String>
[-Location] <String>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Remove-AzKeyVault
[-InputObject] <PSKeyVault>
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Remove-AzKeyVault
[-InputObject] <PSKeyVault>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Remove-AzKeyVault
[-ResourceId] <String>
[[-Location] <String>]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Remove-AzKeyVault
[-ResourceId] <String>
[-Location] <String>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
説明
Remove-AzKeyVault コマンドレットは、指定されたキー コンテナーを削除します。 また、そのインスタンスに含まれるすべてのキーとシークレットも削除されます。 このコマンドレットではリソース グループの指定は省略可能ですが、パフォーマンスを向上させるには、リソース グループを指定する必要があることに注意してください。
例
例 1: キー コンテナーを削除する
Remove-AzKeyVault -VaultName "Contoso03Vault" -PassThru
True
このコマンドは、Contoso03Vault という名前のキー コンテナーを現在のサブスクリプションから削除します。
例 2: 指定したリソース グループからキー コンテナーを削除する
Remove-AzKeyVault -Name "Contoso03Vault" -ResourceGroupName "Group14" -PassThru
True
このコマンドは、Contoso03Vault という名前のキー コンテナーを名前付きリソース グループから削除します。 リソース グループ名を指定しない場合、コマンドレットは、現在のサブスクリプションで削除する名前付きキー コンテナーを検索します。
パラメーター
-AsJob
バックグラウンドでコマンドレットを実行する
型: | SwitchParameter |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
Position: | Named |
既定値: | False |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
コマンドレットが確認を求めないことを示します。 既定では、このコマンドレットは、キー コンテナーを削除することを確認するメッセージを表示します。
型: | SwitchParameter |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
削除する Key Vault オブジェクト。
型: | PSKeyVault |
Position: | 0 |
既定値: | None |
必須: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InRemovedState
以前に削除したコンテナーを完全に削除します。
型: | SwitchParameter |
Position: | Named |
既定値: | None |
必須: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Location
削除されたコンテナーの場所。
型: | String |
Position: | 2 |
既定値: | None |
必須: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
このコマンドレットは、既定ではオブジェクトを返しません。 このスイッチを指定すると、成功した場合は true が返されます。
型: | SwitchParameter |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
リソース グループの名前を指定します。
型: | String |
Position: | 1 |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceId
KeyVault リソース ID。
型: | String |
Position: | 0 |
既定値: | None |
必須: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionId
サブスクリプションの ID です。 既定では、コマンドレットは現在のコンテキストで設定されているサブスクリプションで実行されます。 ユーザーが別のサブスクリプションを指定した場合、現在のコマンドレットはユーザーが指定したサブスクリプションで実行されます。 サブスクリプションのオーバーライドは、現在のコマンドレットのライフサイクル中にのみ有効になります。 コンテキスト内のサブスクリプションは変更されず、後続のコマンドレットには影響しません。
型: | String |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VaultName
削除するキー コンテナーの名前を指定します。
型: | String |
Aliases: | Name |
Position: | 0 |
既定値: | None |
必須: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 コマンドレットは実行されません。コマンドレットを実行した場合の動作を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
Position: | Named |
既定値: | False |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
出力
関連リンク
Azure PowerShell
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示