Remove-AzureRmKeyVault

リファレンス

モジュール:: AzureRM.KeyVault

キーコンテナーを削除します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Remove-AzureRmKeyVault
      [-VaultName] <String>
      [[-ResourceGroupName] <String>]
      [[-Location] <String>]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmKeyVault
      [-VaultName] <String>
      [-Location] <String>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmKeyVault
      [-InputObject] <PSKeyVault>
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmKeyVault
      [-InputObject] <PSKeyVault>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmKeyVault
      [-ResourceId] <String>
      [[-Location] <String>]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmKeyVault
      [-ResourceId] <String>
      [-Location] <String>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-AzureRmKeyVault コマンドレットは、指定されたキーコンテナーを削除します。また、そのインスタンスに含まれるすべてのキーとシークレットも削除されます。このコマンドレットではリソースグループの指定は省略可能ですが、パフォーマンスを向上させるには、リソースグループを指定する必要があることに注意してください。

例

例 1: キーコンテナーを削除する

PS C:\> Remove-AzureRmKeyVault -VaultName "Contoso03Vault" -PassThru

True

このコマンドは、Contoso03Vault という名前のキーコンテナーを現在のサブスクリプションから削除します。

例 2: 指定したリソースグループからキーコンテナーを削除する

PS C:\> Remove-AzureRmKeyVault -VaultName "Contoso03Vault" -ResourceGroupName "Group14" -PassThru

True

このコマンドは、Contoso03Vault という名前のキーコンテナーを名前付きリソースグループから削除します。リソースグループ名を指定しない場合、コマンドレットは、現在のサブスクリプションで削除する名前付きキーコンテナーを検索します。

パラメーター

-AsJob

バックグラウンドでコマンドレットを実行する

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

-Confirm

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

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

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

Type:	IAzureContextContainer
Aliases:	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

-InputObject

削除する Key Vault オブジェクト。

Type:	PSKeyVault
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InRemovedState

以前に削除したコンテナーを完全に削除します。

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

-Location

削除されたコンテナーの場所。

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

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

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

-ResourceGroupName

リソースグループの名前を指定します。

Type:	String
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

KeyVault リソース ID。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VaultName

削除するキーコンテナーの名前を指定します。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

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

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

入力

PSKeyVault

Parameters: InputObject (ByValue)

String

出力

Boolean