Compartir a través de


@azure/keyvault-certificates package

Clases

CertificateClient

El cliente para interactuar con la funcionalidad de certificados keyVault

Interfaces

AdministratorContact

Detalles del administrador de la organización del emisor de certificados.

BackupCertificateResult

Resultado del certificado de copia de seguridad, que contiene el blob de copia de seguridad.

BeginCreateCertificateOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

CertificateClientOptions

Los parámetros opcionales aceptados por certificateClient de KeyVault

CertificateContactAll

Forma de la información de contacto de los certificados del almacén.

CertificateIssuer

Interfaz que representa las propiedades de un emisor.

CertificateOperation

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

CertificateOperationError

Error del servidor del almacén de claves.

CertificateOperationState

Interfaz que representa las propiedades disponibles públicamente del estado de CertificateOperationPoller.

CertificatePolicyProperties

Interfaz que representa la directiva de un certificado (sin las propiedades del firmante).

CertificatePollerOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) y beginRecoverDeletedCertificate(string, CertificatePollerOptions)

CertificateProperties

Interfaz que representa las propiedades de un certificado

CoreSubjectAlternativeNames

Nombres alternativos del firmante de un objeto X509.

CreateCertificateOptions

Opciones de <xref:createCertificate>.

CreateIssuerOptions

Opciones de createIssuer(string, string, CreateIssuerOptions).

DeletedCertificate

Interfaz que representa un certificado eliminado.

ErrorModel

Modelo de error del servidor del almacén de claves.

ImportCertificateOptions

Opciones de importCertificate(string, Uint8Array, ImportCertificateOptions).

IssuerAttributes

Atributos de un emisor administrado por el servicio Key Vault.

IssuerCredentials

Credenciales que se usarán para el emisor de certificados.

IssuerParameters

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

IssuerProperties

Interfaz que representa las propiedades de un emisor de certificados

KeyVaultCertificate

Interfaz que representa un certificado sin la directiva del certificado

KeyVaultCertificateIdentifier

Representa los segmentos que componen un identificador de certificado de Key Vault.

KeyVaultCertificatePollOperationState

Interfaz que representa la forma pública del estado de las operaciones de un sondeo de certificados de Key Vault.

KeyVaultCertificateWithPolicy

Interfaz que representa un certificado con su directiva

LifetimeAction

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

ListDeletedCertificatesOptions

Interfaz que representa parámetros opcionales para las operaciones paginadas certificateClient pasadas a listDeletedCertificates(ListDeletedCertificatesOptions).

ListPropertiesOfCertificatesOptions

Interfaz que representa parámetros opcionales para las operaciones paginadas certificateClient pasadas a listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).

PolicySubjectProperties

Interfaz que representa las posibles propiedades de asunto de la directiva de un certificado. El tipo final requiere al menos una de estas propiedades para existir.

PollerLike

Representación abstracta de un sondeo, diseñada para exponer solo la API mínima con la que el usuario necesita trabajar.

PollerLikeWithCancellation

Representación abstracta de un sondeo, diseñada para exponer solo la API mínima con la que el usuario necesita trabajar.

SubjectAlternativeNamesAll

Interfaz que representa los nombres alternativos del sujeto de una directiva de certificado.

UpdateCertificateOptions

Opciones de <xref:updateCertificate>.

UpdateIssuerOptions

Opciones de updateIssuer(string, UpdateIssuerOptions).

X509CertificateProperties

Propiedades del componente X509 de un certificado.

Alias de tipos

ActionType

Acción que se ejecutará.

ArrayOneOrMore

Matriz con una propiedad como mínimo.

BackupCertificateOptions

Opciones de backupCertificate(string, OperationOptions).

BeginDeleteCertificateOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a beginDeleteCertificate(string, CertificatePollerOptions)

BeginRecoverDeletedCertificateOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a beginRecoverDeletedCertificate(string, CertificatePollerOptions)

CancelCertificateOperationOptions

Opciones de <xref:cancelCertificateOperation>.

CertificateContact

