Update-AzKeyVaultKey
Mises à jour les attributs d’une clé dans un coffre de clés.
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>] Description
L’applet de commande Update-AzKeyVaultKey met à jour les attributs modifiables d’une clé dans un coffre de clés.
Exemples
Exemple 1 : Modifier une clé pour l’activer et définir la date d’expiration et les balises
$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 trueLa première commande crée un objet DateTime à l’aide de l’applet de commande Get-Date . Cet objet spécifie une période de deux ans à l’avenir. La commande stocke cette date dans la variable $Expires.
Pour plus d'informations, voir Get-Help Get-Date.
La deuxième commande crée une variable pour stocker les valeurs d’étiquettes de gravité élevée et de comptabilité.
La commande finale modifie une clé nommée ITSoftware. La commande active la clé, définit son délai d’expiration sur l’heure stockée dans $Expires et définit les balises stockées dans $Tags.
Exemple 2 : Modifier une clé pour supprimer toutes les balises
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 :Cette commande supprime toutes les balises pour une version spécifique d’une clé nommée ITSoftware.
Paramètres
-Confirm
Vous demande une confirmation avant d’exécuter l’applet de commande.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Enable
La valeur true active la clé et la valeur false désactive la clé. S’il n’est pas spécifié, l’état activé/désactivé existant reste inchangé.
| Type: | Nullable<T>[Boolean] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Expires
Heure d’expiration d’une clé en heure UTC. S’il n’est pas spécifié, l’heure d’expiration existante de la clé reste inchangée. Notez que les expirations sont ignorées pour la clé Exchange de clé utilisée dans le processus BYOK.
| Type: | Nullable<T>[DateTime] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HsmName
Nom du module HSM. L’applet de commande construit le nom de domaine complet d’un HSM managé en fonction du nom et de l’environnement actuellement sélectionné.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Immutable
Définit la stratégie de mise en production comme état immuable. Une fois marqué immuable, cet indicateur ne peut pas être réinitialisé et la stratégie ne peut pas être modifiée dans des circonstances quelconques.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Objet Clé
| Type: | PSKeyVaultKeyIdentityItem |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-KeyOps
Opérations pouvant être effectuées avec la clé. Si elle n’est pas spécifiée, les opérations de clé existantes de la clé restent inchangées.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Nom de clé. L’applet de commande construit le nom de domaine complet d’une clé à partir du nom du coffre, l’environnement et le nom de clé actuellement sélectionnés.
| Type: | String |
| Aliases: | KeyName |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NotBefore
Heure UTC avant laquelle la clé ne peut pas être utilisée. S’il n’est pas spécifié, l’attribut NotBefore existant de la clé reste inchangé.
| Type: | Nullable<T>[DateTime] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
L’applet de commande ne retourne pas d’objet par défaut. Si ce commutateur est spécifié, retourne l’objet de bundle de clés mis à jour.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReleasePolicyPath
Chemin d’accès à un fichier contenant la définition de stratégie JSON. Règles de stratégie sous lesquelles une clé peut être exportée.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tag
Une table de hachage représente les balises de clé. S’il n’est pas spécifié, les balises existantes de la clé restent inchangées.
| Type: | Hashtable |
| Aliases: | Tags |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VaultName
Nom du coffre. L’applet de commande construit le nom de domaine complet d’un coffre en fonction du nom et de l’environnement actuellement sélectionné.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Version
Version de clé. L’applet de commande construit le nom de domaine complet d’une clé à partir du nom du coffre, de l’environnement actuellement sélectionné, du nom de clé et de la version de clé.
| Type: | String |
| Aliases: | KeyVersion |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Entrées
Sorties
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour