Update-AzKeyVaultSecret

Memperbarui atribut rahasia dalam brankas kunci.

Sintaks

Update-AzKeyVaultSecret
      [-VaultName] <String>
      [-Name] <String>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-ContentType <String>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzKeyVaultSecret
      [-InputObject] <PSKeyVaultSecretIdentityItem>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-ContentType <String>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Deskripsi

Cmdlet Update-AzKeyVaultSecret memperbarui atribut rahasia yang dapat diedit di brankas kunci.

Contoh

Contoh 1: Mengubah atribut rahasia

$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Nbf = (Get-Date).ToUniversalTime()
$Tags = @{ 'Severity' = 'medium'; 'HR' = 'true'}
$ContentType= 'xml'
Update-AzKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Expires $Expires -NotBefore $Nbf -ContentType $ContentType -Enable $True -Tag $Tags -PassThru

Vault Name   : ContosoVault
Name         : HR
Version      : d476edfcd3544017a03bc49c1f3abec0
Id           : https://ContosoVault.vault.azure.net:443/secrets/HR/d476edfcd3544017a03bc49c1f3abec0
Enabled      : True
Expires      : 5/25/2020 8:01:58 PM
Not Before   : 5/25/2018 8:02:02 PM
Created      : 4/11/2018 11:45:06 PM
Updated      : 5/25/2018 8:02:45 PM
Content Type : xml
Tags         : Name      Value
               Severity  medium
               HR        true

Empat perintah pertama menentukan atribut untuk tanggal kedaluwarsa, tanggal NotBefore, tag, dan jenis konteks, dan menyimpan atribut dalam variabel. Perintah akhir memodifikasi atribut untuk rahasia bernama HR di brankas kunci bernama ContosoVault, menggunakan variabel yang disimpan.

Contoh 2: Menghapus tag dan jenis konten untuk rahasia

Update-AzKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Version '9EEA45C6EE50490B9C3176A80AC1A0DF' -ContentType '' -Tag @{}

Perintah ini menghapus tag dan jenis konten untuk versi rahasia yang ditentukan bernama HR di brankas kunci bernama Contoso.

Contoh 3: Nonaktifkan versi rahasia saat ini yang namanya dimulai dengan IT

$Vault = 'ContosoVault'
$Prefix = 'IT'
Get-AzKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzKeyVaultSecret -Enable $False

Perintah pertama menyimpan nilai string Contoso dalam variabel $Vault. Perintah kedua menyimpan nilai string IT dalam variabel $Prefix. Perintah ketiga menggunakan cmdlet Get-AzKeyVaultSecret untuk mendapatkan rahasia dalam brankas kunci yang ditentukan, lalu meneruskan rahasia tersebut ke cmdlet Where-Object . Cmdlet Where-Object memfilter rahasia untuk nama yang dimulai dengan karakter IT. Perintah menyalurkan rahasia yang cocok dengan filter ke cmdlet Update-AzKeyVaultSecret, yang menonaktifkannya.

Contoh 4: Atur ContentType untuk semua versi rahasia

$VaultName = 'ContosoVault'
$Name = 'HR'
$ContentType = 'xml'
Get-AzKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzKeyVaultSecret -ContentType $ContentType

Tiga perintah pertama menentukan variabel string yang akan digunakan untuk parameter VaultName, Name, dan ContentType . Perintah keempat menggunakan cmdlet Get-AzKeyVaultKey untuk mendapatkan kunci yang ditentukan, dan menyalurkan kunci ke cmdlet Update-AzKeyVaultSecret untuk mengatur jenis kontennya ke XML.

Parameter

-Confirm

Meminta Anda mengonfirmasi sebelum menjalankan cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContentType

Jenis konten rahasia. Jika tidak ditentukan, nilai yang ada dari jenis konten rahasia tetap tidak berubah. Hapus nilai tipe konten yang ada dengan menentukan string kosong.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Kredensial, akun, penyewa, dan langganan yang digunakan untuk komunikasi dengan Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Enable

Jika ada, aktifkan rahasia jika nilainya benar. Nonaktifkan rahasia jika nilai salah. Jika tidak ditentukan, nilai yang ada dari status rahasia yang diaktifkan/dinonaktifkan tetap tidak berubah.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Expires

Waktu kedaluwarsa rahasia dalam waktu UTC. Jika tidak ditentukan, nilai yang ada dari waktu kedaluwarsa rahasia tetap tidak berubah.

Type:Nullable<T>[DateTime]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Objek rahasia

Type:PSKeyVaultSecretIdentityItem
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Nama rahasia. Cmdlet membangun FQDN rahasia dari nama vault, lingkungan dan nama rahasia yang saat ini dipilih.

Type:String
Aliases:SecretName
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NotBefore

Waktu UTC sebelum rahasia mana yang tidak dapat digunakan. Jika tidak ditentukan, nilai yang ada dari atribut NotBefore rahasia tetap tidak berubah.

Type:Nullable<T>[DateTime]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Cmdlet tidak mengembalikan objek secara default. Jika sakelar ini ditentukan, kembalikan objek Rahasia.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Hashtable yang mewakili tag rahasia. Jika tidak ditentukan, tag rahasia yang ada tetap tidak berubah. Hapus tag dengan menentukan Hashtable kosong.

Type:Hashtable
Aliases:Tags
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VaultName

Nama vault. Cmdlet membangun FQDN vault berdasarkan nama dan lingkungan yang saat ini dipilih.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Version

Versi rahasia. Cmdlet membangun FQDN rahasia dari nama vault, lingkungan yang saat ini dipilih, nama rahasia, dan versi rahasia.

Type:String
Aliases:SecretVersion
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Input

PSKeyVaultSecretIdentityItem

Output

PSKeyVaultSecret