Update-AzKeyVaultSecret

Référence

Module:: Az.KeyVault

Mises à jour attributs d’un secret dans un coffre de clés.

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

Description

L’applet de commande Update-AzKeyVaultSecret met à jour les attributs modifiables d’un secret dans un coffre de clés.

Exemples

Exemple 1 : Modifier les attributs d’un secret

$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

Les quatre premières commandes définissent des attributs pour la date d’expiration, la date NotBefore, les balises et le type de contexte, et stockent les attributs dans des variables. La commande finale modifie les attributs du secret nommé HR dans le coffre de clés nommé ContosoVault à l’aide des variables stockées.

Exemple 2 : Supprimer les balises et le type de contenu d’un secret

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

Cette commande supprime les balises et le type de contenu de la version spécifiée du secret nommé HR dans le coffre de clés nommé Contoso.

Exemple 3 : Désactiver la version actuelle des secrets dont le nom commence par l’informatique

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

La première commande stocke la valeur de chaîne Contoso dans la variable $Vault. La deuxième commande stocke la valeur de chaîne informatique dans la variable $Prefix. La troisième commande utilise l’applet de commande Get-AzKeyVaultSecret pour obtenir les secrets dans le coffre de clés spécifié, puis transmet ces secrets à l’applet de commande Where-Object . L’applet de commande Where-Object filtre les secrets des noms qui commencent par les caractères informatiques. La commande canalise les secrets qui correspondent au filtre à l’applet de commande Update-AzKeyVaultSecret, qui les désactive.

Exemple 4 : Définir le ContentType pour toutes les versions d’un secret

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

Les trois premières commandes définissent des variables de chaîne à utiliser pour les paramètres VaultName, Name et ContentType . La quatrième commande utilise l’applet de commande Get-AzKeyVaultKey pour obtenir les clés spécifiées et canalise les clés vers l’applet de commande Update-AzKeyVaultSecret pour définir son type de contenu sur XML.

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

-ContentType

Type de contenu du secret. S’il n’est pas spécifié, la valeur existante du type de contenu du secret reste inchangée. Supprimez la valeur de type de contenu existante en spécifiant une chaîne vide.

Type:	String
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

Si elle est présente, activez un secret si la valeur est true. Désactivez un secret si la valeur est false. S’il n’est pas spécifié, la valeur existante de l’état activé/désactivé du secret reste inchangée.

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

-Expires

Heure d’expiration d’un secret en heure UTC. S’il n’est pas spécifié, la valeur existante du délai d’expiration du secret reste inchangée.

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

-InputObject

Objet Secret

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

-Name

Nom du secret. L’applet de commande construit le nom de domaine complet d’un secret à partir du nom du coffre, l’environnement et le nom de secret actuellement sélectionnés.

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

-NotBefore

Heure UTC avant laquelle le secret ne peut pas être utilisé. S’il n’est pas spécifié, la valeur existante de l’attribut NotBefore du secret reste inchangée.

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é, retournez l’objet Secret.

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

-Tag

Table de hachage représentant des balises secrètes. S’il n’est pas spécifié, les balises existantes du secret restent inchangées. Supprimez une balise en spécifiant une table de hachage vide.

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 secrète. L’applet de commande construit le nom de domaine complet d’un secret à partir du nom du coffre, de l’environnement actuellement sélectionné, du nom de secret et de la version du secret.

Type:	String
Aliases:	SecretVersion
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

PSKeyVaultSecretIdentityItem

Sorties

PSKeyVaultSecret