Remove-AzureKeyVaultKey

참조

모듈:: AzureRM.KeyVault

키 자격 증명 모음에서 키를 삭제합니다.

Warning

AzureRM PowerShell 모듈은 2024년 2월 29일부터 공식적으로 사용되지 않습니다. 사용자는 지속적인 지원 및 업데이트를 보장하기 위해 AzureRM에서 Az PowerShell 모듈로 마이그레이션하는 것이 좋습니다.

AzureRM 모듈은 여전히 작동할 수 있지만 더 이상 기본 또는 지원되지 않으므로 사용자의 재량에 따라 계속 사용할 수 있습니다. Az 모듈로 전환하는 방법에 대한 지침은 마이그레이션 리소스를 참조하세요.

Syntax

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>]

Description

Remove-AzureKeyVaultKey cmdlet은 키 자격 증명 모음에서 키를 삭제합니다. 키가 실수로 삭제된 경우 특별한 '복구' 권한이 있는 사용자가 Undo-AzureKeyVaultKeyRemoval을 사용하여 키를 복구할 수 있습니다. 이 cmdlet의 값은 ConfirmImpact 속성에 대해 높음입니다.

예제

예제 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 매개 변수를 지정하므로 cmdlet은 확인 메시지를 표시하지 않습니다.

예제 3: 키 자격 증명 모음에서 삭제된 키를 영구적으로 제거

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

이 명령은 Contoso라는 키 자격 증명 모음에서 ITSoftware라는 키를 영구적으로 제거합니다. 이 cmdlet을 실행하려면 이전에 이 키 자격 증명 모음에 대해 사용자에게 명시적으로 부여해야 하는 '제거' 권한이 필요합니다.

예제 4: 파이프라인 연산자를 사용하여 키 제거

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

이 명령은 Contoso라는 키 자격 증명 모음의 모든 키를 가져오고 파이프라인 연산자를 사용하여 Where-Object cmdlet에 전달합니다. 해당 cmdlet은 Enabled 특성에 대한 $False 값이 있는 키를 현재 cmdlet에 전달합니다. 이 cmdlet은 해당 키를 제거합니다.

매개 변수

-Confirm

cmdlet을 실행하기 전에 확인 메시지가 표시됩니다.

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

KeyBundle 개체

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

-InRemovedState

이전에 삭제한 키를 영구적으로 제거합니다.

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

-Name

제거할 키의 이름을 지정합니다. 이 cmdlet은 이 매개 변수가 지정하는 이름, 키 자격 증명 모음의 이름 및 현재 환경에 따라 키의 FQDN(정규화된 do기본 이름)을 생성합니다.

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

-PassThru

이 cmdlet은 Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey 개체를 반환합니다. 기본적으로 이 cmdlet은 출력을 생성하지 않습니다.

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

-VaultName

키를 제거할 키 자격 증명 모음의 이름을 지정합니다. 이 cmdlet은 이 매개 변수가 지정하는 이름과 현재 환경에 따라 키 자격 증명 모음의 FQDN을 생성합니다.

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

-WhatIf

cmdlet이 실행될 경우 결과 동작을 표시합니다. cmdlet이 실행되지 않습니다. cmdlet이 실행되면 어떻게 되는지 보여 주세요. cmdlet이 실행되지 않습니다.

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

입력

PSKeyVaultKeyIdentityItem

매개 변수: InputObject(ByValue)

출력

PSDeletedKeyVaultKey