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 Azure Key Vault. Essa operação requer a permissão certificados/importar. O certificado a ser importado deve estar no formato PFX ou PEM. Se o certificado estiver no formato PEM, o arquivo PEM deverá conter a chave, bem como os certificados x509. Key Vault aceitará apenas uma chave no formato PKCS nº 8.

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

Parâmetros de URI

Name In Required Type Description
certificate-name
path True
  • string

O nome do certificado. O valor fornecido pode ser copiado globalmente para a finalidade 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 de API do cliente.

Corpo da solicitação

Name Required Type Description
value True
  • string

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

attributes

Os atributos do certificado (opcional).

policy

A política de gerenciamento do certificado.

pwd
  • string

Se a chave privada no base64EncodedCertificate for criptografada, a senha será usada para criptografia.

tags
  • object

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

Respostas

Name Type Description
200 OK

Pacote de certificado importado para o cofre.

Other Status Codes

Key Vault resposta de erro que descreve por que a operação falhou.

Exemplos

ImportCertificate

Sample Request

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

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

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

Action

A ação que será executada.

ActionType

O tipo da ação.

CertificateAttributes

Os atributos de gerenciamento de certificado.

CertificateBundle

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

CertificateImportParameters

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

CertificatePolicy

Política de gerenciamento de um certificado.

DeletionRecoveryLevel

Reflete o nível de recuperação de exclusão atualmente em vigor para certificados no cofre atual. Se ele contiver "Purgável", o certificado poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá 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 obter 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 faz backup de um certificado.

KeyVaultError

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

LifetimeAction

Ação e seu gatilho que serão executados por Key Vault ao longo do tempo de vida de um certificado.

SecretProperties

Propriedades da chave que está fazendo backup de um certificado.

SubjectAlternativeNames

Os nomes alternativos de assunto de um objeto X509.

Trigger

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

X509CertificateProperties

Propriedades do componente X509 de um certificado.

Action

A ação que será executada.

Name Type Description
action_type

O tipo da ação.

ActionType

O tipo da ação.

Name Type Description
AutoRenew
  • string
EmailContacts
  • string

CertificateAttributes

Os atributos de gerenciamento de certificado.

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

nbf
  • integer

Não antes da data em UTC.

recoverableDays
  • integer

dias de retenção de dados softDelete. 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 certificados no cofre atual. Se ele contiver "Purgável", o certificado poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar o certificado no final do intervalo de retenção.

updated
  • integer

Hora da última atualização em UTC.

CertificateBundle

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

Name Type Description
attributes

Os atributos de certificado.

cer
  • string

Conteúdo cer do certificado x509.

contentType
  • string

O tipo de conteúdo do segredo. ex. 'application/x-pem-file' ou 'application/x-pkcs12',

id
  • string

A ID do certificado.

kid
  • string

A ID da chave.

policy

A política de gerenciamento.

sid
  • string

A ID secreta.

tags
  • object

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

x5t
  • string

Impressão digital do certificado.

CertificateImportParameters

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

Name Type Description
attributes

Os atributos do certificado (opcional).

policy

A política de gerenciamento do certificado.

pwd
  • string

Se a chave privada no base64EncodedCertificate for criptografada, a senha será usada para criptografia.

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. Esse certificado precisa conter a chave privada.

CertificatePolicy

Política de gerenciamento de um certificado.

Name Type Description
attributes

Os atributos de certificado.

id
  • string

A ID do certificado.

issuer

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

key_props

Propriedades da chave que está fazendo backup de um certificado.

lifetime_actions

Ações que serão executadas por Key Vault ao longo do tempo de vida de um certificado.

secret_props

Propriedades do segredo que está fazendo backup de um certificado.

x509_props

Propriedades do componente X509 de um certificado.

DeletionRecoveryLevel

Reflete o nível de recuperação de exclusão atualmente em vigor para certificados no cofre atual. Se ele contiver "Purgável", o certificado poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar o certificado no final do intervalo de retenção.

Name Type Description
CustomizedRecoverable
  • string

Denota um estado do 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

Denota um cofre e um estado de assinatura no qual a exclusão é recuperável, 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 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
  • string

Denota um estado do cofre no qual a exclusão é recuperável e que também permite a 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

Denota um estado do 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 de entidade ou superior (cofre, grupo de recursos, assinatura etc.)

Recoverable
  • string

Denota um estado do 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, 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

Denota um estado do 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.

Name Type Description
code
  • string

O código de erro.

innererror

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 Type Description
cert_transparency
  • boolean

Indica se os certificados gerados nessa política devem ser publicados nos logs de transparência do certificado.

cty
  • string

Tipo de certificado conforme o suporte do provedor (opcional); por exemplo, 'OV-SSL', 'EV-SSL'

name
  • string

Nome do objeto emissor referenciado ou nomes reservados; por exemplo, 'Self' ou 'Unknown'.

JsonWebKeyCurveName

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

Name Type Description
P-256
  • string
P-256K
  • string
P-384
  • string
P-521
  • string

JsonWebKeyType

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

Name Type Description
EC
  • string
EC-HSM
  • string
RSA
  • string
RSA-HSM
  • string
oct
  • string
oct-HSM
  • string

KeyProperties

Propriedades do par de chaves que faz backup de um certificado.

Name Type Description
crv

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

exportable
  • boolean

Indica se a chave privada pode ser exportada. A política de versão deve ser fornecida ao criar a 1ª 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

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.

KeyVaultError

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

Name Type Description
error

O erro do servidor do cofre de chaves.

LifetimeAction

Ação e seu gatilho que serão executados por Key Vault ao longo do tempo de vida de um certificado.

Name Type Description
action

A ação que será executada.

trigger

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

SecretProperties

Propriedades da chave que está fazendo backup de um certificado.

Name Type Description
contentType
  • string

O tipo de mídia (tipo MIME).

SubjectAlternativeNames

Os nomes alternativos de assunto de um objeto X509.

Name Type Description
dns_names
  • string[]

Nomes de domínio.

emails
  • string[]

Endereços de email.

upns
  • string[]

Nomes de entidade de usuário.

Trigger

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

Name Type Description
days_before_expiry
  • integer

Dias antes da expiração 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 deverá estar entre 1 e 972 (36 * 27).

lifetime_percentage
  • integer

Percentual de tempo de vida no qual disparar. O valor deve estar entre 1 e 99.

X509CertificateProperties

Propriedades do componente X509 de um certificado.

Name Type Description
ekus
  • string[]

O uso aprimorado da chave.

key_usage
  • string[]

Lista de usos de chave.

sans

Os nomes alternativos do assunto.

subject
  • string

O nome da entidade. Deve ser um nome X509 diferenciado válido.

validity_months
  • integer

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