Import Certificate - Import Certificate

Referência

Service:: Key Vault

API Version:: 7.4

Importa um certificado para um cofre de chaves especificado.
Importa um certificado válido existente, que contém uma chave privada, para o Azure Key Vault. Esta operação requer a permissão certificados/importar. O certificado a importar pode estar no formato PFX ou PEM. Se o certificado estiver no formato PEM, o ficheiro PEM tem de conter a chave, bem como certificados x509. Key Vault aceitará apenas uma chave no formato PKCS#8.

POST {vaultBaseUrl}/certificates/{certificate-name}/import?api-version=7.4

Parâmetros do URI

Name Em Necessário Tipo Description

Name	Em	Necessário	Tipo	Description
certificate-name	path	True	string	O nome do certificado. 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.

certificate-name

path

True

string

O nome do certificado. 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
value	True	string	Representação codificada base64 do objeto de certificado a importar. Este certificado tem de conter a chave privada.
attributes		CertificateAttributes	Os atributos do certificado (opcional).
policy		CertificatePolicy	A política de gestão do certificado.
pwd		string	Se a chave privada em base64EncodedCertificate estiver encriptada, a palavra-passe utilizada para encriptação.
tags		object	Metadados específicos da aplicação na forma de pares chave-valor.

Respostas

Name	Tipo	Description
200 OK	CertificateBundle	Pacote de certificado importado para o cofre.
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

ImportCertificate

Sample Request

HTTP

POST https://myvault.vault.azure.net//certificates/importCert01/import?api-version=7.4

{
  "value": "MIIJ...",
  "pwd": "123",
  "policy": {
    "key_props": {
      "exportable": true,
      "kty": "RSA",
      "key_size": 2048,
      "reuse_key": false
    },
    "secret_props": {
      "contentType": "application/x-pkcs12"
    }
  }
}

Sample Response

Status code:: 200

