Set Secret - Set Secret
Définit un secret dans un coffre de clés spécifié.
L’opération SET ajoute un secret à l’Key Vault Azure. Si la clé secrète nommée existe déjà, le coffre de clés Azure en crée une nouvelle version. Cette opération requiert l’autorisation secrets/set.
PUT {vaultBaseUrl}/secrets/{secret-name}?api-version=7.4
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
secret-name
|
path | True |
string |
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 d’identification personnelle ou sensibles. Regex pattern: |
vault
|
path | True |
string |
Nom du coffre, par exemple https://myvault.vault.azure.net. |
api-version
|
query | True |
string |
Version d’API client. |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
value | True |
string |
Valeur de la clé secrète. |
attributes |
Attributs de gestion des secrets. |
||
contentType |
string |
Type de la valeur de secret, par exemple un mot de passe. |
|
tags |
object |
Métadonnées spécifiques d’application sous la forme de paires clé/valeur. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Bundle de secrets contenant le résultat de la demande de secret définie. |
|
Other Status Codes |
Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération. |
Exemples
SetSecret
Sample Request
PUT https://myvault.vault.azure.net//secrets/crpsecret?api-version=7.4
{
"value": "mysecretvalue"
}
Sample Response
{
"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 |
---|---|
Deletion |
Reflète le niveau de récupération de suppression actuellement en vigueur pour les secrets dans le coffre actuel. S’il contient « Purgeable », le secret peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le secret, à la fin de l’intervalle de rétention. |
Error |
Erreur du serveur du coffre de clés. |
Key |
Exception d’erreur du coffre de clés. |
Secret |
Attributs de gestion des secrets. |
Secret |
Secret constitué d’une valeur, d’un id et de ses attributs. |
Secret |
Paramètres du jeu de secrets. |
DeletionRecoveryLevel
Reflète le niveau de récupération de suppression actuellement en vigueur pour les secrets dans le coffre actuel. S’il contient « Purgeable », le secret peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le secret, à la fin de l’intervalle de rétention.
Nom | Type | Description |
---|---|---|
CustomizedRecoverable |
string |
Désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (par exemple, vidage lorsque 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et pendant que l’abonnement est toujours disponible. |
CustomizedRecoverable+ProtectedSubscription |
string |
Indique un état de coffre et d’abonnement dans lequel la suppression est récupérable, la suppression immédiate et définitive (c’est-à-dire le vidage) 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ération 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é. |
CustomizedRecoverable+Purgeable |
string |
Désigne un état de coffre dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et définitive (par exemple, la suppression lorsque 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention, sauf si une opération de vidage est demandée ou que l’abonnement est annulé. |
Purgeable |
string |
Indique un état de coffre dans lequel la suppression est une opération irréversible, sans possibilité de récupération. Ce niveau correspond à l’absence de protection disponible 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 au niveau supérieur (coffre, groupe de ressources, abonnement, etc.) |
Recoverable |
string |
Désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (par exemple, vidage). Ce niveau garantit la récupération 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 |
string |
Indique un état de coffre et d’abonnement dans lequel la suppression est récupérable dans l’intervalle de rétention (90 jours), la suppression immédiate et définitive (c’est-à-dire le vidage) n’est pas autorisée et dans lequel l’abonnement lui-même ne peut pas être annulé définitivement. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré |
Recoverable+Purgeable |
string |
Désigne un état de coffre dans lequel la suppression est récupérable, et qui permet également la suppression immédiate et définitive (c’est-à-dire le vidage). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours), sauf si une opération de vidage est demandée ou que l’abonnement est annulé. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré |
Error
Erreur du serveur du coffre de clés.
Nom | Type | Description |
---|---|---|
code |
string |
Code d'erreur. |
innererror |
Erreur du serveur du coffre de clés. |
|
message |
string |
Message d’erreur. |
KeyVaultError
Exception d’erreur du coffre de clés.
Nom | Type | Description |
---|---|---|
error |
Erreur du serveur du coffre de clés. |
SecretAttributes
Attributs de gestion des secrets.
Nom | Type | Description |
---|---|---|
created |
integer |
Heure de création en UTC. |
enabled |
boolean |
Détermine si l’objet est activé. |
exp |
integer |
Date d’expiration en UTC. |
nbf |
integer |
Date non antérieure en UTC. |
recoverableDays |
integer |
softDelete data retention days. La valeur doit être >=7 et <=90 lorsque softDelete est activé, sinon 0. |
recoveryLevel |
Reflète le niveau de récupération de suppression actuellement en vigueur pour les secrets dans le coffre actuel. S’il contient « Purgeable », le secret peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le secret, à la fin de l’intervalle de rétention. |
|
updated |
integer |
Heure de la dernière mise à jour au format UTC. |
SecretBundle
Secret constitué d’une valeur, d’un id et de ses attributs.
Nom | Type | Description |
---|---|---|
attributes |
Attributs de gestion des secrets. |
|
contentType |
string |
Type de contenu du secret. |
id |
string |
ID de secret. |
kid |
string |
S’il s’agit d’un secret qui sauvegarde un certificat KV, ce champ spécifie la clé correspondante qui sauvegarde 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 soutient un certificat, géré sera vrai. |
tags |
object |
Métadonnées spécifiques d’application sous la forme de paires clé/valeur. |
value |
string |
Valeur du secret. |
SecretSetParameters
Paramètres du jeu de secrets.
Nom | Type | Description |
---|---|---|
attributes |
Attributs de gestion des secrets. |
|
contentType |
string |
Type de la valeur de secret, par exemple un mot de passe. |
tags |
object |
Métadonnées spécifiques d’application sous la forme de paires clé/valeur. |
value |
string |
Valeur de la clé secrète. |