Get Key - Get Key

  • Référence
Service:
Key Vault
API Version:
7.4

Obtient la partie publique d’une clé stockée.
L’opération obtenir la clé s’applique à tous les types de clés. Si la clé demandée est symétrique, aucune clé n’est libérée dans la réponse. Cette opération nécessite l’autorisation keys/get.

GET {vaultBaseUrl}/keys/{key-name}/{key-version}?api-version=7.4

Paramètres URI

Nom Dans Obligatoire Type Description
key-name
 path True

string

Nom de la clé à obtenir.
key-version
 path True

string

L’ajout du paramètre version récupère une version spécifique d’une clé. Ce fragment d’URI est facultatif. Si elle n’est pas spécifiée, la dernière version de la clé 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

KeyBundle

Ensemble de clés contenant la clé et ses attributs.
Other Status Codes

KeyVaultError

Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

Get key

Sample Request

GET https://myvault.vault.azure.net//keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71?api-version=7.4

Sample Response

Status code:
200 
{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71",
    "kty": "RSA",
    "key_ops": [
      "encrypt",
      "decrypt",
      "sign",
      "verify",
      "wrapKey",
      "unwrapKey"
    ],
    "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": true,
    "created": 1493942451,
    "updated": 1493942451,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "purpose": "unit test",
    "test name ": "CreateGetDeleteKeyTest"
  }
}

Définitions

Nom Description
DeletionRecoveryLevel

Reflète le niveau de récupération de suppression actuellement en vigueur pour les clés dans le coffre actuel. Si elle contient « Purgeable », la clé peut être supprimée définitivement par un utilisateur privilégié ; sinon, seul le système peut vider la clé, à la fin de l’intervalle de rétention.
Error

Erreur du serveur du coffre de clés.
JsonWebKey

À partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName

Nom de la courbe elliptique. Pour connaître les valeurs valides, consultez JsonWebKeyCurveName.
JsonWebKeyType

JsonWebKey Key Type (kty), comme défini dans https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes

Attributs d’une clé gérée par le service de coffre de clés.
KeyBundle

KeyBundle composé d’une WebKey et de ses attributs.
KeyReleasePolicy

Règles de stratégie selon lesquelles la clé peut être exportée.
KeyVaultError

Exception d’erreur du coffre de clés.

DeletionRecoveryLevel

Reflète le niveau de récupération de suppression actuellement en vigueur pour les clés dans le coffre actuel. Si elle contient « Purgeable », la clé peut être supprimée définitivement par un utilisateur privilégié ; sinon, seul le système peut vider la clé, à 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.

JsonWebKey

À partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Nom Type Description
crv

JsonWebKeyCurveName

Nom de la courbe elliptique. Pour connaître les valeurs valides, consultez JsonWebKeyCurveName.
d

string

Exposant privé RSA, ou composant D d’une clé privée EC.
dp

string

Paramètre de clé privée RSA.
dq

string

Paramètre de clé privée RSA.
e

string

Exposant public RSA.
k

string

Clé symétrique.
key_hsm

string

Clé protégée, utilisée avec « Apportez votre propre clé ».
key_ops

string[]

Opérations de clé prises en charge.
kid

string

Identificateur de clé.
kty

JsonWebKeyType

JsonWebKey Key Type (kty), comme défini dans https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n

string

Module RSA.
p

string

RSA secret prime.
q

string

RSA secret prime, avec p < q.
qi

string

Paramètre de clé privée RSA.
x

string

X composant d’une clé publique EC.
y

string

Composant Y d’une clé publique EC.

JsonWebKeyCurveName

Nom de la courbe elliptique. Pour connaître les valeurs valides, consultez JsonWebKeyCurveName.

Nom Type Description
P-256

string

La courbe elliptique NIST P-256, la courbe AKA SECG SECP256R1.
P-256K

string

Le SECG SECP256K1 courbe elliptique.
P-384

string

La courbe elliptique NIST P-384, courbe AKA SECG SECP384R1.
P-521

string

La courbe elliptique NIST P-521, courbe AKA SECG SECP521R1.

JsonWebKeyType

JsonWebKey Key Type (kty), comme défini dans https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Nom Type Description
EC

string

Courbe elliptique.
EC-HSM

string

Courbe elliptique avec une clé privée stockée dans le HSM.
RSA

string

RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM

string

RSA avec une clé privée stockée dans le HSM.
oct

string

Séquence d’octets (utilisée pour représenter des clés symétriques)
oct-HSM

string

Séquence d’octets (utilisée pour représenter les clés symétriques) qui est stockée dans le HSM.

KeyAttributes

Attributs d’une clé gérée par le service de coffre de clés.

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.
exportable

boolean

Indique si la clé privée peut être exportée. La stratégie de mise en production doit être fournie lors de la création de la première version d’une clé exportable.
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 clés dans le coffre actuel. Si elle contient « Purgeable », la clé peut être supprimée définitivement par un utilisateur privilégié ; sinon, seul le système peut vider la clé, à la fin de l’intervalle de rétention.
updated

integer

Heure de la dernière mise à jour en UTC.

KeyBundle

KeyBundle composé d’une WebKey et de ses attributs.

Nom Type Description
attributes

KeyAttributes

Attributs de gestion des clés.
key

JsonWebKey

Clé web Json.
managed

boolean

True si la durée de vie de la clé est gérée par le coffre de clés. S’il s’agit d’une clé qui sauvegarde un certificat, la valeur managée est true.
release_policy

KeyReleasePolicy

Règles de stratégie selon lesquelles la clé peut être exportée.
tags

object

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

KeyReleasePolicy

Règles de stratégie selon lesquelles la clé peut être exportée.

Nom Type Valeur par défaut Description
contentType

string

application/json; charset=utf-8

Type de contenu et version de la stratégie de mise en production de clé
data

string

Encodage d’objets blob les règles de stratégie en vertu desquelles la clé peut être libérée. L’objet blob doit être encodé en base64.
immutable

boolean

Définit l’état de mutabilité de la stratégie. Une fois marqué comme immuable, cet indicateur ne peut pas être réinitialisé et la stratégie ne peut en aucun cas être modifiée.

KeyVaultError

Exception d’erreur du coffre de clés.

Nom Type Description
error

Error

Erreur du serveur du coffre de clés.