Import Key - Import Key
Importa uma chave criada externamente, armazena-a e retorna os parâmetros de chaves e atributos para o cliente.
A operação de importação de chave pode ser usada para importar qualquer tipo de chave para um Key Vault do Azure. Se a chave denominada já existir, o Cofre de Chaves do Azure criará uma nova versão da chave. Essa operação requer a permissão de importação/chaves.
PUT {vaultBaseUrl}/keys/{key-name}?api-version=7.4
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
key-name
|
path | True |
string |
Nome da chave importada. O valor fornecido pode ser copiado globalmente para fins de execução do serviço. O valor fornecido não deve incluir informações pessoais identificáveis ou confidenciais. Regex pattern: |
vault
|
path | True |
string |
O nome do cofre, por exemplo https://myvault.vault.azure.net, . |
api-version
|
query | True |
string |
Versão de API do cliente. |
Corpo da solicitação
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
key | True |
A chave da Web Json |
|
Hsm |
boolean |
Se é necessário importar como uma chave de hardware (HSM) ou uma chave de software. |
|
attributes |
Os atributos de gerenciamento de chaves. |
||
release_policy |
As regras de política sob as quais a chave pode ser exportada. |
||
tags |
object |
Metadados específicos do aplicativo na forma de pares chave-valor. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Pacote de chaves importado para o cofre. |
|
Other Status Codes |
Key Vault resposta de erro que descreve por que a operação falhou. |
Exemplos
Import key
Sample Request
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
{
"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"
}
}
Definições
Nome | Description |
---|---|
Deletion |
Reflete o nível de recuperação de exclusão atualmente em vigor para chaves no cofre atual. Se contiver "Purgável", a chave poderá ser excluída permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar a chave no final do intervalo de retenção. |
Error |
O erro do servidor do cofre de chaves. |
Json |
A partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
Json |
Nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. |
Json |
Tipo de chave JsonWebKey (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. |
Key |
Os atributos de uma chave gerenciada pelo serviço do cofre de chaves. |
Key |
Um KeyBundle que consiste em uma WebKey mais seus atributos. |
Key |
Os parâmetros de importação de chave. |
Key |
As regras de política sob as quais a chave pode ser exportada. |
Key |
A exceção de erro do cofre de chaves. |
DeletionRecoveryLevel
Reflete o nível de recuperação de exclusão atualmente em vigor para chaves no cofre atual. Se contiver "Purgável", a chave poderá ser excluída permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar a chave no final do intervalo de retenção.
Nome | Tipo | Description |
---|---|---|
CustomizedRecoverable |
string |
Indica um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpeza quando 7<= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e enquanto a assinatura ainda está disponível. |
CustomizedRecoverable+ProtectedSubscription |
string |
Indica um cofre e um estado de assinatura no qual a exclusão é recuperável, exclusão imediata e permanente (ou seja, limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente quando 7<= SoftDeleteRetentionInDays < 90. Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e também reflete o fato de que a própria assinatura não pode ser cancelada. |
CustomizedRecoverable+Purgeable |
string |
Indica um estado de cofre no qual a exclusão é recuperável e que também permite exclusão imediata e permanente (ou seja, limpeza quando 7<= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção, a menos que uma operação de limpeza seja solicitada ou a assinatura seja cancelada. |
Purgeable |
string |
Indica um estado de cofre no qual a exclusão é uma operação irreversível, sem a possibilidade de recuperação. Esse nível corresponde a nenhuma proteção disponível em uma operação Delete; os dados são irremediavelmente perdidos ao aceitar uma operação Delete no nível da entidade ou superior (cofre, grupo de recursos, assinatura etc.) |
Recoverable |
string |
Indica um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpeza). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias) e enquanto a assinatura ainda estiver disponível. O sistema o excluirá permanentemente após 90 dias, se não for recuperado |
Recoverable+ProtectedSubscription |
string |
Indica um cofre e um estado de assinatura no qual a exclusão é recuperável dentro do intervalo de retenção (90 dias), a exclusão imediata e permanente (ou seja, a limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente. O sistema o excluirá permanentemente após 90 dias, se não for recuperado |
Recoverable+Purgeable |
string |
Indica um estado de cofre no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, limpeza). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias), a menos que uma operação de limpeza seja solicitada ou a assinatura seja cancelada. O sistema o excluirá permanentemente após 90 dias, se não for recuperado |
Error
O erro do servidor do cofre de chaves.
Nome | Tipo | Description |
---|---|---|
code |
string |
O código de erro. |
innererror |
O erro do servidor do cofre de chaves. |
|
message |
string |
A mensagem de erro. |
JsonWebKey
A partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
Nome | Tipo | Description |
---|---|---|
crv |
Nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. |
|
d |
string |
Expoente privado RSA ou o componente D de uma chave privada de EC. |
dp |
string |
Parâmetro de chave privada RSA. |
dq |
string |
Parâmetro de chave privada RSA. |
e |
string |
Expoente público RSA. |
k |
string |
Chave simétrica. |
key_hsm |
string |
Chave protegida, usada com 'Traga sua própria chave'. |
key_ops |
string[] |
Operações de chave com suporte. |
kid |
string |
Identificador de chave. |
kty |
Tipo de chave JsonWebKey (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. |
|
n |
string |
Módulo RSA. |
p |
string |
Segredo do RSA primo. |
q |
string |
RSA secret prime, with p < q. |
qi |
string |
Parâmetro de chave privada RSA. |
x |
string |
Componente X de uma chave pública de EC. |
y |
string |
Componente Y de uma chave pública de EC. |
JsonWebKeyCurveName
Nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName.
Nome | Tipo | Description |
---|---|---|
P-256 |
string |
A curva elíptica NIST P-256, também conhecida como curva SECG SECP256R1. |
P-256K |
string |
O SECG SECP256K1 curva elíptica. |
P-384 |
string |
A curva elíptica NIST P-384, também conhecida como curva SECG SECP384R1. |
P-521 |
string |
A curva elíptica NIST P-521, também conhecida como curva SECG SECP521R1. |
JsonWebKeyType
Tipo de chave JsonWebKey (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
Nome | Tipo | Description |
---|---|---|
EC |
string |
Curva elíptica. |
EC-HSM |
string |
Curva elíptica com uma chave privada que é armazenada no HSM. |
RSA |
string |
|
RSA-HSM |
string |
RSA com uma chave privada que é armazenada no HSM. |
oct |
string |
Sequência de octeto (usada para representar chaves simétricas) |
oct-HSM |
string |
Sequência de octeto (usada para representar chaves simétricas) que é armazenada no HSM. |
KeyAttributes
Os atributos de uma chave gerenciada pelo serviço do cofre de chaves.
Nome | Tipo | Description |
---|---|---|
created |
integer |
Tempo de criação em UTC. |
enabled |
boolean |
Determina se o objeto está habilitado. |
exp |
integer |
Data de expiração em UTC. |
exportable |
boolean |
Indica se a chave privada pode ser exportada. A política de versão deve ser fornecida ao criar a primeira versão de uma chave exportável. |
nbf |
integer |
Não antes da data em UTC. |
recoverableDays |
integer |
softDelete dias de retenção de dados. O valor deve ser >=7 e <=90 quando softDelete habilitado, caso contrário, 0. |
recoveryLevel |
Reflete o nível de recuperação de exclusão atualmente em vigor para chaves no cofre atual. Se contiver "Purgável", a chave poderá ser excluída permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar a chave no final do intervalo de retenção. |
|
updated |
integer |
Hora da última atualização em UTC. |
KeyBundle
Um KeyBundle que consiste em uma WebKey mais seus atributos.
Nome | Tipo | Description |
---|---|---|
attributes |
Os atributos de gerenciamento de chaves. |
|
key |
A chave da Web Json. |
|
managed |
boolean |
True se o tempo de vida da chave for gerenciado pelo cofre de chaves. Se essa for uma chave que faz backup de um certificado, a gerenciada será verdadeira. |
release_policy |
As regras de política sob as quais a chave pode ser exportada. |
|
tags |
object |
Metadados específicos do aplicativo na forma de pares chave-valor. |
KeyImportParameters
Os parâmetros de importação de chave.
Nome | Tipo | Description |
---|---|---|
Hsm |
boolean |
Se é necessário importar como uma chave de hardware (HSM) ou uma chave de software. |
attributes |
Os atributos de gerenciamento de chaves. |
|
key |
A chave da Web Json |
|
release_policy |
As regras de política sob as quais a chave pode ser exportada. |
|
tags |
object |
Metadados específicos do aplicativo na forma de pares chave-valor. |
KeyReleasePolicy
As regras de política sob as quais a chave pode ser exportada.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
contentType |
string |
application/json; charset=utf-8 |
Tipo de conteúdo e versão da política de versão de chave |
data |
string |
Codificação de blob das regras de política sob as quais a chave pode ser liberada. O blob deve ser codificado em URL base64. |
|
immutable |
boolean |
Define o estado de mutabilidade da política. Depois de marcado como imutável, esse sinalizador não pode ser redefinido e a política não pode ser alterada em nenhuma circunstância. |
KeyVaultError
A exceção de erro do cofre de chaves.
Nome | Tipo | Description |
---|---|---|
error |
O erro do servidor do cofre de chaves. |