{
  "id": "https://myvault.vault.azure.net/certificates/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "kid": "https://myvault.vault.azure.net/keys/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "sid": "https://myvault.vault.azure.net/secrets/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
  "cer": "MIIC...",
  "attributes": {
    "enabled": true,
    "nbf": 1430344421,
    "exp": 2208988799,
    "created": 1493938557,
    "updated": 1493938557,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "policy": {
    "id": "https://myvault.vault.azure.net/certificates/importCert01/policy",
    "key_props": {
      "exportable": true,
      "kty": "RSA",
      "key_size": 2048,
      "reuse_key": false
    },
    "secret_props": {
      "contentType": "application/x-pkcs12"
    },
    "x509_props": {
      "subject": "CN=KeyVaultTest",
      "ekus": [],
      "key_usage": [],
      "validity_months": 297
    },
    "lifetime_actions": [
      {
        "trigger": {
          "lifetime_percentage": 80
        },
        "action": {
          "action_type": "EmailContacts"
        }
      }
    ],
    "issuer": {
      "name": "Unknown"
    },
    "attributes": {
      "enabled": true,
      "created": 1493938557,
      "updated": 1493938557
    }
  }
}

Definições

Name	Description
Action	A ação que será executada.
CertificateAttributes	Os atributos de gestão de certificados.
CertificateBundle	Um pacote de certificados consiste num certificado (X509) mais os respetivos atributos.
CertificateImportParameters	Os parâmetros de importação do certificado.
CertificatePolicy	Política de gestão de um certificado.
CertificatePolicyAction	O tipo de ação.
DeletionRecoveryLevel	Reflete o nível de recuperação de eliminação atualmente em vigor para certificados no cofre atual. Se contiver "Removível", o certificado pode ser eliminado permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover o certificado, no final do intervalo de retenção.
Error	O erro do servidor do cofre de chaves.
IssuerParameters	Parâmetros para o emissor do componente X509 de um certificado.
JsonWebKeyCurveName	Nome da curva elíptica. Para valores válidos, veja JsonWebKeyCurveName.
JsonWebKeyType	O tipo de par de chaves a utilizar para o certificado.
KeyProperties	Propriedades do par de chaves que apoia um certificado.
KeyUsageType	Define como a chave do certificado pode ser utilizada.
KeyVaultError	A exceção de erro do cofre de chaves.
LifetimeAction	Ação e o respetivo acionador que serão efetuados por Key Vault ao longo da duração de um certificado.
SecretProperties	Propriedades da chave que apoia um certificado.
SubjectAlternativeNames	Os nomes alternativos do assunto de um objeto X509.
Trigger	Uma condição a satisfazer para que uma ação seja executada.
X509CertificateProperties	Propriedades do componente X509 de um certificado.

Action

A ação que será executada.

Name	Tipo	Description
action_type	CertificatePolicyAction	O tipo de ação.

CertificateAttributes

Os atributos de gestão de certificados.

Name	Tipo	Description
created	integer	Tempo de criação em UTC.
enabled	boolean	Determina se o objeto está ativado.
exp	integer	Data de expiração em UTC.
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 certificados no cofre atual. Se contiver "Removível", o certificado pode ser eliminado permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover o certificado, no final do intervalo de retenção.
updated	integer	Hora da última atualização em UTC.

CertificateBundle

Um pacote de certificados consiste num certificado (X509) mais os respetivos atributos.

Name	Tipo	Description
attributes	CertificateAttributes	Os atributos do certificado.
cer	string	Conteúdo CER do certificado x509.
contentType	string	O tipo de conteúdo do segredo. Por exemplo, "application/x-pem-file" ou "application/x-pkcs12",
id	string	O ID do certificado.
kid	string	O ID da chave.
policy	CertificatePolicy	A política de gestão.
sid	string	O ID secreto.
tags	object	Metadados específicos da aplicação na forma de pares chave-valor
x5t	string	Impressão digital do certificado.

CertificateImportParameters

Os parâmetros de importação do certificado.

Name	Tipo	Description
attributes	CertificateAttributes	Os atributos do certificado (opcional).
policy	CertificatePolicy	A política de gestão do certificado.
pwd	string	Se a chave privada em base64EncodedCertificate estiver encriptada, a palavra-passe utilizada para encriptação.
tags	object	Metadados específicos da aplicação na forma de pares chave-valor.
value	string	Representação codificada base64 do objeto de certificado a importar. Este certificado tem de conter a chave privada.

CertificatePolicy

Política de gestão de um certificado.

Name	Tipo	Description
attributes	CertificateAttributes	Os atributos do certificado.
id	string	O ID do certificado.
issuer	IssuerParameters	Parâmetros para o emissor do componente X509 de um certificado.
key_props	KeyProperties	Propriedades da chave que apoia um certificado.
lifetime_actions	LifetimeAction[]	Ações que serão executadas por Key Vault ao longo da duração de um certificado.
secret_props	SecretProperties	Propriedades do segredo que apoia um certificado.
x509_props	X509CertificateProperties	Propriedades do componente X509 de um certificado.

CertificatePolicyAction

O tipo de ação.

Name	Tipo	Description
AutoRenew	string
EmailContacts	string

DeletionRecoveryLevel

Reflete o nível de recuperação de eliminação atualmente em vigor para certificados no cofre atual. Se contiver "Removível", o certificado pode ser eliminado permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover o certificado, 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 estado de subscrição no qual a eliminação é recuperável, imediata e permanente (ou seja, remoção) não é permitida e em que 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 não corresponde a nenhuma proteção disponível numa operação Eliminar; os dados são irremediavelmente perdidos ao aceitar uma operação Delete 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 estado do cofre e da subscrição em que 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.

IssuerParameters

Parâmetros para o emissor do componente X509 de um certificado.

Name	Tipo	Description
cert_transparency	boolean	Indica se os certificados gerados ao abrigo desta política devem ser publicados nos registos de transparência de certificados.
cty	string	Tipo de certificado suportado pelo fornecedor (opcional); por exemplo, "OV-SSL", "EV-SSL"
name	string	Nome do objeto do emissor referenciado ou nomes reservados; por exemplo, "Auto" ou "Desconhecido".

JsonWebKeyCurveName

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

Name	Tipo	Description
P-256	string
P-256K	string
P-384	string
P-521	string

JsonWebKeyType

O tipo de par de chaves a utilizar para o certificado.

Name	Tipo	Description
EC	string
EC-HSM	string
RSA	string
RSA-HSM	string
oct	string
oct-HSM	string

KeyProperties

Propriedades do par de chaves que apoia um certificado.

Name	Tipo	Description
crv	JsonWebKeyCurveName	Nome da curva elíptica. Para valores válidos, veja JsonWebKeyCurveName.
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.
key_size	integer	O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA.
kty	JsonWebKeyType	O tipo de par de chaves a utilizar para o certificado.
reuse_key	boolean	Indica se o mesmo par de chaves será utilizado na renovação do certificado.

KeyUsageType

Define como a chave do certificado pode ser utilizada.

Name	Tipo	Description
cRLSign	string
dataEncipherment	string
decipherOnly	string
digitalSignature	string
encipherOnly	string
keyAgreement	string
keyCertSign	string
keyEncipherment	string
nonRepudiation	string

KeyVaultError

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

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

LifetimeAction

Ação e o respetivo acionador que serão efetuados por Key Vault ao longo da duração de um certificado.

Name	Tipo	Description
action	Action	A ação que será executada.
trigger	Trigger	A condição que irá executar a ação.

SecretProperties

Propriedades da chave que apoia um certificado.

Name	Tipo	Description
contentType	string	O tipo de suporte de dados (tipo MIME).

SubjectAlternativeNames

Os nomes alternativos do assunto de um objeto X509.

Name	Tipo	Description
dns_names	string[]	Nomes de domínio.
emails	string[]	Email endereços.
upns	string[]	Nomes principais de utilizador.

Trigger

Uma condição a satisfazer para que uma ação seja executada.

Name	Tipo	Description
days_before_expiry	integer	Dias antes de expirar para tentar a renovação. O valor deve estar entre 1 e validity_in_months multiplicado por 27. Se validity_in_months for 36, o valor deve ser entre 1 e 972 (36 * 27).
lifetime_percentage	integer	Percentagem de duração a acionar. O valor deve estar entre 1 e 99.

X509CertificateProperties

Propriedades do componente X509 de um certificado.

Name	Tipo	Description
ekus	string[]	A utilização avançada da chave.
key_usage	KeyUsageType[]	Define como a chave do certificado pode ser utilizada.
sans	SubjectAlternativeNames	Os nomes alternativos do assunto.
subject	string	O nome do requerente. Deve ser um Nome Único X509 válido.
validity_months	integer	A duração em que o certificado é válido em meses.

Import Certificate - Import Certificate

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

ImportCertificate

Sample Request

Sample Response

Definições

Action

CertificateAttributes

CertificateBundle

CertificateImportParameters

CertificatePolicy

CertificatePolicyAction

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties

Recursos adicionais