Import Key - Import Key

Referencia

Servicio:: Key Vault

Versión de la API:: 7.4

Importa una clave creada externamente, la almacena y devuelve parámetros y atributos de clave al cliente.
La operación de importación de clave se puede usar para importar cualquier tipo de clave en una Key Vault de Azure. Si ya existe la clave con ese nombre, Azure Key Vault crea una nueva versión de la clave. Esta operación requiere el permiso keys/import.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description

Nombre	En	Requerido	Tipo	Description
key-name	path	True	string	Nombre de la clave importada. El valor que proporcione se puede copiar globalmente para ejecutar el servicio. El valor proporcionado no debe incluir información personal identificable o confidencial. Patrón de Regex: `^[0-9a-zA-Z-]+$`
vaultBaseUrl	path	True	string	El nombre del almacén, por ejemplo https://myvault.vault.azure.net, .
api-version	query	True	string	Versión de API del cliente.

key-name

path

True

string

Nombre de la clave importada. El valor que proporcione se puede copiar globalmente para ejecutar el servicio. El valor proporcionado no debe incluir información personal identificable o confidencial.

Patrón de Regex: ^[0-9a-zA-Z-]+$

vaultBaseUrl

path

True

string

El nombre del almacén, por ejemplo https://myvault.vault.azure.net, .

api-version

query

True

string

Versión de API del cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
key	True	JsonWebKey	Clave web Json
Hsm		boolean	Si se va a importar como una clave de hardware (HSM) o una clave de software.
attributes		KeyAttributes	Atributos de administración de claves.
release_policy		KeyReleasePolicy	Reglas de directiva con las que se puede exportar la clave.
tags		object	Metadatos específicos de la aplicación en forma de pares clave-valor.

Respuestas

Nombre	Tipo	Description
200 OK	KeyBundle	Paquete de claves importado en el almacén.
Other Status Codes	KeyVaultError	Key Vault respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

Import key

Solicitud de ejemplo

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"
  }
}

Respuesta de muestra

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"
  }
}

Definiciones

Nombre	Description
DeletionRecoveryLevel	Refleja el nivel de recuperación de eliminación actualmente en vigor para las claves del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente la clave; de lo contrario, solo el sistema puede purgar la clave, al final del intervalo de retención.
Error	Error del servidor del almacén de claves.
JsonWebKey	A partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Nombre de la curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.
JsonWebKeyType	Tipo de clave JsonWebKey (kty), tal como se define en https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes	Atributos de una clave administrada por el servicio key vault.
KeyBundle	KeyBundle que consta de un elemento WebKey más sus atributos.
KeyImportParameters	Parámetros de importación de claves.
KeyReleasePolicy	Reglas de directiva con las que se puede exportar la clave.
KeyVaultError	Excepción de error del almacén de claves.

DeletionRecoveryLevel

Refleja el nivel de recuperación de eliminación actualmente en vigor para las claves del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente la clave; de lo contrario, solo el sistema puede purgar la clave, al final del intervalo de retención.

Nombre	Tipo	Description
CustomizedRecoverable	string	Indica un estado de almacén en el que la eliminación se puede recuperar sin la posibilidad de eliminación inmediata y permanente (es decir, purgar cuando 7<= SoftDeleteRetentionInDays < 90). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención y mientras la suscripción sigue estando disponible.
CustomizedRecoverable+ProtectedSubscription	string	Indica un almacén y un estado de suscripción en el que la eliminación es recuperable, inmediata y permanente (es decir, purga) no está permitida y en la que la propia suscripción no se puede cancelar permanentemente cuando 7<= SoftDeleteRetentionInDays < 90. Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención y también refleja el hecho de que no se puede cancelar la propia suscripción.
CustomizedRecoverable+Purgeable	string	Indica un estado de almacén en el que se puede recuperar la eliminación y que también permite la eliminación inmediata y permanente (es decir, purgar cuando 7<= SoftDeleteRetentionInDays < 90). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención, a menos que se solicite una operación de purga o se cancele la suscripción.
Purgeable	string	Indica un estado de almacén en el que la eliminación es una operación irreversible, sin la posibilidad de recuperación. Este nivel no corresponde a ninguna protección disponible en una operación de eliminación; Los datos se pierden irrecuperablemente al aceptar una operación de eliminación en el nivel de entidad o superior (almacén, grupo de recursos, suscripción, etc.).
Recoverable	string	Indica un estado de almacén en el que la eliminación se puede recuperar sin la posibilidad de eliminación inmediata y permanente (es decir, purgar). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención (90 días) y mientras la suscripción sigue estando disponible. El sistema lo eliminará permanentemente después de 90 días, si no se recupera
Recoverable+ProtectedSubscription	string	Indica un almacén y un estado de suscripción en el que la eliminación se puede recuperar dentro del intervalo de retención (90 días), no se permite la eliminación inmediata y permanente (es decir, purga) y en la que la propia suscripción no se puede cancelar permanentemente. El sistema lo eliminará permanentemente después de 90 días, si no se recupera
Recoverable+Purgeable	string	Indica un estado de almacén en el que se puede recuperar la eliminación y que también permite la eliminación inmediata y permanente (es decir, purgar). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención (90 días), a menos que se solicite una operación de purga o se cancele la suscripción. El sistema lo eliminará permanentemente después de 90 días, si no se recupera

Error

Error del servidor del almacén de claves.

Nombre	Tipo	Description
code	string	Código de error.
innererror	Error	Error del servidor del almacén de claves.
message	string	El mensaje de error.

JsonWebKey

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

Nombre	Tipo	Description
crv	JsonWebKeyCurveName	Nombre de la curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.
d	string	Exponente privado RSA o componente D de una clave privada de EC.
dp	string	Parámetro de clave privada RSA.
dq	string	Parámetro de clave privada RSA.
e	string	Exponente público rsa.
k	string	Clave simétrica.
key_hsm	string	Clave protegida, usada con "Bring Your Own Key".
key_ops	string[]	Operaciones de clave admitidas.
kid	string	Identificador de clave.
kty	JsonWebKeyType	Tipo de clave JsonWebKey (kty), tal como se define en https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n	string	Módulo RSA.
p	string	Valor primo del secreto RSA.
q	string	Primo secreto RSA, con p < q.
qi	string	Parámetro de clave privada RSA.
x	string	Componente X de una clave pública de EC.
y	string	Componente Y de una clave pública de CE.

JsonWebKeyCurveName

Nombre de la curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.

Nombre	Tipo	Description
P-256	string	Curva elíptica NIST P-256, curva AKA SECG SECP256R1.
P-256K	string	Secg SECP256K1 curva elíptica.
P-384	string	La curva elíptica NIST P-384, curva AKA SECG SECP384R1.
P-521	string	Curva elíptica NIST P-521, curva AKA SECG SECP521R1.

JsonWebKeyType

Tipo de clave JsonWebKey (kty), tal como se define en https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Nombre	Tipo	Description
EC	string	Curva elíptica.
EC-HSM	string	Curva elíptica con una clave privada que se almacena en el HSM.
RSA	string	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	string	RSA con una clave privada que se almacena en el HSM.
oct	string	Secuencia de octetos (usada para representar claves simétricas)
oct-HSM	string	Secuencia de octetos (usada para representar claves simétricas) que se almacena el HSM.

KeyAttributes

Atributos de una clave administrada por el servicio key vault.

Nombre	Tipo	Description
created	integer	Hora de creación en UTC.
enabled	boolean	Determina si el objeto está habilitado.
exp	integer	Fecha de expiración en UTC.
exportable	boolean	Indica si se puede exportar la clave privada. Se debe proporcionar la directiva de versión al crear la primera versión de una clave exportable.
nbf	integer	No antes de la fecha en UTC.
recoverableDays	integer	días de retención de datos softDelete. El valor debe ser >=7 y <=90 cuando softDelete está habilitado; en caso contrario, es 0.
recoveryLevel	DeletionRecoveryLevel	Refleja el nivel de recuperación de eliminación actualmente en vigor para las claves del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente la clave; de lo contrario, solo el sistema puede purgar la clave, al final del intervalo de retención.
updated	integer	Hora de la última actualización en UTC.

KeyBundle

KeyBundle que consta de un elemento WebKey más sus atributos.

Nombre	Tipo	Description
attributes	KeyAttributes	Atributos de administración de claves.
key	JsonWebKey	Clave web Json.
managed	boolean	True si el almacén de claves administra la duración de la clave. Si se trata de una clave que respalda un certificado, se administrará como true.
release_policy	KeyReleasePolicy	Reglas de directiva con las que se puede exportar la clave.
tags	object	Metadatos específicos de la aplicación en forma de pares clave-valor.

KeyImportParameters

Parámetros de importación de claves.

Nombre	Tipo	Description
Hsm	boolean	Si se va a importar como una clave de hardware (HSM) o una clave de software.
attributes	KeyAttributes	Atributos de administración de claves.
key	JsonWebKey	Clave web Json
release_policy	KeyReleasePolicy	Reglas de directiva con las que se puede exportar la clave.
tags	object	Metadatos específicos de la aplicación en forma de pares clave-valor.

KeyReleasePolicy

Reglas de directiva con las que se puede exportar la clave.

Nombre	Tipo	Valor predeterminado	Description
contentType	string	application/json; charset=utf-8	Tipo de contenido y versión de la directiva de versión de clave
data	string		Codificación de blobs con las reglas de directiva en las que se puede liberar la clave. El blob debe estar codificado en la dirección URL base64.
immutable	boolean		Define el estado de mutabilidad de la directiva. Una vez marcado como inmutable, esta marca no se puede restablecer y la directiva no se puede cambiar en ninguna circunstancia.

KeyVaultError

Excepción de error del almacén de claves.

Nombre	Tipo	Description
error	Error	Error del servidor del almacén de claves.

Compartir a través de

Import Key - Import Key

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Import key

Solicitud de ejemplo

Respuesta de muestra

Definiciones

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyType

KeyAttributes

KeyBundle

KeyImportParameters

KeyReleasePolicy

KeyVaultError

Recursos adicionales