Create Key - Create Key

Referência

Service:: Key Vault

API Version:: 7.4

Cria uma nova chave, armazena-a e, em seguida, devolve parâmetros e atributos chave ao cliente.
A operação criar chave pode ser utilizada para criar qualquer tipo de chave no Azure Key Vault. Se a chave nomeada já existir, o Azure Key Vault cria uma nova versão da chave. Requer as chaves/permissão de criação.

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

Parâmetros do URI

Name Em Necessário Tipo Description

Name	Em	Necessário	Tipo	Description
key-name	path	True	string	O nome da nova chave. O sistema irá gerar o nome da versão da nova chave. O valor fornecido pode ser copiado globalmente com o objetivo de executar o serviço. O valor fornecido não deve incluir informações pessoais identificáveis ou confidenciais. Regex pattern: `^[0-9a-zA-Z-]+$`
vaultBaseUrl	path	True	string	O nome do cofre, por exemplo https://myvault.vault.azure.net.
api-version	query	True	string	Versão da API de Cliente.

key-name

path

True

string

O nome da nova chave. O sistema irá gerar o nome da versão da nova chave. O valor fornecido pode ser copiado globalmente com o objetivo de executar o serviço. O valor fornecido não deve incluir informações pessoais identificáveis ou confidenciais.

Regex pattern: ^[0-9a-zA-Z-]+$

vaultBaseUrl

path

True

string

O nome do cofre, por exemplo https://myvault.vault.azure.net.

api-version

query

True

string

Versão da API de Cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
kty	True	JsonWebKeyType	O tipo de chave a criar. Para obter valores válidos, veja JsonWebKeyType.
attributes		KeyAttributes	Os atributos de uma chave gerida pelo serviço key vault.
crv		JsonWebKeyCurveName	Nome da curva elíptica. Para valores válidos, veja JsonWebKeyCurveName.
key_ops		JsonWebKeyOperation[]	Operações de chaves Web JSON. Para obter mais informações, consulte JsonWebKeyOperation.
key_size		integer	O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA.
public_exponent		integer	O expoente público para uma chave RSA.
release_policy		KeyReleasePolicy	As regras de política sob as quais a chave pode ser exportada.
tags		object	Metadados específicos da aplicação na forma de pares chave-valor.

Respostas

Name	Tipo	Description
200 OK	KeyBundle	Um pacote de chaves que contém o resultado do pedido de criação de chave.
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

Create key

Sample Request

HTTP

POST https://myvault.vault.azure.net//keys/CreateSoftKeyTest/create?api-version=7.4

{
  "kty": "RSA",
  "key_size": 2048,
  "key_ops": [
    "encrypt",
    "decrypt",
    "sign",
    "verify",
    "wrapKey",
    "unwrapKey"
  ],
  "attributes": {},
  "tags": {
    "purpose": "unit test",
    "test name ": "CreateGetDeleteKeyTest"
  }
}

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

Definições