La información de contacto de los certificados del almacén. Cada contacto tendrá al menos una de las propiedades de CertificateContactAll, que son: emailAddress, nombre o teléfono.

CertificateContentType

Define valores para contentType. Los valores posibles son: 'application/x-pem-file', 'application/x-pkcs12'

CertificateKeyCurveName

Nombre de la curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> se puede usar indistintamente con JsonWebKeyCurveName, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

P-256: la curva elíptica NIST P-256, la curva AKA SECG SECP256R1.
P-384: curva elíptica NIST P-384, curva AKA SECG SECP384R1.
P-521: curva elíptica NIST P-521, curva AKA SECG SECP521R1.
P-256K: curva elíptica SECG SECP256K1.

CertificateKeyType

Tipo de par de claves que se va a usar para el certificado.
<xref:KnownJsonWebKeyType> se puede usar indistintamente con JsonWebKeyType, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

EC: Curva elíptica.
EC-HSM: Curva elíptica con una clave privada que no se puede exportar desde el HSM.
rsa: RSA (https://tools.ietf.org/html/rfc3447).
RSA-HSM: RSA con una clave privada que no se puede exportar desde el HSM.
oct: secuencia octet (usada para representar claves simétricas).
oct-HSM: secuencia octeto con una clave privada que no se puede exportar desde el HSM.

CertificatePolicy

Tipo que representa la directiva de un certificado con al menos una de las propiedades del firmante.

CertificatePolicyAction

Acción que se ejecutará.

CertificateTags

Interfaz que representa la forma de las etiquetas de certificado. Las etiquetas son simplemente pares clave-valor de cadena.

CreateCertificateState

Representación pública del estado de la operación CreateCertificatePoller.

DeleteCertificateOperationOptions

Opciones de deleteCertificateOperation(string, OperationOptions).

DeleteCertificateState

Representación pública del estado de la operación DeleteCertificatePoller.

DeleteContactsOptions

Opciones de deleteContacts(OperationOptions).

DeleteIssuerOptions

Opciones de deleteIssuer(string, OperationOptions).

DeletionRecoveryLevel

Refleja el nivel de recuperación de eliminación actualmente en vigor para los secretos del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente el secreto; De lo contrario, solo el sistema puede purgar el secreto, al final del intervalo de retención.
<xref:KnownDeletionRecoveryLevel> se puede usar indistintamente con DeletionRecoveryLevel, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

purgable: denota 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.).
recuperable+Purgable: denota 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
recuperables: 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
recuperable+ProtectedSubscription: indica un almacén y un estado de suscripción en el que la eliminación se puede recuperar en el 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
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, 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.
CustomdRecoverable: 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, 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: indica un almacén y un estado de suscripción en el que la eliminación es recuperable, inmediata y permanente (es decir, purga) no se permite 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.

GetCertificateOperationOptions

Opciones de getCertificateOperation(string, CertificatePollerOptions).

GetCertificateOptions

Opciones de getCertificate(string, OperationOptions).

GetCertificatePolicyOptions

Opciones de getCertificatePolicy(string, OperationOptions).

GetCertificateVersionOptions

Opciones de getCertificateVersion(string, string, OperationOptions).

GetContactsOptions

Opciones de getContacts(OperationOptions).

GetDeletedCertificateOptions

Opciones de getDeletedCertificate(string, OperationOptions).

GetIssuerOptions

Opciones de getIssuer(string, OperationOptions).

GetPlainCertificateOperationOptions

Opciones de <xref:getPlainCertificateOperation>.

ImportCertificatePolicy

Tipo que representa la directiva de un certificado para la importación que no requiere una SAN o un sujeto

KVPollerLike

Copia en desuso de KeyVault de PollerLike de core-lro.

KeyUsageType

Usos admitidos de una clave de certificado.
<xref:KnownKeyUsageType> se puede usar indistintamente con KeyUsageType, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

