Partilhar via


Import Certificate - Import Certificate

Importa um certificado para um cofre de chaves especificado.
Importa um certificado válido existente, contendo uma chave privada, para o Cofre de Chaves do Azure. Esta operação requer a permissão de certificados/importação. O certificado a ser importado pode estar no formato PFX ou PEM. Se o certificado estiver no formato PEM, o arquivo PEM deve conter a chave, bem como certificados x509. O Cofre da Chave só aceitará 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
certificate-name
path True

string

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

O nome do certificado. O valor fornecido pode ser copiado globalmente com a finalidade de executar o serviço. O valor fornecido não deve incluir informações pessoais identificáveis ou confidenciais.

vaultBaseUrl
path True

string

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

api-version
query True

string

Versão da API do cliente.

Corpo do Pedido

Name Necessário Tipo Description
value True

string

Representação codificada em Base64 do objeto de certificado a ser importado. Este certificado precisa conter a chave privada.

attributes

CertificateAttributes

Os atributos do certificado (opcional).

policy

CertificatePolicy

A política de gerenciamento para o certificado.

pwd

string

Se a chave privada em base64EncodedCertificate estiver encriptada, a palavra-passe utilizada para encriptação.

tags

object

Metadados específicos do aplicativo na forma de pares chave-valor.

Respostas

Name Tipo Description
200 OK

CertificateBundle

Pacote de certificados importados para o cofre.

Other Status Codes

KeyVaultError

Resposta de erro do Key Vault descrevendo por que a operação falhou.

Exemplos

ImportCertificate

Pedido de amostra

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

Resposta da amostra

{
  "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 gerenciamento de certificado.

CertificateBundle

Um pacote de certificados consiste em um certificado (X509) mais seus 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 exclusão atualmente em vigor para certificados no cofre atual. Se contiver 'Purgeable', o certificado pode ser permanentemente eliminado por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar 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, consulte JsonWebKeyCurveName.

JsonWebKeyType

O tipo de par de chaves a ser usado para o certificado.

KeyProperties

Propriedades do par de chaves que dá suporte a um certificado.

KeyUsageType

Define como a chave do certificado pode ser usada.

KeyVaultError

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

LifetimeAction

Ação e seu gatilho que será executado pelo Key Vault ao longo da vida útil de um certificado.

SecretProperties

Propriedades da chave que dá suporte a um certificado.

SubjectAlternativeNames

O assunto alterna nomes de um objeto X509.

Trigger

Uma condição a ser satisfeita 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 gerenciamento de certificado.

Name Tipo Description
created

integer (unixtime)

Hora de criação em UTC.

enabled

boolean

Determina se o objeto está habilitado.

exp

integer (unixtime)

Data de validade em UTC.

nbf

integer (unixtime)

Não antes da data em UTC.

recoverableDays

integer (int32)

softDelete dias de retenção de dados. O valor deve ser >=7 e <=90 quando softDelete ativado, caso contrário, 0.

recoveryLevel

DeletionRecoveryLevel

Reflete o nível de recuperação de exclusão atualmente em vigor para certificados no cofre atual. Se contiver 'Purgeable', o certificado pode ser permanentemente eliminado por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar o certificado, no final do intervalo de retenção.

updated

integer (unixtime)

Última atualização em UTC.

CertificateBundle

Um pacote de certificados consiste em um certificado (X509) mais seus atributos.

Name Tipo Description
attributes

CertificateAttributes

Os atributos do certificado.

cer

string (byte)

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

A 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 do aplicativo na forma de pares chave-valor

x5t

string (base64url)

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 gerenciamento para o certificado.

pwd

string

Se a chave privada em base64EncodedCertificate estiver encriptada, a palavra-passe utilizada para encriptação.

tags

object

Metadados específicos do aplicativo na forma de pares chave-valor.

value

string

Representação codificada em Base64 do objeto de certificado a ser importado. Este certificado precisa conter a chave privada.

CertificatePolicy

Política de gestão de um certificado.

Name Tipo Description
attributes

CertificateAttributes

Os atributos do certificado.

id

string

A ID do certificado.

issuer

IssuerParameters

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

key_props

KeyProperties

Propriedades da chave que dá suporte a um certificado.

lifetime_actions

LifetimeAction[]

Ações que serão executadas pelo Key Vault durante o tempo de vida de um certificado.

secret_props

SecretProperties

Propriedades do segredo que dá suporte a um certificado.

x509_props

X509CertificateProperties

Propriedades do componente X509 de um certificado.

CertificatePolicyAction

O tipo de ação.

Valor Description
AutoRenew
EmailContacts

DeletionRecoveryLevel

Reflete o nível de recuperação de exclusão atualmente em vigor para certificados no cofre atual. Se contiver 'Purgeable', o certificado pode ser permanentemente eliminado por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar o certificado, no final do intervalo de retenção.

Valor Description
CustomizedRecoverable

Indica um estado vault no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, purga 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 estiver disponível.

CustomizedRecoverable+ProtectedSubscription

Indica um estado de cofre e assinatura no qual a exclusão é recuperável, a exclusão imediata e permanente (ou seja, a limpeza) não é permitida e na qual a assinatura em si não pode ser permanentemente cancelada 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 assinatura em si não pode ser cancelada.

CustomizedRecoverable+Purgeable

Indica um estado vault no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, purga 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 Purge seja solicitada ou a assinatura seja cancelada.

Purgeable

Indica um estado de cofre no qual a exclusão é uma operação irreversível, sem a possibilidade de recuperação. Este nível corresponde a nenhuma proteção disponível contra uma operação Delete; os dados são irremediavelmente perdidos ao aceitar uma operação de Exclusão no nível da entidade ou superior (cofre, grupo de recursos, assinatura, etc.)

Recoverable

Indica um estado vault no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, purga). 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 irá excluí-lo permanentemente após 90 dias, se não for recuperado

