Create Certificate - Create Certificate

Serviço:: Key Vault

Versão da API:: 2025-07-01

Cria um novo certificado.
Se esta for a primeira versão, o recurso de certificado será criado. Essa operação requer a permissão de criação/certificados.

POST {vaultBaseUrl}/certificates/{certificate-name}/create?api-version=2025-07-01

Parâmetros de URI

Nome	Em	Obrigató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 (uri)
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
attributes	CertificateAttributes	Os atributos do certificado (opcional).
policy	CertificatePolicy	A política de gerenciamento do certificado.
preserveCertOrder	boolean	Especifica se a cadeia de certificados preserva sua ordem original. O valor padrão é false, que define o certificado folha no índice 0.
tags	object	Metadados específicos do aplicativo na forma de pares de chave-valor.

Respostas

Nome	Tipo	Description
202 Accepted	CertificateOperation	A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído.
Other Status Codes	KeyVaultError	Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
https://vault.azure.net/.default

Exemplos

CreateCertificate

Solicitação de exemplo

HTTP

POST https://myvault.vault.azure.net//certificates/selfSignedCert01/create?api-version=2025-07-01

{
  "policy": {
    "key_props": {
      "exportable": true,
      "kty": "RSA",
      "key_size": 2048,
      "reuse_key": false
    },
    "secret_props": {
      "contentType": "application/x-pkcs12"
    },
    "x509_props": {
      "subject": "CN=*.microsoft.com",
      "sans": {
        "dns_names": [
          "onedrive.microsoft.com",
          "xbox.microsoft.com"
        ]
      }
    },
    "issuer": {
      "name": "Self"
    }
  }
}

Resposta de exemplo

Código de status:: 202

{
  "id": "https://myvault.vault.azure.net/certificates/selfSignedCert01/pending",
  "issuer": {
    "name": "Self"
  },
  "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=",
  "cancellation_requested": false,
  "status": "inProgress",
  "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.",
  "request_id": "6faacd568ab049a2803861e8dd3ae21f"
}

Definições

Nome	Description
Action	A ação que será executada.
CertificateAttributes	Os atributos de gerenciamento de certificados.
CertificateCreateParameters	Os parâmetros de criação do certificado.
CertificateOperation	Uma operação de certificado é retornada no caso de solicitações assíncronas.
CertificatePolicy	Política de gerenciamento para um certificado.
CertificatePolicyAction	O tipo da ação.
DeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se contiver 'Purgeable', o segredo poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema pode limpar o segredo, no final do intervalo de retenção.
Error
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 dão suporte a um certificado.
KeyUsageType	Usos com suporte de uma chave de certificado.
KeyVaultError	A exceção de erro do cofre de chaves.
LifetimeAction	Ação e seu gatilho que será executado pelo Key Vault durante o tempo de vida de um certificado.
SecretProperties	Propriedades da chave que dá suporte a um certificado.
SubjectAlternativeNames	Os nomes alternativos do assunto 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

Objeto

A ação que será executada.

Nome	Tipo	Description
action_type	CertificatePolicyAction	O tipo da ação.

CertificateAttributes

Objeto

Os atributos de gerenciamento de certificados.

Nome	Tipo	Description
created	integer (unixtime)	Tempo de criação em UTC.
enabled	boolean	Determina se o objeto está habilitado.
exp	integer (unixtime)	Data de expiração em UTC.
nbf	integer (unixtime)	Não antes da data em UTC.
recoverableDays	integer (int32)	dias de retenção de dados softDelete. O valor deve ser >=7 e <=90 quando softDelete habilitado, 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 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 (unixtime)	Hora da última atualização em UTC.

CertificateCreateParameters

Objeto

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

Nome	Tipo	Description
attributes	CertificateAttributes	Os atributos do certificado (opcional).
policy	CertificatePolicy	A política de gerenciamento do certificado.
preserveCertOrder	boolean	Especifica se a cadeia de certificados preserva sua ordem original. O valor padrão é false, que define o certificado folha no índice 0.
tags	object	Metadados específicos do aplicativo na forma de pares de chave-valor.

CertificateOperation

Objeto

Uma operação de certificado é retornada no caso de solicitações assíncronas.

Nome	Tipo	Description
cancellation_requested	boolean	Indica se o cancelamento foi solicitado na operação de certificado.
csr	string (byte)	A solicitação de assinatura de certificado (CSR) que está sendo usada na operação de certificado.
error	Error	Erro encontrado, se houver, durante a operação do certificado.
id	string	A ID do certificado.
issuer	IssuerParameters	Parâmetros para o emissor do componente X509 de um certificado.
preserveCertOrder	boolean	Especifica se a cadeia de certificados preserva sua ordem original. O valor padrão é false, que define o certificado folha no índice 0.
request_id	string	Identificador para a operação de certificado.
status	string	Status da operação de certificado.
status_details	string	Os detalhes do status da operação de certificado.
target	string	Local que contém o resultado da operação de certificado.

