Freigeben über

Update-AzKeyVaultSecret

  • Referenz
Modul:
Az.KeyVault

Aktualisiert Attribute eines geheimen Schlüssels in einem Schlüsseltresor.

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

Die Update-AzKeyVaultSecret Cmdlet 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 dann an das Cmdlet Where-Object. 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, an das cmdlet Update-AzKeyVaultSecret weitergeleitet, wodurch sie deaktiviert werden.

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, Nameund ContentType- parameter verwendet werden sollen. Der vierte Befehl verwendet das Cmdlet Get-AzKeyVaultKey, um die angegebenen Schlüssel abzurufen. Außerdem werden die Schlüssel an das Cmdlet Update-AzKeyVaultSecret weitergeleitet, um den Inhaltstyp auf XML festzulegen.

Beispiel 5: Löschen der Tags und des Inhaltstyps für einen geheimen Schlüssel (mit URI)

Update-AzKeyVaultSecret -Id 'https://ContosoVault.vault.azure.net:443/secrets/HR/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.

Parameter

-Confirm

Fordert Sie vor dem Ausführen des Cmdlets zur Bestätigung auf.

Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ContentType

Der Inhaltstyp des geheimen Schlüssels. Wenn nicht angegeben, bleibt der vorhandene Wert des Inhaltstyps des geheimen Schlüssels unverändert. Entfernen Sie den vorhandenen Inhaltstypwert, indem Sie eine leere Zeichenfolge angeben.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

Typ:IAzureContextContainer
Aliase:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Enable

Wenn vorhanden, aktivieren Sie einen geheimen Schlüssel, wenn der Wert "true" ist. Deaktivieren Sie einen geheimen Schlüssel, wenn der Wert "false" ist. Wenn nicht angegeben, bleibt der vorhandene Wert des status "enabled/disabled" des geheimen Schlüssels unverändert.

Typ:Boolean
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Expires

Die Ablaufzeit eines geheimen Schlüssels in UTC-Zeit. Wenn nicht angegeben, bleibt der vorhandene Wert der Ablaufzeit des geheimen Schlüssels unverändert.

Typ:DateTime
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Id

Der URI des Schlüsselschlüsselschlüssels. Stellen Sie sicher, dass es dem Format folgt: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Typ:String
Aliase:SecretId
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-InputObject

Secret-Objekt

Typ:PSKeyVaultSecretIdentityItem
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Name

Geheimer Name. Cmdlet erstellt den FQDN eines geheimen Schlüssels aus dem Tresornamen, aktuell ausgewählte Umgebung und geheimen Namen.

Typ:String
Aliase:SecretName
Position:1
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-NotBefore

Die UTC-Zeit, vor der kein geheimer Schlüssel verwendet werden kann. Wenn nicht angegeben, bleibt der vorhandene Wert des Attributs "NotBefore" des geheimen Schlüssels unverändert.

Typ:DateTime
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-PassThru

Das Cmdlet gibt standardmäßig kein Objekt zurück. Wenn dieser Schalter angegeben ist, geben Sie das Secret-Objekt zurück.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Tag

Eine Hashtabelle, die geheime Tags darstellt. Wenn nicht angegeben, bleiben die vorhandenen Tags des geheimen Schlüssels unverändert. Entfernen Sie ein Tag, indem Sie eine leere Hashtabelle angeben.

Typ:Hashtable
Aliase:Tags
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-VaultName

Tresorname. Cmdlet erstellt den FQDN eines Tresors basierend auf dem Namen und der aktuell ausgewählten Umgebung.

Typ:String
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Version

Geheime Version. Cmdlet erstellt den FQDN eines geheimen Schlüssels aus dem Tresornamen, aktuell ausgewählte Umgebung, geheimen Namen und geheime Version.

Typ:String
Aliase:SecretVersion
Position:2
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-WhatIf

Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:SwitchParameter
Aliase:wi
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

Ausgaben