Remove-AzKeyVaultSecret

  • Başvuru
Modül:
Az.KeyVault

Anahtar kasasında gizli diziyi siler.

Sözdizimi

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

Description

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

Örnekler

Örnek 1: Anahtar kasasından gizli dizi kaldırma

Remove-AzKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -PassThru

Vault Name           : Contoso
Name                 : FinanceSecret
Version              : f622abc7b1394092812f1eb0f85dc91c
Id                   : https://contoso.vault.azure.net:443/secrets/financesecret/f622abc7b1394092812f1eb0f85dc91c
Deleted Date         : 5/25/2018 4:45:34 PM
Scheduled Purge Date : 8/23/2018 4:45:34 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/19/2018 5:56:02 PM
Updated              : 4/26/2018 7:48:40 PM
Content Type         :
Tags                 :

Bu komut, Contoso adlı anahtar kasasından FinanceSecret adlı gizli diziyi kaldırır.'

Örnek 2: Kullanıcı onayı olmadan anahtar kasasından gizli dizi kaldırma

Remove-AzKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -PassThru -Force

Vault Name           : Contoso
Name                 : FinanceSecret
Version              : f622abc7b1394092812f1eb0f85dc91c
Id                   : https://contoso.vault.azure.net:443/secrets/financesecret/f622abc7b1394092812f1eb0f85dc91c
Deleted Date         : 5/25/2018 4:45:34 PM
Scheduled Purge Date : 8/23/2018 4:45:34 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/19/2018 5:56:02 PM
Updated              : 4/26/2018 7:48:40 PM
Content Type         :
Tags                 :

Bu komut, Contoso adlı anahtar kasasından FinanceSecret adlı gizli diziyi kaldırır. komutu Force ve Confirm parametrelerini belirtir ve bu nedenle cmdlet sizden onay istemez.

Örnek 3: Microsoft.PowerShell.SecretManagement modülünde Remove-Secret komutuyla Azure Key Vault'ta gizli dizi kaldırma

# Install module Microsoft.PowerShell.SecretManagement
Install-Module Microsoft.PowerShell.SecretManagement -Repository PSGallery -AllowPrerelease
# Register vault for Secret Management
Register-SecretVault -Name AzKeyVault -ModuleName Az.KeyVault -VaultParameters @{ AZKVaultName = 'test-kv'; SubscriptionId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' }
# Set secret for vault AzKeyVault
$secure = ConvertTo-SecureString -String "****" -AsPlainText -Force
Set-Secret -Vault AzKeyVault -Name secureSecret -SecureStringSecret $secure 
Remove-Secret -Vault AzKeyVault -Name secureSecret

None

Bu örnek, modülündeki Microsoft.PowerShell.SecretManagementkomutuyla Remove-Secret Azure Key Vault'ta test-kv adlı secureSecret gizli diziyi kaldırır.

Örnek 4: Silinen gizli diziyi anahtar kasasından kalıcı olarak temizleme

Remove-AzKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -InRemovedState

Bu komut, FinanceSecret adlı gizli diziyi 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.

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

-InputObject

Key Vault Gizli Anahtarı Nesnesi

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

-InRemovedState

Varsa, daha önce silinen gizli diziyi kalıcı olarak kaldırır.

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

-Name

Gizli dizinin 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 gizli dizinin tam etki alanı adını (FQDN) oluşturur.

Tür:String
Diğer adlar:SecretName
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.Secret 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

Gizli dizinin ait olduğu 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

PSKeyVaultSecretIdentityItem

Çıkışlar

PSDeletedKeyVaultSecret