Import Key - Import Key

Référence

Service:: Key Vault

API Version:: 7.4

Importe une clé créée en externe, l'enregistre, et renvoie les paramètres et attributs de la clé au client.
L’opération d’importation de clé peut être utilisée pour importer n’importe quel type de clé dans un Key Vault Azure. Si la clé nommée existe déjà, le coffre de clés Azure en crée une nouvelle version. Cette opération nécessite l’autorisation clés/importation.

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

Paramètres URI

Nom Dans Obligatoire Type Description

Nom	Dans	Obligatoire	Type	Description
key-name	path	True	string	Nom de la clé importée. 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: `^[0-9a-zA-Z-]+$`
vaultBaseUrl	path	True	string	Nom du coffre, par exemple https://myvault.vault.azure.net.
api-version	query	True	string	Version d’API client.

key-name

path

True

string

Nom de la clé importée. 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: ^[0-9a-zA-Z-]+$

vaultBaseUrl

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
key	True	JsonWebKey	Clé web Json
Hsm		boolean	Indique s’il faut importer en tant que clé matérielle (HSM) ou clé logicielle.
attributes		KeyAttributes	Attributs de gestion des clés.
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.

Réponses

Nom	Type	Description
200 OK	KeyBundle	Bundle de clés importé dans le coffre.
Other Status Codes	KeyVaultError	Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

Import key

Sample Request

HTTP

PUT https://myvault.vault.azure.net//keys/ImportSoftKeyTest?api-version=7.4

{
  "key": {
    "kty": "RSA",
    "n": "nKAwarTrOpzd1hhH4cQNdVTgRF-b0ubPD8ZNVf0UXjb62QuAk3Dn68ESThcF7SoDYRx2QVcfoMC9WCcuQUQDieJF-lvJTSer1TwH72NBovwKlHvrXqEI0a6_uVYY5n-soGt7qFZNbwQLdWWA6PrbqTLIkv6r01dcuhTiQQAn6OWEa0JbFvWfF1kILQIaSBBBaaQ4R7hZs7-VQTHGD7J1xGteof4gw2VTiwNdcE8p5UG5b6S9KQwAeET4yB4KFPwQ3TDdzxJQ89mwYVi_sgAIggN54hTq4oEKYJHBOMtFGIN0_HQ60ZSUnpOi87xNC-8VFqnv4rfTQ7nkK6XMvjMVfw",
    "e": "AQAB",
    "d": "GeT1_D5LAZa7qlC7WZ0DKJnOth8kcPrN0urTEFtWCbmHQWkAad_px_VUpGp0BWDDzENbXbQcu4QCCdf4crve5eXt8dVI86OSah-RpEdBq8OFsETIhg2Tmq8MbYTJexoynRcIC62xAaCmkFMmu931gQSvWnYWTEuOPgmD2oE_F-bP9TFlGRc69a6MSbtcSRyFTsd5KsUr40QS4zf2W4kZCOWejyLuxk88SXgUqcJx86Ulc1Ol1KkTBLadvReAZCyCMwKBlNRGw46BU_iK0vK7rTD9fmEd639Gjti6eLpnyQYpnVe8uGgwVU1fHBkAKyapWoEG6VMhMntcrvgukKLIsQ",
    "dp": "ZGnmWx-Nca71z9a9vvT4g02iv3S-3kSgmhl8JST09YQwK8tfiK7nXnNMtXJi2K4dLKKnLicGtCzB6W3mXdLcP2SUOWDOeStoBt8HEBT4MrI1psCKqnBum78WkHju90rBFj99amkP6UeQy5EASAzgmKQu2nUaUnRV0lYP8LHMCkE",
    "dq": "dtpke0foFs04hPS6XYLA5lc7-1MAHfZKN4CkMAofwDqPmRQzCxpDJUk0gMWGJEdU_Lqfbg22Py44cci0dczH36NW3UU5BL86T2_SPPDOuyX7kDscrIJCdowxQCGJHGRBEozM_uTL46wu6UnUIv7m7cuGgodJyZBcdwpo6ziFink",
    "qi": "Y9KD5GaHkAYmAqpOfAQUMr71QuAAaBb0APzMuUvoEYw39PD3_vJeh9HZ15QmJ8zCX10-nlzUB-bWwvK-rGcJXbK4pArilr5MiaYv7e8h5eW2zs2_itDJ6Oebi-wVbMhg7DvUTBbkCvPhhIedE4UlDQmMYP7RhzVVs7SfmkGs_DQ",
    "p": "v1jeCPnuJQM2PW2690Q9KJk0Ulok8VFGjkcHUHVi3orKdy7y_TCIWM6ZGvgFzI6abinzYbTEPKV4wFdMAwvOWmawXj5YrsoeB44_HXJ0ak_5_iP6XXR8MLGXbd0ZqsxvAZyzMj9vyle7EN2cBod6aenI2QZoRDucPvjPwZsZotk",
    "q": "0Yv-Dj6qnvx_LL70lUnKA6MgHE_bUC4drl5ZNDDsUdUUYfxIK4G1rGU45kHGtp-Qg-Uyf9s52ywLylhcVE3jfbjOgEozlSwKyhqfXkLpMLWHqOKj9fcfYd4PWKPOgpzWsqjA6fJbBUMYo0CU2G9cWCtVodO7sBJVSIZunWrAlBc"
  },
  "tags": {
    "purpose": "unit test"
  }
}

