Update-AzKeyVaultSecret

Syntax

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

Beschreibung

Das Cmdlet Update-AzKeyVaultSecret aktualisiert bearbeitbare Attribute eines geheimen Schlüssels in einem Schlüsseltresor.

Beispiele

Beispiel 1: Ändern der Attribute eines geheimen Schlüssels

$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

Die ersten vier Befehle definieren Attribute für das Ablaufdatum, das NotBefore-Datum, tags und den Kontexttyp und speichern die Attribute in Variablen. Mit dem letzten Befehl werden die Attribute für den geheimen Schlüssel mit dem Namen "HR" im Schlüsseltresor "ContosoVault" mithilfe der gespeicherten Variablen geändert.

Beispiel 2: Löschen der Tags und des Inhaltstyps für einen geheimen Schlüssel

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

Mit diesem Befehl werden die Tags und der Inhaltstyp für die angegebene Version des geheimen Schlüssels "HR" im Schlüsseltresor "Contoso" gelöscht.

Beispiel 3: Deaktivieren der aktuellen Version von geheimen Schlüsseln, deren Name mit der IT beginnt

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

Der erste Befehl speichert den Zeichenfolgenwert Contoso in der variablen $Vault. Der zweite Befehl speichert den Zeichenfolgenwert IN der variablen $Prefix. Der dritte Befehl verwendet das Cmdlet "Get-AzKeyVaultSecret", um die geheimen Schlüssel im angegebenen Schlüsseltresor abzurufen, und übergibt diese geheimen Schlüssel an das Where-Object-Cmdlet . Das Cmdlet Where-Object filtert die geheimen Schlüssel nach Namen, die mit den Zeichen IT beginnen. Mit dem Befehl werden die geheimen Schlüssel, die dem Filter entsprechen, mit dem Cmdlet Update-AzKeyVaultSecret weitergeleitet, das sie deaktiviert.

Beispiel 4: Festlegen des Inhaltstyps für alle Versionen eines geheimen Schlüssels

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

Die ersten drei Befehle definieren Zeichenfolgenvariablen, die für die Parameter VaultName, Name und ContentType verwendet werden sollen. Der vierte Befehl verwendet das Cmdlet "Get-AzKeyVaultKey", um die angegebenen Schlüssel abzurufen, und gibt die Schlüssel an das Cmdlet Update-AzKeyVaultSecret weiter, um den Inhaltstyp auf XML festzulegen.

Parameter

-Confirm

-ContentType

-DefaultProfile

-Enable

-Expires

-InputObject

-Name

-NotBefore

-PassThru

-Tag

-VaultName

-Version

-WhatIf

Eingaben

PSKeyVaultSecretIdentityItem

Ausgaben

PSKeyVaultSecret