Set-AzKeyVaultSecret

Référence

Module:: Az.KeyVault

Crée ou met à jour un secret dans un coffre de clés.

Syntaxe

Set-AzKeyVaultSecret
   [-VaultName] <String>
   [-Name] <String>
   [-SecretValue] <SecureString>
   [-Disable]
   [-Expires <DateTime>]
   [-NotBefore <DateTime>]
   [-ContentType <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzKeyVaultSecret
   [-Id] <String>
   [-SecretValue] <SecureString>
   [-Disable]
   [-Expires <DateTime>]
   [-NotBefore <DateTime>]
   [-ContentType <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzKeyVaultSecret
   [-InputObject] <PSKeyVaultSecretIdentityItem>
   [-SecretValue] <SecureString>
   [-Disable]
   [-Expires <DateTime>]
   [-NotBefore <DateTime>]
   [-ContentType <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

L’applet de commande Set-AzKeyVaultSecret crée ou met à jour un secret dans un coffre de clés dans Azure Key Vault. Si le secret n’existe pas, cette applet de commande la crée. Si le secret existe déjà, cette applet de commande crée une nouvelle version de ce secret.

Exemples

Exemple 1 : Modifier la valeur d’un secret à l’aide d’attributs par défaut

$Secret = ConvertTo-SecureString -String "****" -AsPlainText -Force
Set-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -SecretValue $Secret

Vault Name   : Contoso
Name         : ITSecret
Version      : 8b5c0cb0326e4350bd78200fac932b51
Id           : https://contoso.vault.azure.net:443/secrets/ITSecret/8b5c0cb0326e4350bd78200fac932b51
Enabled      : True
Expires      :
Not Before   :
Created      : 5/25/2018 6:39:30 PM
Updated      : 5/25/2018 6:39:30 PM
Content Type :
Tags         :

Exemple 2 : Modifier la valeur d’un secret à l’aide d’attributs personnalisés

$Secret = ConvertTo-SecureString -String "****" -AsPlainText -Force
$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$NBF =(Get-Date).ToUniversalTime()
$Tags = @{ 'Severity' = 'medium'; 'IT' = 'true'}
$ContentType = 'txt'
Set-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -SecretValue $Secret -Expires $Expires -NotBefore $NBF -ContentType $ContentType -Disable -Tags $Tags

Vault Name   : Contoso
Name         : ITSecret
Version      : a2c150be3ea24dd6b8286986e6364851
Id           : https://contoso.vault.azure.net:443/secrets/ITSecret/a2c150be3ea24dd6b8286986e6364851
Enabled      : False
Expires      : 5/25/2020 6:40:00 PM
Not Before   : 5/25/2018 6:40:05 PM
Created      : 5/25/2018 6:41:22 PM
Updated      : 5/25/2018 6:41:22 PM
Content Type : txt
Tags         : Name      Value
               Severity  medium
               IT        true

La première commande convertit une chaîne en chaîne sécurisée à l’aide de l’applet de commande ConvertTo-SecureString , puis stocke cette chaîne dans la variable $Secret. Pour plus d’informations, tapez Get-Help ConvertTo-SecureString. Les commandes suivantes définissent des attributs personnalisés pour la date d’expiration, les balises et le type de contexte, et stockent les attributs dans des variables. La commande finale modifie les valeurs du secret nommé ITSecret dans le coffre de clés nommé Contoso à l’aide des valeurs spécifiées précédemment en tant que variables.

Exemple 3 : Modifier la valeur d’un secret à l’aide d’attributs par défaut (à l’aide de l’URI)

$Secret = ConvertTo-SecureString -String "****" -AsPlainText -Force
Set-AzKeyVaultSecret -Id 'https://contoso.vault.azure.net/secrets/ITSecret' -SecretValue $Secret

Vault Name   : Contoso
Name         : ITSecret
Version      : 8b5c0cb0326e4350bd78200fac932b51
Id           : https://contoso.vault.azure.net:443/secrets/ITSecret/8b5c0cb0326e4350bd78200fac932b51
Enabled      : True
Expires      :
Not Before   :
Created      : 5/25/2018 6:39:30 PM
Updated      : 5/25/2018 6:39:30 PM
Content Type :
Tags         :

Cette commande définit ou met à jour la valeur du secret nommé secret1 dans le coffre de clés nommé Contoso à l’aide de l’URI du secret.

Exemple 4 : Créer un secret dans azure Key Vault par commande Set-Secret dans le module Microsoft.PowerShell.SecretManagement

# Install module Microsoft.PowerShell.SecretManagement
Install-Module Microsoft.PowerShell.SecretManagement -Repository PSGallery -AllowPrerelease
# Register vault for Secret Management
Register-SecretVault -Name AzKeyVault -ModuleName Az.KeyVault -VaultParameters @{ AZKVaultName = 'test-kv'; SubscriptionId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' }
# Set secret for vault AzKeyVault
$secure = ConvertTo-SecureString -String "****" -AsPlainText -Force
Set-Secret -Name secureSecret -SecureStringSecret $secure -Vault AzKeyVault

None

Cet exemple montre comment définir un secret nommé secureSecret dans le coffre de clés Azure test-kv par Set-Secret de commande dans le module Microsoft.PowerShell.SecretManagement.

Paramètres

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Type:	SwitchParameter
Alias:	cf
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-ContentType

Spécifie le type de contenu d’un secret. Pour supprimer le type de contenu existant, spécifiez une chaîne vide.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure

Type:	IAzureContextContainer
Alias:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Disable

Indique que cette applet de commande désactive un secret.

Type:	SwitchParameter
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Expires

Spécifie l’heure d’expiration, en tant qu’objet DateTime, pour le secret mis à jour par cette applet de commande. Ce paramètre utilise le temps universel coordonné (UTC). Pour obtenir un objet DateTime, utilisez l’applet de commande Get-Date . Pour plus d’informations, tapez Get-Help Get-Date.

Type:	DateTime
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Id

URI du secret KeyVault. Assurez-vous qu’il suit le format : https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Type:	String
Alias:	SecretId
Position:	0
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-InputObject

Objet Secret

Type:	PSKeyVaultSecretIdentityItem
Position:	0
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-Name

Spécifie le nom d’un secret à modifier. Cette applet de commande construit le nom de domaine complet (FQDN) d’un secret en fonction du nom spécifié par ce paramètre, du nom du coffre de clés et de votre environnement actuel.

Type:	String
Alias:	SecretName
Position:	1
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-NotBefore

Spécifie l’heure, sous la forme d’un objet DateTime, avant laquelle le secret ne peut pas être utilisé. Ce paramètre utilise UTC. Pour obtenir un objet DateTime, utilisez l’applet de commande Get-Date .

Type:	DateTime
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-SecretValue

Spécifie la valeur du secret en tant qu’objet SecureString. Pour obtenir un objet SecureString, utilisez l’applet de commande ConvertTo-SecureString . Pour plus d’informations, tapez Get-Help ConvertTo-SecureString.

Type:	SecureString
Position:	2
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Tag

Paires clé-valeur sous la forme d’une table de hachage. Par exemple : @{key0="value0 » ; key1=$null ; key2="value2"}

Type:	Hashtable
Alias:	Tags
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-VaultName

Spécifie le nom du coffre de clés auquel appartient ce secret. Cette applet de commande construit le nom de domaine complet d’un coffre de clés en fonction du nom spécifié par ce paramètre et de votre environnement actuel.

Type:	String
Position:	0
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

Type:	SwitchParameter
Alias:	wi
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

Entrées

PSKeyVaultSecretIdentityItem

Sorties

PSKeyVaultSecret

Partager via

Set-AzKeyVaultSecret

Syntaxe

Description

Exemples

Exemple 1 : Modifier la valeur d’un secret à l’aide d’attributs par défaut

Exemple 2 : Modifier la valeur d’un secret à l’aide d’attributs personnalisés

Exemple 3 : Modifier la valeur d’un secret à l’aide d’attributs par défaut (à l’aide de l’URI)

Exemple 4 : Créer un secret dans azure Key Vault par commande Set-Secret dans le module Microsoft.PowerShell.SecretManagement

Paramètres

-Confirm

-ContentType

-DefaultProfile

-Disable

-Expires

-Id

-InputObject

-Name

-NotBefore

-SecretValue

-Tag

-VaultName

-WhatIf

Entrées

Sorties

Ressources supplémentaires

Partager via

Set-AzKeyVaultSecret

Syntaxe

Description

Exemples

Exemple 1 : Modifier la valeur d’un secret à l’aide d’attributs par défaut

Exemple 2 : Modifier la valeur d’un secret à l’aide d’attributs personnalisés

Exemple 3 : Modifier la valeur d’un secret à l’aide d’attributs par défaut (à l’aide de l’URI)

Exemple 4 : Créer un secret dans azure Key Vault par commande Set-Secret dans le module Microsoft.PowerShell.SecretManagement

Paramètres

-Confirm

-ContentType

-DefaultProfile

-Disable

-Expires

-Id

-InputObject

-Name

-NotBefore

-SecretValue

-Tag

-VaultName

-WhatIf

Entrées

Sorties

Liens associés

Ressources supplémentaires