Sample Response

Status code:: 200

{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/ImportSoftKeyTest/2eb4a15d74184c6f84159c3ca90f0f4b",
    "kty": "RSA",
    "key_ops": [
      "encrypt",
      "decrypt",
      "sign",
      "verify",
      "wrapKey",
      "unwrapKey"
    ],
    "n": "nKAwarTrOpzd1hhH4cQNdVTgRF-b0ubPD8ZNVf0UXjb62QuAk3Dn68ESThcF7SoDYRx2QVcfoMC9WCcuQUQDieJF-lvJTSer1TwH72NBovwKlHvrXqEI0a6_uVYY5n-soGt7qFZNbwQLdWWA6PrbqTLIkv6r01dcuhTiQQAn6OWEa0JbFvWfF1kILQIaSBBBaaQ4R7hZs7-VQTHGD7J1xGteof4gw2VTiwNdcE8p5UG5b6S9KQwAeET4yB4KFPwQ3TDdzxJQ89mwYVi_sgAIggN54hTq4oEKYJHBOMtFGIN0_HQ60ZSUnpOi87xNC-8VFqnv4rfTQ7nkK6XMvjMVfw",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": true,
    "created": 1493942691,
    "updated": 1493942691,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "purpose": "unit test"
  }
}

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	À compter du 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 constitué d’une WebKey et de ses attributs.
KeyImportParameters	Paramètres d’importation de clé.
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, 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	Error	Erreur du serveur du coffre de clés.
message	string	Message d’erreur.

JsonWebKey

À compter du 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, la courbe AKA SECG SECP384R1.
P-521	string	La courbe elliptique NIST P-521, la 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 des 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. Une 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 au format UTC.

KeyBundle

KeyBundle constitué 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 soutient un certificat, la valeur géré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.

KeyImportParameters

Paramètres d’importation de clé.

Nom	Type	Description
Hsm	boolean	Indique s’il faut importer en tant que clé matérielle (HSM) ou clé logicielle.
attributes	KeyAttributes	Attributs de gestion des clés.
key	JsonWebKey	Clé web Json
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’objet blob les règles de stratégie sous lesquelles la clé peut être libérée. L’objet blob doit être encodé en base64 url.
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.

Import Key - Import Key

Paramètres URI

Corps de la demande

Réponses

Exemples

Import key

Sample Request

Sample Response

Définitions

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyType

KeyAttributes

KeyBundle

KeyImportParameters

KeyReleasePolicy

KeyVaultError

Ressources supplémentaires