Set Secret - Set Secret

Service:: Key Vault

Version d'API:: 2025-07-01

Définit un code secret dans un coffre de clés spécifié.
L’opération SET ajoute un code secret à Azure Key Vault. Si le secret nommé existe déjà, Azure Key Vault crée une nouvelle version de ce secret. Cette opération nécessite l’autorisation secrets/set.

PUT {vaultBaseUrl}/secrets/{secret-name}?api-version=2025-07-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
secret-name	path	True	string pattern: ^[0-9a-zA-Z-]+$	Nom du secret. La valeur que vous fournissez peut être copiée globalement dans le but d’exécuter le service. La valeur fournie ne doit pas inclure d’informations personnellement identifiables ou sensibles.
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
value	True	string	Valeur du secret.
attributes		SecretAttributes	Les attributs de gestion des secrets.
contentType		string	Type de la valeur secrète, par exemple un mot de passe.
tags		object	Métadonnées spécifiques à l’application sous la forme de paires clé-valeur.

Réponses

Nom	Type	Description
200 OK	SecretBundle	La demande a réussi.
Other Status Codes	KeyVaultError	Réponse d’erreur inattendue.

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
https://vault.azure.net/.default

Exemples

SetSecret

Exemple de requête

HTTP

PUT https://myvault.vault.azure.net//secrets/crpsecret?api-version=2025-07-01

{
  "value": "mysecretvalue"
}

Exemple de réponse

Code d’état:: 200

{
  "value": "mysecretvalue",
  "id": "https://myvault.vault.azure.net/secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441",
  "attributes": {
    "enabled": true,
    "created": 1493938459,
    "updated": 1493938459,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

Définitions

Nom	Description
DeletionRecoveryLevel	Reflète le niveau de récupération de suppression actuellement en vigueur pour les secrets dans le coffre-fort actuel. S’il contient « Purgable », le secret peut être définitivement supprimé par un utilisateur privilégié ; Dans le cas contraire, seul le système peut purger le secret, à la fin de l’intervalle de rétention.
Error
KeyVaultError	Exception d’erreur du coffre de clés.
SecretAttributes	Les attributs de gestion des secrets.
SecretBundle	Secret composé d’une valeur, d’un id et de ses attributs.
SecretSetParameters	Le secret : définir les paramètres.

DeletionRecoveryLevel

Énumération

Reflète le niveau de récupération de suppression actuellement en vigueur pour les secrets dans le coffre-fort actuel. S’il contient « Purgable », le secret peut être définitivement supprimé par un utilisateur privilégié ; Dans le cas contraire, seul le système peut purger le secret, à la fin de l’intervalle de rétention.

Valeur	Description
Purgeable	Désigne un état de coffre-fort dans lequel la suppression est une opération irréversible, sans possibilité de récupération. Ce niveau correspond à l’absence de protection contre une opération de suppression ; les données sont irrémédiablement perdues lors de l’acceptation d’une opération de suppression au niveau de l’entité ou supérieur (coffre-fort, groupe de ressources, abonnement, etc.)
Recoverable+Purgeable	Désigne un état de coffre-fort dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et permanente (c’est-à-dire la purge). Ce niveau garantit la récupérabilité de l’entité supprimée pendant l’intervalle de rétention (90 jours), sauf si une opération de purge est demandée ou si l’abonnement est annulé. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Recoverable	Désigne un état de coffre-fort dans lequel la suppression est récupérable sans possibilité de suppression immédiate et permanente (c’est-à-dire la purge). Ce niveau garantit la récupérabilité de l’entité supprimée pendant l’intervalle de rétention (90 jours) et pendant que l’abonnement est toujours disponible. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Recoverable+ProtectedSubscription	Désigne un état de coffre-fort et d’abonnement dans lequel la suppression est récupérable dans un intervalle de rétention (90 jours), la suppression immédiate et définitive (c’est-à-dire la purge) n’est pas autorisée et dans lequel l’abonnement lui-même ne peut pas être annulé de manière permanente. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
CustomizedRecoverable+Purgeable	Désigne un état de coffre-fort dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et permanente (c’est-à-dire la purge lorsque 7 <= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupérabilité de l’entité supprimée pendant l’intervalle de rétention, sauf si une opération de purge est demandée ou si l’abonnement est annulé.
CustomizedRecoverable	Désigne un état de coffre-fort dans lequel la suppression est récupérable sans possibilité de suppression immédiate et permanente (c’est-à-dire purge lorsque 7 <= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupérabilité de l’entité supprimée pendant l’intervalle de rétention et pendant que l’abonnement est toujours disponible.
CustomizedRecoverable+ProtectedSubscription	Désigne un état de coffre-fort et d’abonnement dans lequel la suppression est récupérable, la suppression immédiate et permanente (c’est-à-dire la purge) n’est pas autorisée, et dans lequel l’abonnement lui-même ne peut pas être annulé définitivement lorsque 7 <= SoftDeleteRetentionInDays < 90. Ce niveau garantit la récupérabilité de l’entité supprimée pendant l’intervalle de rétention, et reflète également le fait que l’abonnement lui-même ne peut pas être annulé.

Error

Object

Nom	Type	Description
code	string	Code d’erreur.
innererror	Error	Erreur de serveur Key Vault.
message	string	Message d’erreur.

KeyVaultError

Object

Exception d’erreur du coffre de clés.

Nom	Type	Description
error	Error	Erreur de serveur Key Vault.

SecretAttributes

Object

Les attributs de gestion des secrets.

Nom	Type	Description
created	integer (unixtime)	Heure de création en UTC.
enabled	boolean	Détermine si l’objet est activé.
exp	integer (unixtime)	Date d’expiration en UTC.
nbf	integer (unixtime)	Pas avant la date en UTC.
recoverableDays	integer (int32)	Jours de conservation des données softDelete. La valeur doit être >=7 et <=90 lorsque la suppression douce est activée, sinon 0.
recoveryLevel	DeletionRecoveryLevel	Reflète le niveau de récupération de suppression actuellement en vigueur pour les secrets dans le coffre-fort actuel. S’il contient « Purgable », le secret peut être définitivement supprimé par un utilisateur privilégié ; Dans le cas contraire, seul le système peut purger le secret, à la fin de l’intervalle de rétention.
updated	integer (unixtime)	Dernière mise à jour de l’heure en UTC.

SecretBundle

Object

Secret composé d’une valeur, d’un id et de ses attributs.

Nom	Type	Description
attributes	SecretAttributes	Les attributs de gestion des secrets.
contentType	string	Type de contenu du secret.
id	string	L’identifiant secret.
kid	string	S’il s’agit d’un secret qui sauvegarde un certificat KV, ce champ spécifie la clé correspondante qui sous-tend le certificat KV.
managed	boolean	True si la durée de vie du secret est gérée par le coffre de clés. S’il s’agit d’un secret qui sauvegarde un certificat, alors managed sera true.
previousVersion	string	La version du certificat précédent, le cas échéant. S’applique uniquement aux certificats créés après le 1er juin 2025. Les certificats créés avant cette date ne sont pas mis à jour rétroactivement.
tags	object	Métadonnées spécifiques à l’application sous la forme de paires clé-valeur.
value	string	La valeur secrète.

SecretSetParameters

Object

Le secret : définir les paramètres.

Nom	Type	Description
attributes	SecretAttributes	Les attributs de gestion des secrets.
contentType	string	Type de la valeur secrète, par exemple un mot de passe.
tags	object	Métadonnées spécifiques à l’application sous la forme de paires clé-valeur.
value	string	Valeur du secret.