Recoverable+ProtectedSubscription

Indica um estado de cofre e assinatura no qual a exclusão é recuperável dentro do intervalo de retenção (90 dias), a exclusão imediata e permanente (ou seja, limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente. O sistema irá excluí-lo permanentemente após 90 dias, se não for recuperado

Recoverable+Purgeable

Indica um estado vault 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 irá excluí-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 sob esta política devem ser publicados nos logs de transparência de certificados.

cty

string

Tipo de certificado conforme suportado pelo provedor (opcional); por exemplo, 'OV-SSL', 'EV-SSL'

name

string

Nome do objeto emissor referenciado ou nomes reservados; por exemplo, 'Eu' ou 'Desconhecido'.

JsonWebKeyCurveName

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

Valor Description
P-256
P-256K
P-384
P-521

JsonWebKeyType

O tipo de par de chaves a ser usado para o certificado.

Valor Description
EC
EC-HSM
RSA
RSA-HSM
oct
oct-HSM

KeyProperties

Propriedades do par de chaves que dá suporte a um certificado.

Name Tipo Description
crv

JsonWebKeyCurveName

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

exportable

boolean

Indica se a chave privada pode ser exportada. A política de liberação deve ser fornecida ao criar a primeira versão de uma chave exportável.

key_size

integer (int32)

O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA.

kty

JsonWebKeyType

O tipo de par de chaves a ser usado para o certificado.

reuse_key

boolean

Indica se o mesmo par de chaves será usado na renovação do certificado.

KeyUsageType

Define como a chave do certificado pode ser usada.

Valor Description
cRLSign
dataEncipherment
decipherOnly
digitalSignature
encipherOnly
keyAgreement
keyCertSign
keyEncipherment
nonRepudiation

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 seu gatilho que será executado pelo Key Vault ao longo da vida útil de um certificado.

Name Tipo Description
action

Action

A ação que será executada.

trigger

Trigger

A condição que executará a ação.

SecretProperties

Propriedades da chave que dá suporte a um certificado.

Name Tipo Description
contentType

string

O tipo de mídia (tipo MIME).

SubjectAlternativeNames

O assunto alterna nomes de um objeto X509.

Name Tipo Description
dns_names

string[]

Nomes de domínio.

emails

string[]

Endereços de e-mail.

upns

string[]

Nomes principais do usuário.

Trigger

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

Name Tipo Description
days_before_expiry

integer (int32)

Dias antes do vencimento para tentar a renovação. O valor deve estar entre 1 e validity_in_months multiplicado por 27. Se validity_in_months é 36, então o valor deve estar entre 1 e 972 (36 * 27).

lifetime_percentage

integer (int32)

minimum: 1
maximum: 99

Percentagem do tempo de vida a que deve ser desencadeado. O valor deve estar entre 1 e 99.

X509CertificateProperties

Propriedades do componente X509 de um certificado.

Name Tipo Description
ekus

string[]

O uso aprimorado da chave.

key_usage

KeyUsageType[]

Define como a chave do certificado pode ser usada.

sans

SubjectAlternativeNames

Os nomes alternativos do assunto.

subject

string

O nome do assunto. Deve ser um Nome distinto X509 válido.

validity_months

integer (int32)

minimum: 0

A duração que o certificado é válido em meses.