Name	Description
DeletionRecoveryLevel	Reflete o nível de recuperação de eliminação atualmente em vigor para chaves no cofre atual. Se contiver "Purgeable", a chave pode ser eliminada permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover a chave, no final do intervalo de retenção.
Error	O erro do servidor do cofre de chaves.
JsonWebKey	A partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Nome da curva elíptica. Para obter valores válidos, veja JsonWebKeyCurveName.
JsonWebKeyOperation
JsonWebKeyType	JsonWebKey Key Type (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes	Os atributos de uma chave gerida pelo serviço do cofre de chaves.
KeyBundle	Um KeyBundle que consiste numa WebKey mais os respetivos atributos.
KeyCreateParameters	A chave cria parâmetros.
KeyReleasePolicy	As regras de política sob as quais a chave pode ser exportada.
KeyVaultError	A exceção de erro do cofre de chaves.

DeletionRecoveryLevel

Reflete o nível de recuperação de eliminação atualmente em vigor para chaves no cofre atual. Se contiver "Purgeable", a chave pode ser eliminada permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover a chave, no final do intervalo de retenção.

Name	Tipo	Description
CustomizedRecoverable	string	Indica um estado do cofre no qual a eliminação é recuperável sem a possibilidade de eliminação imediata e permanente (ou seja, remover quando 7<= SoftDeleteRetentionInDays < 90). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção e enquanto a subscrição ainda está disponível.
CustomizedRecoverable+ProtectedSubscription	string	Indica um cofre e um estado de subscrição em que a eliminação é recuperável, imediata e permanente (isto é, remoção) não é permitida e na qual a subscrição em si não pode ser cancelada permanentemente quando 7<= SoftDeleteRetentionInDays < 90. Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção e também reflete o facto de a própria subscrição não poder ser cancelada.
CustomizedRecoverable+Purgeable	string	Indica um estado do cofre no qual a eliminação é recuperável e que também permite a eliminação imediata e permanente (ou seja, remover quando 7<= SoftDeleteRetentionInDays < 90). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção, a menos que seja pedida uma operação de Remoção ou a subscrição seja cancelada.
Purgeable	string	Indica um estado do cofre em que a eliminação é uma operação irreversível, sem a possibilidade de recuperação. Este nível corresponde a nenhuma proteção disponível numa operação Eliminar; os dados são perdidos irremediavelmente ao aceitar uma operação Eliminar ao nível da entidade ou superior (cofre, grupo de recursos, subscrição, etc.)
Recoverable	string	Indica um estado do cofre no qual a eliminação é recuperável sem a possibilidade de eliminação imediata e permanente (ou seja, remoção). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção (90 dias) e enquanto a subscrição ainda está disponível. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado
Recoverable+ProtectedSubscription	string	Indica um cofre e um estado de subscrição no qual a eliminação é recuperável dentro do intervalo de retenção (90 dias), a eliminação imediata e permanente (ou seja, remoção) não é permitida e na qual a subscrição em si não pode ser cancelada permanentemente. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado
Recoverable+Purgeable	string	Indica um estado do cofre no qual a eliminação é recuperável e que também permite a eliminação imediata e permanente (ou seja, remoção). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção (90 dias), a menos que seja pedida uma operação de Remoção ou a subscrição seja cancelada. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado

Error

O erro do servidor do cofre de chaves.

Name	Tipo	Description
code	string	O código de erro.
innererror	Error	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

Name	Tipo	Description
crv	JsonWebKeyCurveName	Nome da curva elíptica. Para obter valores válidos, veja JsonWebKeyCurveName.
d	string	Expoente privado RSA ou o componente D de uma chave privada 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, utilizada com "Bring Your Own Key".
key_ops	string[]	Operações principais suportadas.
kid	string	Identificador de chave.
kty	JsonWebKeyType	JsonWebKey Key Type (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n	string	Módulo RSA.
p	string	Primo secreto da RSA.
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 EC.
y	string	Componente Y de uma chave pública EC.

JsonWebKeyCurveName

Nome da curva elíptica. Para obter valores válidos, veja JsonWebKeyCurveName.

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

JsonWebKeyOperation

Name	Tipo	Description
decrypt	string
encrypt	string
export	string
import	string
sign	string
unwrapKey	string
verify	string
wrapKey	string

JsonWebKeyType

JsonWebKey Key Type (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Name	Tipo	Description
EC	string	Curva elíptica.
EC-HSM	string	Curva Elíptica com uma chave privada armazenada no HSM.
RSA	string	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	string	RSA com uma chave privada armazenada no HSM.
oct	string	Sequência octeto (utilizada para representar chaves simétricas)
oct-HSM	string	Sequência octeto (utilizada para representar chaves simétricas) que é armazenada no HSM.

KeyAttributes

Os atributos de uma chave gerida pelo serviço do cofre de chaves.

Name	Tipo	Description
created	integer	Hora de criação em UTC.
enabled	boolean	Determina se o objeto está ativado.
exp	integer	Data de expiração em UTC.
exportable	boolean	Indica se a chave privada pode ser exportada. A política de versão tem de 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 data retention days. O valor deve ser >=7 e <=90 quando softDelete ativado, caso contrário 0.
recoveryLevel	DeletionRecoveryLevel	Reflete o nível de recuperação de eliminação atualmente em vigor para chaves no cofre atual. Se contiver "Purgeable", a chave pode ser eliminada permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover a chave, no final do intervalo de retenção.
updated	integer	Hora da última atualização em UTC.

KeyBundle

Um KeyBundle que consiste numa WebKey mais os respetivos atributos.

Name	Tipo	Description
attributes	KeyAttributes	Os principais atributos de gestão.
key	JsonWebKey	A chave Web Json.
managed	boolean	Verdadeiro se a duração da chave for gerida pelo cofre de chaves. Se esta for uma chave que suporta um certificado, a opção gerida será verdadeira.
release_policy	KeyReleasePolicy	As regras de política sob as quais a chave pode ser exportada.
tags	object	Metadados específicos da aplicação sob a forma de pares chave-valor.

KeyCreateParameters

A chave cria parâmetros.

Name	Tipo	Description
attributes	KeyAttributes	Os atributos de uma chave gerida pelo serviço do cofre de chaves.
crv	JsonWebKeyCurveName	Nome da curva elíptica. Para obter valores válidos, veja JsonWebKeyCurveName.
key_ops	JsonWebKeyOperation[]	Operações de chaves Web JSON. Para obter mais informações, veja JsonWebKeyOperation.
key_size	integer	O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA.
kty	JsonWebKeyType	O tipo de chave a criar. Para obter valores válidos, veja JsonWebKeyType.
public_exponent	integer	O expoente público para uma chave RSA.
release_policy	KeyReleasePolicy	As regras de política sob as quais a chave pode ser exportada.
tags	object	Metadados específicos da aplicação sob a forma de pares chave-valor.

KeyReleasePolicy

As regras de política sob as quais a chave pode ser exportada.

Name	Tipo	Valor Predefinido	Description
contentType	string	application/json; charset=utf-8	Tipo de conteúdo e versão da política de lançamento de chaves
data	string		Codificar blobs com as regras de política sob as quais a chave pode ser libertada. O blob tem de ter codificação de URL base64.
immutable	boolean		Define o estado de mutabilidade da política. Depois de marcado como imutável, este sinalizador não pode ser reposto e a política não pode ser alterada em nenhuma circunstância.

KeyVaultError

A exceção de erro do cofre de chaves.

Name	Tipo	Description
error	Error	O erro do servidor do cofre de chaves.

Create Key - Create Key

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

Create key

Sample Request

Sample Response

Definições

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyOperation

JsonWebKeyType

KeyAttributes

KeyBundle

KeyCreateParameters

KeyReleasePolicy

KeyVaultError

Recursos adicionais