Create Certificate - Create Certificate

  • Referencia
Servicio:
Key Vault
Versión de la API:
7.4

Crea un nuevo certificado.
Si se trata de la primera versión, se crea el recurso de certificado. Esta operación requiere el permiso de creación de certificados.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
certificate-name
 path True

string

Nombre del certificado. El valor que proporcione puede copiarse globalmente para ejecutar el servicio. El valor proporcionado no debe incluir información personal identificable o confidencial.

Patrón de Regex: ^[0-9a-zA-Z-]+$
vaultBaseUrl
 path True

string

El nombre del almacén, por ejemplo https://myvault.vault.azure.net, .
api-version
 query True

string

Versión de API del cliente.

Cuerpo de la solicitud

Nombre Tipo Description
attributes

CertificateAttributes

Atributos del certificado (opcional).
policy

CertificatePolicy

Directiva de administración del certificado.
tags

object

Metadatos específicos de la aplicación en forma de pares clave-valor.

Respuestas

Nombre Tipo Description
202 Accepted

CertificateOperation

Conjunto de certificados creado.
Other Status Codes

KeyVaultError

Key Vault respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

CreateCertificate

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
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"
}

Definiciones

Nombre Description
Action

Acción que se ejecutará.
CertificateAttributes

Atributos de administración de certificados.
CertificateCreateParameters

Parámetros de creación de certificados.
CertificateOperation

Se devuelve una operación de certificado en caso de solicitudes asincrónicas.
CertificatePolicy

Directiva de administración para un certificado.
CertificatePolicyAction

El tipo de la acción.
DeletionRecoveryLevel

Refleja el nivel de recuperación de eliminación actualmente en vigor para los certificados del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente el certificado; de lo contrario, solo el sistema puede purgar el certificado, al final del intervalo de retención.
Error

Error del servidor del almacén de claves.
IssuerParameters

Parámetros para el emisor del componente X509 de un certificado.
JsonWebKeyCurveName

Nombre de curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.
JsonWebKeyType

Tipo de par de claves que se va a usar para el certificado.
KeyProperties

Propiedades del par de claves que respalda un certificado.
KeyUsageType

Define cómo se puede usar la clave del certificado.
KeyVaultError

Excepción de error del almacén de claves.
LifetimeAction

Acción y su desencadenador que realizará Key Vault durante la vigencia de un certificado.
SecretProperties

Propiedades de la clave que respalda un certificado.
SubjectAlternativeNames

Nombres alternativos del sujeto de un objeto X509.
Trigger

Condición que se va a cumplir para que se ejecute una acción.
X509CertificateProperties

Propiedades del componente X509 de un certificado.

Action

Acción que se ejecutará.

Nombre Tipo Description
action_type

CertificatePolicyAction

El tipo de la acción.

CertificateAttributes

Atributos de administración de certificados.

Nombre Tipo Description
created

integer

Hora de creación en UTC.
enabled

boolean

Determina si el objeto está habilitado.
exp

integer

Fecha de expiración en UTC.
nbf

integer

No antes de la fecha en UTC.
recoverableDays

integer

días de retención de datos softDelete. El valor debe ser >=7 y <=90 cuando softDelete está habilitado; en caso contrario, 0.
recoveryLevel

DeletionRecoveryLevel

Refleja el nivel de recuperación de eliminación actualmente en vigor para los certificados del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente el certificado; de lo contrario, solo el sistema puede purgar el certificado, al final del intervalo de retención.
updated

integer

Hora de la última actualización en UTC.

CertificateCreateParameters

Parámetros de creación de certificados.

Nombre Tipo Description
attributes

CertificateAttributes

Atributos del certificado (opcional).
policy

CertificatePolicy

Directiva de administración del certificado.
tags

object

Metadatos específicos de la aplicación en forma de pares clave-valor.

CertificateOperation

Se devuelve una operación de certificado en caso de solicitudes asincrónicas.

Nombre Tipo Description
cancellation_requested

boolean

Indica si se solicitó la cancelación en la operación de certificado.
csr

string

Solicitud de firma de certificado (CSR) que se usa en la operación de certificado.
error

Error

Error detectado, si existe, durante la operación de certificado.
id

string

Identificador del certificado.
issuer

IssuerParameters

Parámetros para el emisor del componente X509 de un certificado.
request_id

string

Identificador de la operación de certificado.
status

string

Estado de la operación de certificado.
status_details

string

Detalles de estado de la operación de certificado.
target

string

Ubicación que contiene el resultado de la operación de certificado.

CertificatePolicy

Directiva de administración para un certificado.

Nombre Tipo Description
attributes

CertificateAttributes

Atributos de certificado.
id

string

Identificador del certificado.
issuer

IssuerParameters

Parámetros para el emisor del componente X509 de un certificado.
key_props

KeyProperties

Propiedades de la clave que respalda un certificado.
lifetime_actions

LifetimeAction[]

Acciones que realizará Key Vault durante la vigencia de un certificado.
secret_props

SecretProperties

Propiedades del secreto que respalda un certificado.
x509_props

X509CertificateProperties

Propiedades del componente X509 de un certificado.

CertificatePolicyAction

El tipo de la acción.

Nombre Tipo Description
AutoRenew

string

EmailContacts

string

DeletionRecoveryLevel

Refleja el nivel de recuperación de eliminación actualmente en vigor para los certificados del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente el certificado; de lo contrario, solo el sistema puede purgar el certificado, al final del intervalo de retención.

Nombre Tipo Description
CustomizedRecoverable

string

Indica un estado de almacén en el que la eliminación se puede recuperar sin la posibilidad de eliminación inmediata y permanente (es decir, purgar cuando 7<= SoftDeleteRetentionInDays < 90). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención y mientras la suscripción sigue estando disponible.
CustomizedRecoverable+ProtectedSubscription

