Remove-AzKeyVaultKey

Referensi

Modul:: Az.KeyVault

Menghapus kunci dalam brankas kunci.

Sintaks

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

Remove-AzKeyVaultKey
      -HsmName <String>
      [-Name] <String>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzKeyVaultKey
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Deskripsi

Cmdlet Remove-AzKeyVaultKey menghapus kunci dalam brankas kunci. Jika kunci dihapus secara tidak sengaja, kunci dapat dipulihkan menggunakan Undo-AzKeyVaultKeyRemoval oleh pengguna dengan izin 'pulihkan' khusus. Cmdlet ini memiliki nilai tinggi untuk properti ConfirmImpact .

Contoh

Contoh 1: Menghapus kunci dari brankas kunci

Remove-AzKeyVaultKey -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                 :

Perintah ini menghapus kunci bernama ITSoftware dari brankas kunci bernama Contoso.

Contoh 2: Menghapus kunci tanpa konfirmasi pengguna

Remove-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Force

Perintah ini menghapus kunci bernama ITSoftware dari brankas kunci bernama Contoso. Perintah menentukan parameter Force , dan, oleh karena itu, cmdlet tidak meminta Anda untuk konfirmasi.

Contoh 3: Hapus menyeluruh kunci yang dihapus dari brankas kunci secara permanen

Remove-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -InRemovedState

Perintah ini menghapus kunci bernama ITSoftware dari brankas kunci bernama Contoso secara permanen. Menjalankan cmdlet ini memerlukan izin 'hapus menyeluruh', yang harus diberikan sebelumnya dan secara eksplisit kepada pengguna untuk brankas kunci ini.

Contoh 4: Menghapus kunci dengan menggunakan operator alur

Get-AzKeyVaultKey -VaultName 'Contoso' | Where-Object {$_.Attributes.Enabled -eq $False} | Remove-AzKeyVaultKey

Perintah ini mendapatkan semua kunci di brankas kunci bernama Contoso, dan meneruskannya ke cmdlet Where-Object dengan menggunakan operator alur. Cmdlet tersebut meneruskan kunci yang memiliki nilai $False untuk atribut Diaktifkan ke cmdlet saat ini. Cmdlet itu menghapus kunci tersebut.

Parameter

-Confirm

Meminta Anda mengonfirmasi sebelum menjalankan cmdlet.

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

-DefaultProfile

Kredensial, akun, penyewa, dan langganan yang digunakan untuk komunikasi dengan azure

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

-Force

Memaksa perintah untuk dijalankan tanpa meminta konfirmasi pengguna.

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

-HsmName

Nama HSM. Cmdlet membangun FQDN dari HSM terkelola berdasarkan nama dan lingkungan yang saat ini dipilih.

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

-InputObject

Objek KeyBundle

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

-InRemovedState

Hapus kunci yang dihapus sebelumnya secara permanen.

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

-Name

Menentukan nama kunci yang akan dihapus. Cmdlet ini membangun nama domain yang sepenuhnya memenuhi syarat (FQDN) dari kunci berdasarkan nama yang ditentukan parameter ini, nama brankas kunci, dan lingkungan Anda saat ini.

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

-PassThru

Menunjukkan bahwa cmdlet ini mengembalikan objek Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey . Secara default, cmdlet ini tidak menghasilkan output apa pun.

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

-VaultName

Menentukan nama brankas kunci untuk menghapus kunci. Cmdlet ini membangun FQDN dari brankas kunci berdasarkan nama yang ditentukan parameter ini dan lingkungan Anda saat ini.

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

-WhatIf

Menunjukkan apa yang akan terjadi jika cmdlet berjalan. Cmdlet tidak dijalankan. Menunjukkan apa yang akan terjadi jika cmdlet berjalan. Cmdlet tidak dijalankan.

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

Input

PSKeyVaultKeyIdentityItem

Output

PSDeletedKeyVaultKey