Remove-AzureKeyVaultKey

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

重要

Az PowerShell モジュール で AzureRM PowerShell モジュールのすべての機能およびその他を利用できるようになったため、2024 年 2 月 29 日に AzureRM PowerShell モジュールは廃止になります。

サービスの中断を回避するために、2024 年 2 月 29 日までに、AzureRM PowerShell モジュールを使用するスクリプトを更新して、Az PowerShell モジュールを使用するようにしてください。 スクリプトを自動的に更新するには、 クイックスタート ガイドに従ってください。

構文

Remove-AzureKeyVaultKey
      [-VaultName] <String>
      [-Name] <String>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureKeyVaultKey
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-AzureKeyVaultKey コマンドレットは、キー コンテナー内のキーを削除します。 キーが誤って削除された場合、特別な "回復" アクセス許可を持つユーザーがUndo-AzureKeyVaultKeyRemovalを使用してキーを回復できます。 このコマンドレットの ConfirmImpact プロパティの値は high です。

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

PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -PassThru

Vault Name           : contoso
Name                 : key2
Id                   : https://contoso.vault.azure.net:443/keys/itsoftware/fdad15793ba0437e960497908ef9eb32
Deleted Date         : 5/24/2018 11:28:25 PM
Scheduled Purge Date : 8/22/2018 11:28:25 PM
Enabled              : False
Expires              : 10/11/2018 11:32:49 PM
Not Before           : 4/11/2018 11:22:49 PM
Created              : 4/12/2018 10:16:38 PM
Updated              : 4/12/2018 10:16:38 PM
Purge Disabled       : False
Tags                 :

このコマンドは、Contoso という名前のキー コンテナーから ITSoftware という名前のキーを削除します。

例 2: ユーザー確認なしでキーを削除する

PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Force

このコマンドは、Contoso という名前のキー コンテナーから ITSoftware という名前のキーを削除します。 このコマンドは Force パラメーターを指定するため、コマンドレットは確認を求めるメッセージを表示しません。

例 3: 削除されたキーをキー コンテナーから完全に消去する

PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -InRemovedState

このコマンドは、CONTOSO という名前のキー コンテナーから ITSoftware という名前のキーを完全に削除します。 このコマンドレットを実行するには、"消去" アクセス許可が必要です。このアクセス許可は、以前にこのキー コンテナーのユーザーに明示的に付与されている必要があります。

例 4: パイプライン演算子を使用してキーを削除する

PS C:\> Get-AzureKeyVaultKey -VaultName 'Contoso' | Where-Object {$_.Attributes.Enabled -eq $False} | Remove-AzureKeyVaultKey

このコマンドは、Contoso という名前のキー コンテナー内のすべてのキーを取得し、パイプライン演算子を使用して Where-Object コマンドレットに渡します。 このコマンドレットは、 Enabled 属性の値が $False のキーを現在のコマンドレットに渡します。 そのコマンドレットは、これらのキーを削除します。

パラメーター

-Confirm

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

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

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Force

ユーザーに確認せずに、直ちにコマンドを実行します。

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

-InputObject

KeyBundle オブジェクト

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

-InRemovedState

以前に削除したキーを完全に削除します。

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

-Name

削除するキーの名前を指定します。 このコマンドレットは、このパラメーターで指定する名前、キー コンテナーの名前、および現在の環境に基づいて、キーの完全修飾ドメイン名 (FQDN) を構築します。

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

-PassThru

このコマンドレットによって Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey オブジェクトが返されることを示します。 既定では、このコマンドレットによる出力はありません。

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

-VaultName

キーを削除するキー コンテナーの名前を指定します。 このコマンドレットは、このパラメーターが指定する名前と現在の環境に基づいて、キー コンテナーの FQDN を構築します。

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

-WhatIf

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

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

入力

PSKeyVaultKeyIdentityItem

パラメーター: InputObject (ByValue)

出力

PSDeletedKeyVaultKey