Remove-AzKeyVaultKey

Modul:
Az.KeyVault Module

Menghapus kunci dalam brankas kunci.

Sintaks

ByVaultName (Default) 

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

HsmByVaultName 

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

ByInputObject 

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 konfirmasi sebelum menjalankan cmdlet.

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False
Alias:Cf

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-DefaultProfile

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

Properti parameter

Jenis:IAzureContextContainer
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Force

Memaksa perintah untuk dijalankan tanpa meminta konfirmasi pengguna.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-HsmName

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

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

HsmByVaultName
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-InputObject

Objek KeyBundle

Properti parameter

Jenis:PSKeyVaultKeyIdentityItem
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

ByInputObject
Position:0
Wajib:True
Nilai dari alur:True
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-InRemovedState

Hapus kunci yang dihapus sebelumnya secara permanen.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa: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.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:Nama Kunci

Kumpulan parameter

ByVaultName
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
HsmByVaultName
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-PassThru

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

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa: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.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

ByVaultName
Position:0
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-WhatIf

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

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False
Alias:wi

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

PSKeyVaultKeyIdentityItem

Output

PSDeletedKeyVaultKey