string

Indica un almacén y un estado de suscripción en el que la eliminación es recuperable, inmediata y permanente (es decir, la purga) no está permitida y en la que la propia suscripción no se puede cancelar permanentemente cuando 7<= SoftDeleteRetentionInDays < 90. Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención y también refleja el hecho de que no se puede cancelar la propia suscripción.
CustomizedRecoverable+Purgeable

string

Indica un estado de almacén en el que se puede recuperar la eliminación y que también permite la eliminación inmediata y permanente (es decir, purgar cuando 7<= SoftDeleteRetentionInDays < 90). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención, a menos que se solicite una operación de purga o se cancele la suscripción.
Purgeable

string

Indica un estado de almacén en el que la eliminación es una operación irreversible, sin la posibilidad de recuperación. Este nivel no corresponde a ninguna protección disponible en una operación de eliminación; los datos se pierden irrecuperablemente al aceptar una operación de eliminación en el nivel de entidad o superior (almacén, grupo de recursos, suscripción, etc.).
Recoverable

string

Denota un estado de almacén en el que la eliminación se puede recuperar sin la posibilidad de eliminación inmediata y permanente (es decir, purga). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención (90 días) y mientras la suscripción sigue estando disponible. El sistema lo eliminará permanentemente después de 90 días, si no se recupera
Recoverable+ProtectedSubscription

string

Indica un almacén y un estado de suscripción en el que la eliminación se puede recuperar dentro del intervalo de retención (90 días), no se permite la eliminación inmediata y permanente (es decir, purga) y en la que la propia suscripción no se puede cancelar permanentemente. El sistema lo eliminará permanentemente después de 90 días, si no se recupera
Recoverable+Purgeable

string

Indica un estado de almacén en el que se puede recuperar la eliminación y que también permite la eliminación inmediata y permanente (es decir, purga). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención (90 días), a menos que se solicite una operación de purga o se cancele la suscripción. El sistema lo eliminará permanentemente después de 90 días, si no se recupera

Error

Error del servidor del almacén de claves.

Nombre Tipo Description
code

string

Código de error.
innererror

Error

Error del servidor del almacén de claves.
message

string

El mensaje de error.

IssuerParameters

Parámetros para el emisor del componente X509 de un certificado.

Nombre Tipo Description
cert_transparency

boolean

Indica si los certificados generados en esta directiva deben publicarse en los registros de transparencia de certificados.
cty

string

Tipo de certificado compatible con el proveedor (opcional); por ejemplo, "OV-SSL", "EV-SSL"
name

string

Nombre del objeto emisor al que se hace referencia o nombres reservados; por ejemplo, "Self" o "Unknown".

JsonWebKeyCurveName

Nombre de curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.

Nombre Tipo Description
P-256

string

P-256K

string

P-384

string

P-521

string

JsonWebKeyType

Tipo de par de claves que se va a usar para el certificado.

Nombre Tipo Description
EC

string

EC-HSM

string

RSA

string

RSA-HSM

string

oct

string

oct-HSM

string

KeyProperties

Propiedades del par de claves que respalda un certificado.

Nombre Tipo Description
crv

JsonWebKeyCurveName

Nombre de curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.
exportable

boolean

Indica si se puede exportar la clave privada. Se debe proporcionar la directiva de versión al crear la primera versión de una clave exportable.
key_size

integer

Tamaño de la clave en bits. Por ejemplo: 2048, 3072 o 4096 para RSA.
kty

JsonWebKeyType

Tipo de par de claves que se va a usar para el certificado.
reuse_key

boolean

Indica si se usará el mismo par de claves en la renovación del certificado.

KeyUsageType

Define cómo se puede usar la clave del certificado.

Nombre Tipo Description
cRLSign

string

dataEncipherment

string

decipherOnly

string

digitalSignature

string

encipherOnly

string

keyAgreement

string

keyCertSign

string

keyEncipherment

string

nonRepudiation

string

KeyVaultError

Excepción de error del almacén de claves.

Nombre Tipo Description
error

Error

Error del servidor del almacén de claves.

LifetimeAction

Acción y su desencadenador que realizará Key Vault durante la vigencia de un certificado.

Nombre Tipo Description
action

Action

Acción que se ejecutará.
trigger

Trigger

Condición que ejecutará la acción.

SecretProperties

Propiedades de la clave que respalda un certificado.

Nombre Tipo Description
contentType

string

Tipo de medio (tipo MIME).

SubjectAlternativeNames

Nombres alternativos del sujeto de un objeto X509.

Nombre Tipo Description
dns_names

string[]

Nombres de dominio.
emails

string[]

Direcciones de correo.
upns

string[]

Nombres principales de usuario.

Trigger

Condición que se va a cumplir para que se ejecute una acción.

Nombre Tipo Description
days_before_expiry

integer

Días antes de la expiración para intentar la renovación. El valor debe estar comprendido entre 1 y validity_in_months multiplicado por 27. Si validity_in_months es 36, el valor debe estar comprendido entre 1 y 972 (36 * 27).
lifetime_percentage

integer

Porcentaje de duración en la que se va a desencadenar. El valor debe estar comprendido entre 1 y 99.

X509CertificateProperties

Propiedades del componente X509 de un certificado.

Nombre Tipo Description
ekus

string[]

Uso mejorado de la clave.
key_usage

KeyUsageType[]

Define cómo se puede usar la clave del certificado.
sans

SubjectAlternativeNames

Nombres alternativos del firmante.
subject

string

El nombre de sujeto. Debe ser un nombre distintivo X509 válido.
validity_months

integer

Duración que el certificado es válido en meses.