Aracılığıyla paylaş

Remove-AzKeyVaultKey

  • Başvuru
Modül:
Az.KeyVault

Anahtar kasasındaki bir anahtarı siler.

Sözdizimi

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

Description

Remove-AzKeyVaultKey cmdlet'i bir anahtar kasasındaki bir anahtarı siler. Anahtar yanlışlıkla silindiyse anahtar, özel 'kurtarma' izinlerine sahip bir kullanıcı tarafından Undo-AzKeyVaultKeyRemoval kullanılarak kurtarılabilir. Bu cmdlet ConfirmImpact özelliği için yüksek bir değere sahiptir.

Örnekler

Örnek 1: Anahtar kasasından anahtar kaldırma

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                 :

Bu komut, ITSoftware adlı anahtarı Contoso adlı anahtar kasasından kaldırır.

Örnek 2: Kullanıcı onayı olmadan anahtarı kaldırma

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

Bu komut, ITSoftware adlı anahtarı Contoso adlı anahtar kasasından kaldırır. komutu Force parametresini belirtir ve bu nedenle cmdlet sizden onay istemez.

Örnek 3: Silinen bir anahtarı anahtar kasasından kalıcı olarak temizleme

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

Bu komut, ITSoftware adlı anahtarı Contoso adlı anahtar kasasından kalıcı olarak kaldırır. Bu cmdlet'in yürütülmesi için daha önce ve bu anahtar kasası için kullanıcıya açıkça verilmiş olması gereken 'temizleme' izni gerekir.

Örnek 4: İşlem hattı işlecini kullanarak anahtarları kaldırma

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

Bu komut Contoso adlı anahtar kasasındaki tüm anahtarları alır ve işlem hattı işlecini kullanarak Where-Object cmdlet'ine geçirir. Bu cmdlet, Enabled özniteliği için $False değerine sahip anahtarları geçerli cmdlet'e geçirir. Bu cmdlet bu anahtarları kaldırır.

Parametreler

-Confirm

Cmdlet'i çalıştırmadan önce sizden onay ister.

Tür:SwitchParameter
Diğer adlar:cf
Position:Named
Default value:False
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-DefaultProfile

Azure ile iletişim için kullanılan kimlik bilgileri, hesap, kiracı ve abonelik

Tür:IAzureContextContainer
Diğer adlar:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Force

Komutu, kullanıcı onayı istemeden çalışmaya zorlar.

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-HsmName

HSM adı. Cmdlet, yönetilen bir HSM'nin FQDN'sini ada ve şu anda seçili ortama göre oluşturur.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-InputObject

KeyBundle Nesnesi

Tür:PSKeyVaultKeyIdentityItem
Position:0
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-InRemovedState

Daha önce silinen anahtarı kalıcı olarak kaldırın.

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Name

Kaldırılacak anahtarın adını belirtir. Bu cmdlet, bu parametrenin belirttiği ada, anahtar kasasının adına ve geçerli ortamınıza göre bir anahtarın tam etki alanı adını (FQDN) oluşturur.

Tür:String
Diğer adlar:KeyName
Position:1
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-PassThru

Bu cmdlet'in bir Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey nesnesi döndürdüğünü gösterir. Varsayılan olarak, bu cmdlet herhangi bir çıkış oluşturmaz.

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-VaultName

Anahtarın kaldırılacağı anahtar kasasının adını belirtir. Bu cmdlet, bu parametrenin belirttiği ada ve geçerli ortamınıza göre bir anahtar kasasının FQDN'sini oluşturur.

Tür:String
Position:0
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-WhatIf

Cmdlet çalıştırılıyorsa ne olacağını gösterir. Cmdlet çalıştırılmaz. Cmdlet çalıştırılırsa ne olacağını gösterir. Cmdlet çalıştırılmaz.

Tür:SwitchParameter
Diğer adlar:wi
Position:Named
Default value:False
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

Girişler

PSKeyVaultKeyIdentityItem

Çıkışlar

PSDeletedKeyVaultKey