Get Secret - Get Secret

Référence

Service:: Key Vault

API Version:: 7.4

Obtenir un secret spécifié à partir d’un coffre de clés donné.
L'opération GET s'applique à toute clé secrète stockée dans Azure Key Vault. Cette opération nécessite l’autorisation secrets/obtenir.

GET {vaultBaseUrl}/secrets/{secret-name}/{secret-version}?api-version=7.4

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
secret-name	path	True	string	Nom du secret.
secret-version	path	True	string	Version du secret. Ce fragment d’URI est facultatif. Si elle n’est pas spécifiée, la dernière version du secret est retournée.
vaultBaseUrl	path	True	string	Nom du coffre, par exemple https://myvault.vault.azure.net.
api-version	query	True	string	Version d’API client.

Réponses

Nom	Type	Description
200 OK	SecretBundle	Secret récupéré.
Other Status Codes	KeyVaultError	Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

GetSecret

Sample Request

HTTP

GET https://myvault.vault.azure.net//secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79?api-version=7.4

Sample Response

Status code:: 200

{
  "value": "mysecretvalue",
  "id": "https://myvault.vault.azure.net/secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79",
  "attributes": {
    "enabled": true,
    "created": 1493938410,
    "updated": 1493938410,
    "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 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.
KeyVaultError	Exception d’erreur du coffre de clés.
SecretAttributes	Attributs de gestion des secrets.
SecretBundle	Secret constitué d’une valeur, d’un id et de ses attributs.

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, purger quand 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et tant 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 permanente (c’est-à-dire la purge) n’est pas autorisée et dans laquelle 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, purge 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 purge est demandée ou si l’abonnement est annulé.
Purgeable	string	Désigne 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 (c’est-à-dire une purge). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours) et tant 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	Désigne 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 la purge) 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 une suppression immédiate et définitive (c’est-à-dire une purge). 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 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é

Error

Erreur du serveur du coffre de clés.

Nom	Type	Description
code	string	Code d'erreur.
innererror	Error	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	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	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.
updated	integer	Heure de la dernière mise à jour en UTC.

SecretBundle

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

Nom	Type	Description
attributes	SecretAttributes	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 sauvegarde 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.