digitalSignature: indica que la clave de certificado se puede usar como firma digital.
nonRepudiation : indica que se puede usar la clave de certificado para la autenticación.
keyEncipherment: indica que se puede usar la clave de certificado para el cifrado de claves.
dataEncipherment: indica que se puede usar la clave de certificado para el cifrado de datos.
keyAgreement: indica que la clave de certificado se puede usar para determinar el contrato de clave, como una clave creada mediante el algoritmo de acuerdo de clave Diffie-Hellman.
keyCertSign: indica que se puede usar la clave de certificado para firmar certificados.
cRLSign: indica que la clave de certificado se puede usar para firmar una lista de revocación de certificados.
encipherOnly: indica que la clave de certificado solo se puede usar para el cifrado.
decipherOnly: indica que la clave de certificado solo se puede usar para el descifrado.

ListPropertiesOfCertificateVersionsOptions

Interfaz que representa parámetros opcionales para las operaciones paginadas certificateClient pasadas a listPropertiesOfCertificateVersions(string, OperationOptions).

ListPropertiesOfIssuersOptions

Interfaz que representa parámetros opcionales para las operaciones paginadas certificateClient pasadas a listPropertiesOfIssuers(OperationOptions).

MergeCertificateOptions

Interfaz que representa parámetros opcionales para mergeCertificate(string, Uint8Array[], OperationOptions).

PurgeDeletedCertificateOptions

Opciones de purgeDeletedCertificate(string, OperationOptions).

RecoverDeletedCertificateState

En desuso: representación pública de la recuperación de una operación de sondeo de certificado eliminada

RequireAtLeastOne

RequireAtLeastOne ayuda a crear un tipo en el que se requiere al menos una de las propiedades de una interfaz (puede ser cualquier propiedad).

Esto funciona debido a los tipos de utilidad de TypeScript: https://www.typescriptlang.org/docs/handbook/utility-types.html Vamos a examinarlo:

  • [K in keyof T]-? esta propiedad (K) solo es válida si tiene el mismo nombre que cualquier propiedad de T.
  • Required<Pick<T, K>> convierte un nuevo tipo de T con solo la propiedad actual en la iteración y la marca según sea necesario.
  • Partial<Pick<T, Exclude<keyof T, K>>> convierte un nuevo tipo con todas las propiedades de T, excepto en la propiedad K.
  • & es lo que une el tipo con solo una propiedad necesaria de Required<...> con todas las propiedades opcionales de Partial<...>.
  • [keyof T] garantiza que solo se permiten las propiedades de T.
RestoreCertificateBackupOptions

Interfaz que representa parámetros opcionales para restoreCertificateBackup(Uint8Array, OperationOptions).

SetContactsOptions

Opciones de setContacts(CertificateContact[], OperationOptions).

SubjectAlternativeNames

Alternativas a la propiedad subject. Si está presente, debe tener al menos una de las propiedades de SubjectAlternativeNamesAll.

UpdateCertificatePolicyOptions

Opciones de updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

Enumeraciones

KnownCertificateKeyCurveNames

Valores conocidos de CertificateKeyCurveName que acepta el servicio.

KnownCertificateKeyTypes

Valores conocidos de CertificateKeyType que acepta el servicio.

KnownDeletionRecoveryLevels

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

KnownKeyUsageTypes

Los valores conocidos de KeyUsageType que acepta el servicio.

WellKnownIssuer

Emisores conocidos para elegir un valor predeterminado

Funciones

parseKeyVaultCertificateIdentifier(string)

Analiza el identificador de certificado de Key Vault especificado. Un ejemplo es:

https://.vault.azure.net/certificates//

Al analizar el identificador anterior, esta función devuelve:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/certificates/<certificate-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<certificate-name>"
  }

Detalles de la función

parseKeyVaultCertificateIdentifier(string)

Analiza el identificador de certificado de Key Vault especificado. Un ejemplo es:

https://.vault.azure.net/certificates//

Al analizar el identificador anterior, esta función devuelve:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/certificates/<certificate-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<certificate-name>"
  }
function parseKeyVaultCertificateIdentifier(id: string): KeyVaultCertificateIdentifier

Parámetros

id

string

Identificador del certificado de Key Vault.

Devoluciones