Update-AzKeyVaultKey
Aktualisiert die Attribute eines Schlüssels in einem Schlüsseltresor.
Syntax
Update-AzKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[[-Version] <String>]
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-KeyOps <String[]>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzKeyVaultKey
-HsmName <String>
[-Name] <String>
[[-Version] <String>]
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-KeyOps <String[]>]
[-Immutable]
[-ReleasePolicyPath <String>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzKeyVaultKey
[-InputObject] <PSKeyVaultKeyIdentityItem>
[[-Version] <String>]
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-KeyOps <String[]>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Beschreibung
Das Cmdlet Update-AzKeyVaultKey aktualisiert die bearbeitbaren Attribute eines Schlüssels in einem Schlüsseltresor.
Beispiele
Beispiel 1: Ändern eines Schlüssels zum Aktivieren und Festlegen des Ablaufdatums und tags
$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Tags = @{'Severity' = 'high'; 'Accounting' = 'true'}
Update-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Expires $Expires -Enable $True -Tag $Tags -PassThru
Vault Name : Contoso
Name : ITSoftware
Version : 394f9379a47a4e2086585468de6c7ae5
Id : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled : True
Expires : 5/25/2020 7:58:07 PM
Not Before :
Created : 4/6/2018 11:31:36 PM
Updated : 5/25/2018 7:59:02 PM
Purge Disabled : False
Tags : Name Value
Severity high
Accounting true
Der erste Befehl erstellt ein DateTime-Objekt mithilfe des Cmdlets "Get-Date ". Dieses Objekt gibt eine Zeit von zwei Jahren in der Zukunft an. Der Befehl speichert dieses Datum in der variablen $Expires.
Geben Sie Folgendes ein, um weitere Informationen zu erhalten: Get-Help Get-Date
.
Der zweite Befehl erstellt eine Variable zum Speichern von Tagwerten mit hohem Schweregrad und Buchhaltung.
Der letzte Befehl ändert einen Schlüssel namens "ITSoftware". Der Befehl aktiviert den Schlüssel, legt seine Ablaufzeit auf die in $Expires gespeicherte Zeit fest und legt die Tags fest, die in $Tags gespeichert sind.
Beispiel 2: Ändern eines Schlüssels zum Löschen aller Tags
Update-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Version '394f9379a47a4e2086585468de6c7ae5' -Tag @{}
Vault Name : Contoso
Name : ITSoftware
Version : 394f9379a47a4e2086585468de6c7ae5
Id : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled : True
Expires : 5/25/2020 7:58:07 PM
Not Before :
Created : 4/6/2018 11:31:36 PM
Updated : 5/25/2018 8:00:08 PM
Purge Disabled : False
Tags :
Mit diesen Befehlen werden alle Tags für eine bestimmte Version eines Schlüssels namens "ITSoftware" gelöscht.
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 |
-DefaultProfile
Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Enable
Der Wert "true" aktiviert den Schlüssel, und der Wert "false" deaktiviert den Schlüssel. Wenn nicht angegeben, wird der vorhandene Status "aktiviert/deaktiviert" 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 Schlüssels in UTC-Zeit. Wenn nicht angegeben, wird die vorhandene Ablaufzeit des Schlüssels unverändert Standard. Beachten Sie, dass Ablaufwerte für den im BYOK-Prozess verwendeten Schlüsselaustauschschlüssel ignoriert werden.
Type: | Nullable<T>[DateTime] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HsmName
HSM-Name. Cmdlet erstellt den FQDN eines verwalteten HSM basierend auf dem Namen und der aktuell ausgewählten Umgebung.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Immutable
Legt die Releaserichtlinie als unveränderlichen Zustand fest. Nachdem sie als unveränderlich markiert wurde, kann dieses Flag nicht zurückgesetzt werden, und die Richtlinie kann unter keinen Umständen geändert werden.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Schlüsselobjekt
Type: | PSKeyVaultKeyIdentityItem |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-KeyOps
Die Vorgänge, die mit dem Schlüssel ausgeführt werden können. Falls nicht angegeben, bleiben die vorhandenen Schlüsselvorgänge des Schlüssels unverändert Standard.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Schlüsselname. Cmdlet erstellt den FQDN eines Schlüssels aus dem Tresornamen, aktuell ausgewählte Umgebung und Schlüsselname.
Type: | String |
Aliases: | KeyName |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NotBefore
Die UTC-Zeit, vor der der Schlüssel nicht verwendet werden kann. Wenn nicht angegeben, wird das vorhandene NotBefore-Attribut des 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, wird das aktualisierte Schlüsselbundleobjekt zurückgegeben.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ReleasePolicyPath
Ein Pfad zu einer Datei mit JSON-Richtliniendefinition. Die Richtlinienregeln, unter denen ein Schlüssel exportiert werden kann.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Tag
Eine Hashtabelle stellt Schlüsseltags dar. Wenn nicht angegeben, bleiben die vorhandenen Tags des Schlüssels unverändert Standard.
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
Schlüsselversion. Cmdlet erstellt den FQDN eines Schlüssels aus dem Tresornamen, aktuell ausgewählte Umgebung, Schlüsselname und Schlüsselversion.
Type: | String |
Aliases: | KeyVersion |
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
Ausgaben
Azure PowerShell
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für