Remove-AzKeyVaultKey

Modül:
Az.KeyVault Module

Anahtar kasasındaki bir anahtarı siler.

Syntax

ByVaultName (Varsayılan) 

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

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.

Parametre özellikleri

Tür:SwitchParameter
Default value:False
Joker karakterleri destekler:False
DontShow:False
Diğer adlar:Cf

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-DefaultProfile

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

Parametre özellikleri

Tür:IAzureContextContainer
Default value:None
Joker karakterleri destekler:False
DontShow:False
Diğer adlar:AzContext, AzureRmContext, AzureCredential

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-Force

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

Parametre özellikleri

Tür:SwitchParameter
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-HsmName

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

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

HsmByVaultName
Position:Named
Zorunlu:True
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-InputObject

KeyBundle Nesnesi

Parametre özellikleri

Tür:PSKeyVaultKeyIdentityItem
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

ByInputObject
Position:0
Zorunlu:True
İşlem hattından gelen değer:True
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-InRemovedState

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

Parametre özellikleri

Tür:SwitchParameter
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer: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.

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False
Diğer adlar:Anahtar Adı

Parametre kümeleri

ByVaultName
Position:1
Zorunlu:True
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False
HsmByVaultName
Position:1
Zorunlu:True
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-PassThru

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

Parametre özellikleri

Tür:SwitchParameter
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer: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.

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

ByVaultName
Position:0
Zorunlu:True
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-WhatIf

Cmdlet çalıştırılırsa 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.

Parametre özellikleri

Tür:SwitchParameter
Default value:False
Joker karakterleri destekler:False
DontShow:False
Diğer adlar:Wi

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

CommonParameters

Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.

Girişler

PSKeyVaultKeyIdentityItem

Çıkışlar

PSDeletedKeyVaultKey