Update-AzureKeyVaultSecret

Referenz

Modul:: AzureRM.KeyVault

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

Warnung

Das AzureRM PowerShell-Modul ist seit dem 29. Februar 2024 offiziell veraltet. Benutzern wird empfohlen, von AzureRM zum Az PowerShell-Modul zu migrieren, um weiterhin Support und Updates zu erhalten.

Obwohl das AzureRM-Modul weiterhin funktioniert, wird es nicht mehr Standard tained oder unterstützt, wobei eine fortgesetzte Verwendung nach Ermessen und Risiko des Benutzers erfolgt. Weitere Informationen zum Übergang zum Az-Modul finden Sie in unseren Migrationsressourcen.

Syntax

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

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

Beschreibung

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

Beispiele

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

PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime()
PS C:\> $Nbf = (Get-Date).ToUniversalTime()
PS C:\> $Tags = @{ 'Severity' = 'medium'; 'HR' = 'true'}
PS C:\> $ContentType= 'xml'
PS C:\> Update-AzureKeyVaultSecret -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

PS C:\> Update-AzureKeyVaultSecret -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

PS C:\> $Vault = 'ContosoVault'
PS C:\> $Prefix = 'IT'
PS C:\> Get-AzureKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzureKeyVaultSecret -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-AzureKeyVaultSecret, 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-AzureKeyVaultSecret weitergeleitet, das sie deaktiviert.

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

PS C:\> $VaultName = 'ContosoVault'
PS C:\> $Name = 'HR'
PS C:\> $ContentType = 'xml'
PS C:\> Get-AzureKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzureKeyVaultSecret -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-AzureKeyVaultKey", um die angegebenen Schlüssel abzurufen, und gibt die Schlüssel an das Cmdlet Update-AzureKeyVaultSecret weiter, um den Inhaltstyp auf XML festzulegen.

Parameter

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

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

-ContentType

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

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

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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, wird der vorhandene Wert des status "enabled/disabled" des geheimen Schlüssels unverändert Standard.

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

-Expires

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

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

-InputObject

Secret-Objekt

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

-Name

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

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

-NotBefore

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

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

-PassThru

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

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

-Tag

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

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

-VaultName

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

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

-Version

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

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

-WhatIf

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

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

Eingaben

PSKeyVaultSecretIdentityItem

Parameter: InputObject (ByValue)

Ausgaben

PSKeyVaultSecret