CertificatePolicy

Objeto

Política de gerenciamento para um certificado.

Nome	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

Enumeração

O tipo da ação.

Valor	Description
EmailContacts	Uma política de certificado que enviará por e-mail os contatos do certificado.
AutoRenew	Uma política de certificado que renovará automaticamente um certificado.

DeletionRecoveryLevel

Enumeração

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

Valor	Description
Purgeable	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 contra 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+Purgeable	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 irá excluí-lo permanentemente após 90 dias, se não for recuperado
Recoverable	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 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 no 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
CustomizedRecoverable+Purgeable	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, limpar 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.
CustomizedRecoverable	Indica um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpar 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, limpeza) não é permitida e no 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.

Error

Objeto

Nome	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

Objeto

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

Nome	Tipo	Description
cert_transparency	boolean	Indica se os certificados gerados sob essa 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, 'Self' ou 'Unknown'.

JsonWebKeyCurveName

Enumeração

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

Valor	Description
P-256	A curva elíptica NIST P-256, também conhecida como curva SECG SECP256R1.
P-384	A curva elíptica NIST P-384, também conhecida como curva SECG, SECP384R1.
P-521	A curva elíptica NIST P-521, também conhecida como curva SECG SECP521R1.
P-256K	O SECG SECP256K1 curva elíptica.

JsonWebKeyType

Enumeração

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

Valor	Description
EC	Curva elíptica.
EC-HSM	Curva elíptica com uma chave privada que não pode ser exportada do HSM.
RSA	RSA (https://tools.ietf.org/html/rfc3447).
RSA-HSM	RSA com uma chave privada que não pode ser exportada do HSM.
oct	Sequência de octetos (usada para representar chaves simétricas).
oct-HSM	Sequência de octeto com uma chave privada que não pode ser exportada do HSM.

KeyProperties

Objeto

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

Nome	Tipo	Description
crv	JsonWebKeyCurveName	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 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

Enumeração

Usos com suporte de uma chave de certificado.

Valor	Description
digitalSignature	Indica que a chave do certificado pode ser usada como uma assinatura digital.
nonRepudiation	Indica que a chave de certificado pode ser usada para autenticação.
keyEncipherment	Indica que a chave de certificado pode ser usada para criptografia de chave.
dataEncipherment	Indica que a chave de certificado pode ser usada para criptografia de dados.
keyAgreement	Indica que a chave de certificado pode ser usada para determinar a concordância de chaves, como uma chave criada usando o algoritmo de concordância de chaves Diffie-Hellman.
keyCertSign	Indica que a chave de certificado pode ser usada para assinar certificados.
cRLSign	Indica que a chave de certificado pode ser usada para assinar uma lista de revogação de certificados.
encipherOnly	Indica que a chave de certificado pode ser usada somente para criptografia.
decipherOnly	Indica que a chave de certificado pode ser usada apenas para descriptografia.

KeyVaultError

Objeto

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

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

LifetimeAction

Objeto

Ação e seu gatilho que será executado pelo Key Vault durante o tempo de vida de um certificado.

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

SecretProperties

Objeto

Propriedades da chave que dá suporte a um certificado.

Nome	Tipo	Description
contentType	string	O tipo de mídia (tipo MIME).

SubjectAlternativeNames

Objeto

Os nomes alternativos do assunto de um objeto X509.

Nome	Tipo	Description
dns_names	string[]	Nomes de domínio.
emails	string[]	Endereços de email.
ipAddresses	string[]	Endereços IP; suporta IPv4 e IPv6.
upns	string[]	Nomes principais de usuário.
uris	string[]	Identificadores Uniformes de Recursos.

Trigger

Objeto

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

Nome	Tipo	Description
days_before_expiry	integer (int32)	Dias antes do vencimento para tentar renovar. O valor deve estar entre 1 e validity_in_months multiplicado por 27. Se validity_in_months for 36, o valor deve estar entre 1 e 972 (36 * 27).
lifetime_percentage	integer (int32) minimum: 1 maximum: 99	Porcentagem de tempo de vida em que acionar. O valor deve estar entre 1 e 99.

X509CertificateProperties

Objeto

Propriedades do componente X509 de um certificado.

Nome	Tipo	Description
ekus	string[]	O uso aprimorado da chave.
key_usage	KeyUsageType[]	Define como a chave do certificado pode ser usada.
sans	SubjectAlternativeNames	O assunto nomes alternativos.
subject	string	O nome do assunto. Deve ser um Nome distinto X509 válido.
validity_months	integer (int32) minimum: 0	A duração da validade do certificado em meses.

Compartilhar via

Create Certificate - Create Certificate

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

OAuth2Auth

Escopos

Exemplos

CreateCertificate

Solicitação de exemplo

Resposta de exemplo

Definições

Action

CertificateAttributes

CertificateCreateParameters

CertificateOperation

CertificatePolicy

CertificatePolicyAction

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties