Bagikan melalui

Remove-AzKeyVaultSecret

  • Referensi
Modul:
Az.KeyVault

Menghapus rahasia dalam brankas kunci.

Sintaks

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

Deskripsi

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

Contoh

Contoh 1: Menghapus rahasia dari brankas kunci

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                 :

Perintah ini menghapus rahasia bernama FinanceSecret dari brankas kunci bernama Contoso.'

Contoh 2: Menghapus rahasia dari brankas kunci tanpa konfirmasi pengguna

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                 :

Perintah ini menghapus rahasia bernama FinanceSecret dari brankas kunci bernama Contoso. Perintah menentukan parameter Paksa dan Konfirmasi , dan, oleh karena itu, cmdlet tidak meminta Anda untuk konfirmasi.

Contoh 3: Menghapus rahasia di Azure Key Vault dengan perintah Remove-Secret dalam modul Microsoft.PowerShell.SecretManagement

# 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

Contoh ini menghapus rahasia bernama secureSecret di Azure Key Vault test-kv berdasarkan perintah Remove-Secret dalam modul Microsoft.PowerShell.SecretManagement.

Contoh 4: Hapus menyeluruh rahasia yang dihapus dari brankas kunci secara permanen

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

Perintah ini menghapus rahasia bernama FinanceSecret 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.

Parameter

-Confirm

Meminta Anda mengonfirmasi sebelum menjalankan cmdlet.

Jenis:SwitchParameter
Alias:cf
Position:Named
Nilai default:False
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-DefaultProfile

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

Jenis:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-Force

Memaksa perintah untuk dijalankan tanpa meminta konfirmasi pengguna.

Jenis:SwitchParameter
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-InputObject

Objek Rahasia Key Vault

Jenis:PSKeyVaultSecretIdentityItem
Position:0
Nilai default:None
Diperlukan:True
Terima input alur:True
Terima karakter wildcard:False

-InRemovedState

Jika ada, menghapus rahasia yang dihapus sebelumnya secara permanen.

Jenis:SwitchParameter
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-Name

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

Jenis:String
Alias:SecretName
Position:1
Nilai default:None
Diperlukan:True
Terima input alur:False
Terima karakter wildcard:False

-PassThru

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

Jenis:SwitchParameter
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-VaultName

Menentukan nama brankas kunci tempat rahasia berada. Cmdlet ini membangun FQDN dari brankas kunci berdasarkan nama yang ditentukan parameter ini dan lingkungan Anda saat ini.

Jenis:String
Position:0
Nilai default:None
Diperlukan:True
Terima input alur:False
Terima karakter wildcard:False

-WhatIf

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

Jenis:SwitchParameter
Alias:wi
Position:Named
Nilai default:False
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

Input

PSKeyVaultSecretIdentityItem

Output

PSDeletedKeyVaultSecret