Get Certificate - Get Certificate

Servicio:: Key Vault

Versión de la API:: 7.4

Obtiene información sobre un certificado.
Obtiene información sobre un certificado específico. Esta operación requiere el permiso certificates/get.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
certificate-name	path	True	string	Nombre del certificado en el almacén especificado.
certificate-version	path	True	string	Versión del certificado. Este fragmento de URI es opcional. Si no se especifica, se devuelve la versión más reciente del certificado.
vaultBaseUrl	path	True	string	El nombre del almacén, por ejemplo, `https://myvault.vault.azure.net`.
api-version	query	True	string	Versión de la API de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	CertificateBundle	Certificado recuperado.
Other Status Codes	KeyVaultError	Respuesta de error de Key Vault que describe por qué se produjo un error en la operación.

Ejemplos

GetCertificate

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "id": "https://myvault.vault.azure.net/certificates/selfSignedCert01/f60f2a4f8ae442cfb41ca2090bd4b769",
  "kid": "https://myvault.vault.azure.net/keys/selfSignedCert01/f60f2a4f8ae442cfb41ca2090bd4b769",
  "sid": "https://myvault.vault.azure.net/secrets/selfSignedCert01/f60f2a4f8ae442cfb41ca2090bd4b769",
  "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
  "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=",
  "attributes": {
    "enabled": true,
    "nbf": 1430344421,
    "exp": 2208988799,
    "created": 1493938289,
    "updated": 1493938291,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "policy": {
    "id": "https://myvault.vault.azure.net/certificates/selfSignedCert01/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": 1493938289,
      "updated": 1493938291
    }
  }
}

Definiciones

Nombre	Description
Action	Acción que se ejecutará.
CertificateAttributes	Atributos de administración de certificados.
CertificateBundle	Un conjunto de certificados consta de un certificado (X509) más sus atributos.
CertificatePolicy	Directiva de administración de un certificado.
CertificatePolicyAction	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 la 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 firmante de un objeto X509.
Trigger	Condición que se va a satisfacer para que se ejecute una acción.
X509CertificateProperties	Propiedades del componente X509 de un certificado.

Action

Object

Acción que se ejecutará.

Nombre	Tipo	Description
action_type	CertificatePolicyAction	Tipo de la acción.

CertificateAttributes

Object

Atributos de administración de certificados.

Nombre	Tipo	Description
created	integer (unixtime)	Hora de creación en UTC.
enabled	boolean	Determina si el objeto está habilitado.
exp	integer (unixtime)	Fecha de expiración en UTC.
nbf	integer (unixtime)	No antes de la fecha en UTC.
recoverableDays	integer (int32)	días de retención de datos softDelete. El valor debe ser >=7 y <=90 cuando softDelete esté habilitado; de lo 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 (unixtime)	Hora actualizada por última vez en UTC.

CertificateBundle

Object

Un conjunto de certificados consta de un certificado (X509) más sus atributos.

Nombre	Tipo	Description
attributes	CertificateAttributes	Atributos de certificado.
cer	string (byte)	Contenido cer del certificado x509.
contentType	string	Tipo de contenido del secreto. Eg. 'application/x-pem-file' o 'application/x-pkcs12',
id	string	Identificador del certificado.
kid	string	Identificador de clave.
policy	CertificatePolicy	Directiva de administración.
sid	string	Identificador del secreto.
tags	object	Metadatos específicos de la aplicación en forma de pares clave-valor
x5t	string (base64url)	Huella digital del certificado.

CertificatePolicy

Object

Directiva de administración de 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

Enumeración

Tipo de la acción.

Valor	Description
AutoRenew
EmailContacts

DeletionRecoveryLevel

Enumeración

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.

Valor	Description
CustomizedRecoverable	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 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	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	Denota un estado de almacén en el que se puede recuperar la eliminación y, además, permite la eliminación inmediata y permanente (es decir, purga 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	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	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	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	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

Object

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	Mensaje de error.

IssuerParameters

Object

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

Enumeración

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

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

JsonWebKeyType

Enumeración

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

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

KeyProperties

Object

Propiedades del par de claves que respalda un certificado.

Nombre	Tipo	Description
crv	JsonWebKeyCurveName	Nombre de la 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 (int32)	Tamaño de 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

Enumeración

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

Valor	Description
cRLSign
dataEncipherment
decipherOnly
digitalSignature
encipherOnly
keyAgreement
keyCertSign
keyEncipherment
nonRepudiation

KeyVaultError

Object

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

Nombre	Tipo	Description
error	Error	Error del servidor del almacén de claves.

LifetimeAction

Object

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

Object

Propiedades de la clave que respalda un certificado.

Nombre	Tipo	Description
contentType	string	Tipo de medio (tipo MIME).

SubjectAlternativeNames

Object

Nombres alternativos del firmante de un objeto X509.

Nombre	Tipo	Description
dns_names	string[]	Nombres de dominio.
emails	string[]	Direcciones de correo electrónico.
upns	string[]	Nombres principales de usuario.

Trigger

Object

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

Nombre	Tipo	Description
days_before_expiry	integer (int32)	Días antes de la expiración para intentar la renovación. El valor debe estar 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 (int32) minimum: 1 maximum: 99	Porcentaje de duración en la que se va a desencadenar. El valor debe estar comprendido entre 1 y 99.

X509CertificateProperties

Object

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	Nombre del firmante. Debe ser un nombre distintivo X509 válido.
validity_months	integer (int32) minimum: 0	Duración que el certificado es válido en meses.

Compartir a través de

Get Certificate - Get Certificate

Parámetros de identificador URI

Respuestas

Ejemplos

GetCertificate

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Action

CertificateAttributes

CertificateBundle

CertificatePolicy

CertificatePolicyAction

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties