CertificateClient class

  • Referencia
Paquete:
@azure/keyvault-certificates

El cliente para interactuar con la funcionalidad de certificados keyVault

Constructores

CertificateClient(string, TokenCredential, CertificateClientOptions)

Crea una instancia de CertificateClient.

Propiedades

vaultUrl

Dirección URL base del almacén

Métodos

backupCertificate(string, OperationOptions)

Solicita que se descargue una copia de seguridad del certificado especificado en el cliente. Se descargarán todas las versiones del certificado. Esta operación requiere el permiso certificates/backup.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");

Genera una copia de seguridad de un certificado
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Crea un nuevo certificado. Si se trata de la primera versión, se crea el recurso de certificado. Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que el certificado se recupere por completo.

Nota: El envío Self como issuerName de la directiva del certificado creará un certificado autofirmado.

Esta operación requiere el permiso de creación de certificados.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert"
};
const createPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy);

// The pending certificate can be obtained by calling the following method:
const pendingCertificate = createPoller.getResult();

// Serializing the poller
const serialized = createPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy, { resumeFrom: serialized });

// Waiting until it's done
const certificate = await createPoller.pollUntilDone();
console.log(certificate);

Crea un certificado
beginDeleteCertificate(string, CertificatePollerOptions)

La operación DELETE se aplica a cualquier certificado almacenado en Azure Key Vault. DELETE no se puede aplicar a una versión individual de un certificado. Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que el certificado se recupere por completo.

Esta operación requiere el permiso certificates/delete.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await createPoller.pollUntilDone();

const deletePoller = await client.beginDeleteCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const deletedCertificate = await deletePoller.pollUntilDone();
console.log(deletedCertificate);

Elimina un certificado de un almacén de claves especificado.
beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Recupera el certificado eliminado en el almacén especificado. Esta operación solo se puede realizar en un almacén habilitado para eliminación temporal. Esta operación Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que el certificado se recupere por completo.

Esta operación requiere el permiso certificates/recover.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);

const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const certificate = await recoverPoller.pollUntilDone();
console.log(certificate);

Recupera un certificado eliminado
createIssuer(string, string, CreateIssuerOptions)

La operación createIssuer agrega o actualiza el emisor de certificados especificado. Esta operación requiere el permiso certificates/setissuers.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");

Establece el emisor de certificados especificado.
deleteCertificateOperation(string, OperationOptions)

Elimina la operación de creación de un certificado especificado que está en proceso de creación. El certificado ya no se crea. Esta operación requiere el permiso certificates/update.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await client.deleteCertificateOperation("MyCertificate");
await client.getCertificateOperation("MyCertificate"); // Throws error: Pending certificate not found: "MyCertificate"

Eliminar la operación de un certificado
deleteContacts(OperationOptions)

Elimina todos los contactos del certificado. Esta operación requiere el permiso certificates/managecontacts.

Ejemplo de uso:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
await client.deleteContacts();

Elimina todos los contactos del certificado.
deleteIssuer(string, OperationOptions)

La operación deleteIssuer quita permanentemente el emisor de certificados especificado del almacén. Esta operación requiere el permiso certificates/manageissuers/deleteissuers.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Provider");
await client.deleteIssuer("IssuerName");

Elimina el emisor de certificados especificado.
getCertificate(string, OperationOptions)

Obtiene la información más reciente disponible de un certificado específico, incluida la directiva del certificado. Esta operación requiere el permiso certificates/get.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificate = await client.getCertificate("MyCertificate");
console.log(certificate);

Recupera un certificado del nombre del certificado (incluye la directiva de certificado).
getCertificateOperation(string, CertificatePollerOptions)

Obtiene la operación de creación asociada a un certificado especificado. Esta operación requiere el permiso certificates/get. Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que el certificado se recupere por completo.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

const poller = await client.getCertificateOperation("MyCertificate");
const pendingCertificate = poller.getResult();

const certificateOperation = poller.getOperationState().certificateOperation;
console.log(certificateOperation);

Obtiene la operación de sondeo de un certificado.
getCertificatePolicy(string, OperationOptions)

La operación getCertificatePolicy devuelve los recursos de directiva de certificado especificados en el almacén de claves especificado. Esta operación requiere el permiso certificates/get.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const policy = await client.getCertificatePolicy("MyCertificate");
console.log(policy);

Obtiene la directiva de un certificado.
getCertificateVersion(string, string, OperationOptions)

Obtiene información sobre un certificado específico en una versión específica. No devolverá la directiva del certificado. Esta operación requiere el permiso certificates/get.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificateWithPolicy = await client.getCertificate("MyCertificate");
const certificate = await client.getCertificateVersion("MyCertificate", certificateWithPolicy.properties.version!);
console.log(certificate);

Recupera un certificado del nombre del certificado y una versión especificada.
getContacts(OperationOptions)

Devuelve el conjunto de recursos de contacto de certificado en el almacén de claves especificado. Esta operación requiere el permiso certificates/managecontacts.

Ejemplo de uso:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
const contacts = await client.getContacts();
console.log(contacts);

Establece los contactos del certificado.
getDeletedCertificate(string, OperationOptions)

recupera la información del certificado eliminado más sus atributos, como el intervalo de retención, la eliminación permanente programada y el nivel de recuperación de eliminación actual. Esta operación requiere el permiso certificates/get.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
const deletedCertificate = await client.getDeletedCertificate("MyDeletedCertificate");
console.log("Deleted certificate:", deletedCertificate);

Obtiene un certificado eliminado.
getIssuer(string, OperationOptions)

La operación getIssuer devuelve los recursos del emisor de certificados especificados en el almacén de claves especificado. Esta operación requiere el permiso certificates/manageissuers/getissuers.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
const certificateIssuer = await client.getIssuer("IssuerName");
console.log(certificateIssuer);

Obtiene el emisor de certificados especificado.
importCertificate(string, Uint8Array, ImportCertificateOptions)

Importa un certificado válido existente, que contiene una clave privada, en Azure Key Vault. El certificado que se va a importar puede estar en formato PFX o PEM. Si el certificado está en formato PEM, el archivo PEM debe contener la clave, así como los certificados X509. Esta operación requiere el permiso certificados/importar.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
// See: @azure/keyvault-secrets
const certificateSecret = await secretClient.getSecret("MyCertificate");
const base64EncodedCertificate = certificateSecret.value!;
let buffer: Uint8Array;

if (isNode) {
  buffer = Buffer.from(base64EncodedCertificate, "base64");
} else {
  buffer = Uint8Array.from(atob(base64EncodedCertificate), (c) => c.charCodeAt(0));
}

await client.importCertificate("MyCertificate", buffer);

Importa un certificado a partir del valor del secreto de un certificado
listDeletedCertificates(ListDeletedCertificatesOptions)

Recupera los certificados del almacén actual que están en un estado eliminado y listos para la recuperación o purga. Esta operación incluye información específica de la eliminación. Esta operación requiere el permiso certificates/get/list. Esta operación solo se puede habilitar en almacenes habilitados para eliminación temporal.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
for await (const deletedCertificate of client.listDeletedCertificates()) {
  console.log(deletedCertificate);
}
for await (const page of client.listDeletedCertificates().byPage()) {
  for (const deletedCertificate of page) {
    console.log(deletedCertificate);
  }
}

Enumera los certificados eliminados
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Itera la versión más reciente de todos los certificados del almacén. El identificador de certificado completo y los atributos se proporcionan en la respuesta. No se devuelve ningún valor para los certificados. Estas operaciones requieren el permiso certificates/list.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
// All in one call
for await (const certificateProperties of client.listPropertiesOfCertificates()) {
  console.log(certificateProperties);
}
// By pages
for await (const page of client.listPropertiesOfCertificates().byPage()) {
  for (const certificateProperties of page) {
    console.log(certificateProperties);
  }
}

Enumera todas las versiones del certificado especificado.
listPropertiesOfCertificateVersions(string, OperationOptions)

Devuelve las versiones de un certificado en el almacén de claves especificado. Esta operación requiere el permiso certificates/list.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
for await (const certificateProperties of client.listPropertiesOfCertificateVersions("MyCertificate")) {
  console.log(certificateProperties.version!);
}

Enumerar las versiones de un certificado.
listPropertiesOfIssuers(OperationOptions)

Devuelve el conjunto de recursos del emisor de certificados en el almacén de claves especificado. Esta operación requiere el permiso certificates/manageissuers/getissuers.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
// All in one call
for await (const issuerProperties of client.listPropertiesOfIssuers()) {
  console.log(issuerProperties);
}
// By pages
for await (const page of client.listPropertiesOfIssuers().byPage()) {
  for (const issuerProperties of page) {
    console.log(issuerProperties);
  }
}

Enumere los emisores de certificados.
mergeCertificate(string, Uint8Array[], OperationOptions)

Realiza la combinación de un certificado o una cadena de certificados con un par de claves disponible actualmente en el servicio. Esta operación requiere el permiso de creación de certificados.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Unknown",
  subject: "cn=MyCert"
});
const poller = await client.getCertificateOperation("MyCertificate");
const { csr } = poller.getOperationState().certificateOperation!;
const base64Csr = Buffer.from(csr!).toString("base64");
const wrappedCsr = ["-----BEGIN CERTIFICATE REQUEST-----", base64Csr, "-----END CERTIFICATE REQUEST-----"].join("\n");

const fs = require("fs");
fs.writeFileSync("test.csr", wrappedCsr);

// Certificate available locally made using:
//   openssl genrsa -out ca.key 2048
//   openssl req -new -x509 -key ca.key -out ca.crt
// You can read more about how to create a fake certificate authority here: https://gist.github.com/Soarez/9688998

const childProcess = require("child_process");
childProcess.execSync("openssl x509 -req -in test.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out test.crt");
const base64Crt = fs.readFileSync("test.crt").toString().split("\n").slice(1, -1).join("");

await client.mergeCertificate("MyCertificate", [Buffer.from(base64Crt)]);

Combina una solicitud de certificado firmada en un certificado pendiente.
purgeDeletedCertificate(string, OperationOptions)

Realiza una eliminación irreversible del certificado especificado, sin posibilidad de recuperación. La operación no está disponible si el nivel de recuperación no especifica "Purgable". Esta operación requiere el permiso certificate/purge.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();
// Deleting a certificate takes time, make sure to wait before purging it
client.purgeDeletedCertificate("MyCertificate");

Obtiene un certificado eliminado.
restoreCertificateBackup(Uint8Array, OperationOptions)

Restaura un certificado de copia de seguridad y todas sus versiones en un almacén. Esta operación requiere el permiso certificates/restore.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");
const poller = await client.beginDeleteCertificate("MyCertificate");
await poller.pollUntilDone();
// Some time is required before we're able to restore the certificate
await client.restoreCertificateBackup(backup!);

Restaura un certificado a partir de una copia de seguridad
setContacts(CertificateContact[], OperationOptions)

Establece los contactos de certificado para el almacén de claves. Esta operación requiere el permiso certificates/managecontacts.

Ejemplo de uso:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);

Establece los contactos del certificado.
updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Novedades la directiva de certificado para el certificado especificado. Esta operación requiere el permiso certificates/update. Obtiene la directiva de un certificado.
updateCertificateProperties(string, string, UpdateCertificateOptions)

Aplica la actualización especificada en el certificado especificado; los únicos elementos actualizados son los atributos del certificado. Esta operación requiere el permiso certificates/update.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

// You may pass an empty string for version which will update
// the latest version of the certificate
await client.updateCertificateProperties("MyCertificate", "", {
  tags: {
    customTag: "value"
  }
});

Novedades un certificado
updateIssuer(string, UpdateIssuerOptions)

La operación updateIssuer realiza una actualización en la entidad del emisor de certificados especificada. Esta operación requiere el permiso certificates/setissuers.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
await client.updateIssuer("IssuerName", {
  provider: "Provider2"
});

Novedades el emisor de certificados especificado.

Detalles del constructor

CertificateClient(string, TokenCredential, CertificateClientOptions)

Crea una instancia de CertificateClient.

new CertificateClient(vaultUrl: string, credential: TokenCredential, clientOptions?: CertificateClientOptions)

Parámetros

vaultUrl

string

la dirección URL base del almacén. Debe validar que esta dirección URL hace referencia a un recurso de Key Vault válido. Para obtener información detallada, vea https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Objeto que implementa la TokenCredential interfaz utilizada para autenticar las solicitudes en el servicio. Use el @azure/identity paquete para crear una credencial que se adapte a sus necesidades.

clientOptions
CertificateClientOptions

Opciones de canalización usadas para configurar solicitudes de API de Key Vault. Omita este parámetro para usar la configuración de canalización predeterminada.

Detalles de las propiedades

vaultUrl

Dirección URL base del almacén

vaultUrl: string

Valor de propiedad

string

Detalles del método

backupCertificate(string, OperationOptions)

Solicita que se descargue una copia de seguridad del certificado especificado en el cliente. Se descargarán todas las versiones del certificado. Esta operación requiere el permiso certificates/backup.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");

Genera una copia de seguridad de un certificado

function backupCertificate(certificateName: string, options?: OperationOptions): Promise<undefined | Uint8Array>

Parámetros

certificateName

string

Nombre del certificado

options
OperationOptions

Los parámetros opcionales

Devoluciones

Promise<undefined | Uint8Array>

beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Crea un nuevo certificado. Si se trata de la primera versión, se crea el recurso de certificado. Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que el certificado se recupere por completo.

Nota: El envío Self como issuerName de la directiva del certificado creará un certificado autofirmado.

Esta operación requiere el permiso de creación de certificados.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert"
};
const createPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy);

// The pending certificate can be obtained by calling the following method:
const pendingCertificate = createPoller.getResult();

// Serializing the poller
const serialized = createPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy, { resumeFrom: serialized });

// Waiting until it's done
const certificate = await createPoller.pollUntilDone();
console.log(certificate);

Crea un certificado

function beginCreateCertificate(certificateName: string, policy: CertificatePolicy, options?: BeginCreateCertificateOptions): Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

Parámetros

certificateName

string

Nombre del certificado

policy
CertificatePolicy
options
BeginCreateCertificateOptions

Parámetros opcionales

Devoluciones

Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

beginDeleteCertificate(string, CertificatePollerOptions)

La operación DELETE se aplica a cualquier certificado almacenado en Azure Key Vault. DELETE no se puede aplicar a una versión individual de un certificado. Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que el certificado se recupere por completo.

Esta operación requiere el permiso certificates/delete.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await createPoller.pollUntilDone();

const deletePoller = await client.beginDeleteCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const deletedCertificate = await deletePoller.pollUntilDone();
console.log(deletedCertificate);

Elimina un certificado de un almacén de claves especificado.

function beginDeleteCertificate(certificateName: string, options?: CertificatePollerOptions): Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

Parámetros

certificateName

string

Nombre del certificado.

options
CertificatePollerOptions

Los parámetros opcionales

Devoluciones

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Recupera el certificado eliminado en el almacén especificado. Esta operación solo se puede realizar en un almacén habilitado para eliminación temporal. Esta operación Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que el certificado se recupere por completo.

Esta operación requiere el permiso certificates/recover.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);

const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const certificate = await recoverPoller.pollUntilDone();
console.log(certificate);

Recupera un certificado eliminado

function beginRecoverDeletedCertificate(certificateName: string, options?: CertificatePollerOptions): Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

Parámetros

certificateName

string

Nombre del certificado eliminado

options
CertificatePollerOptions

Los parámetros opcionales

Devoluciones

Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

createIssuer(string, string, CreateIssuerOptions)

La operación createIssuer agrega o actualiza el emisor de certificados especificado. Esta operación requiere el permiso certificates/setissuers.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");

Establece el emisor de certificados especificado.

function createIssuer(issuerName: string, provider: string, options?: CreateIssuerOptions): Promise<CertificateIssuer>

Parámetros

issuerName

string

Nombre del emisor.

provider

string

Proveedor del emisor.

options
CreateIssuerOptions

Los parámetros opcionales

Devoluciones

Promise<CertificateIssuer>

deleteCertificateOperation(string, OperationOptions)

Elimina la operación de creación de un certificado especificado que está en proceso de creación. El certificado ya no se crea. Esta operación requiere el permiso certificates/update.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await client.deleteCertificateOperation("MyCertificate");
await client.getCertificateOperation("MyCertificate"); // Throws error: Pending certificate not found: "MyCertificate"

Eliminar la operación de un certificado

function deleteCertificateOperation(certificateName: string, options?: OperationOptions): Promise<CertificateOperation>

Parámetros

certificateName

string

Nombre del certificado

options
OperationOptions

Los parámetros opcionales

Devoluciones

Promise<CertificateOperation>

deleteContacts(OperationOptions)

Elimina todos los contactos del certificado. Esta operación requiere el permiso certificates/managecontacts.

Ejemplo de uso:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
await client.deleteContacts();

Elimina todos los contactos del certificado.

function deleteContacts(options?: OperationOptions): Promise<undefined | CertificateContact[]>

Parámetros

options
OperationOptions

Los parámetros opcionales

Devoluciones

Promise<undefined | CertificateContact[]>

deleteIssuer(string, OperationOptions)

La operación deleteIssuer quita permanentemente el emisor de certificados especificado del almacén. Esta operación requiere el permiso certificates/manageissuers/deleteissuers.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Provider");
await client.deleteIssuer("IssuerName");

Elimina el emisor de certificados especificado.

function deleteIssuer(issuerName: string, options?: OperationOptions): Promise<CertificateIssuer>

Parámetros

issuerName

string

Nombre del emisor.

options
OperationOptions

Los parámetros opcionales

Devoluciones

Promise<CertificateIssuer>

getCertificate(string, OperationOptions)

Obtiene la información más reciente disponible de un certificado específico, incluida la directiva del certificado. Esta operación requiere el permiso certificates/get.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificate = await client.getCertificate("MyCertificate");
console.log(certificate);

Recupera un certificado del nombre del certificado (incluye la directiva de certificado).

function getCertificate(certificateName: string, options?: OperationOptions): Promise<KeyVaultCertificateWithPolicy>

Parámetros

certificateName

string

Nombre del certificado

options
OperationOptions

Los parámetros opcionales

Devoluciones

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, CertificatePollerOptions)

Obtiene la operación de creación asociada a un certificado especificado. Esta operación requiere el permiso certificates/get. Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que el certificado se recupere por completo.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

const poller = await client.getCertificateOperation("MyCertificate");
const pendingCertificate = poller.getResult();

const certificateOperation = poller.getOperationState().certificateOperation;
console.log(certificateOperation);

Obtiene la operación de sondeo de un certificado.

function getCertificateOperation(certificateName: string, options?: CertificatePollerOptions): Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

Parámetros

certificateName

string

Nombre del certificado

options
CertificatePollerOptions

Los parámetros opcionales

Devoluciones

Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

getCertificatePolicy(string, OperationOptions)

La operación getCertificatePolicy devuelve los recursos de directiva de certificado especificados en el almacén de claves especificado. Esta operación requiere el permiso certificates/get.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const policy = await client.getCertificatePolicy("MyCertificate");
console.log(policy);

Obtiene la directiva de un certificado.

function getCertificatePolicy(certificateName: string, options?: OperationOptions): Promise<CertificatePolicy>

Parámetros

certificateName

string

Nombre del certificado

options
OperationOptions

Los parámetros opcionales

Devoluciones

Promise<CertificatePolicy>

getCertificateVersion(string, string, OperationOptions)

Obtiene información sobre un certificado específico en una versión específica. No devolverá la directiva del certificado. Esta operación requiere el permiso certificates/get.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificateWithPolicy = await client.getCertificate("MyCertificate");
const certificate = await client.getCertificateVersion("MyCertificate", certificateWithPolicy.properties.version!);
console.log(certificate);

Recupera un certificado del nombre del certificado y una versión especificada.

function getCertificateVersion(certificateName: string, version: string, options?: OperationOptions): Promise<KeyVaultCertificate>

Parámetros

certificateName

string

Nombre del certificado

version

string

La versión específica del certificado

options
OperationOptions

Los parámetros opcionales

Devoluciones

Promise<KeyVaultCertificate>

getContacts(OperationOptions)

Devuelve el conjunto de recursos de contacto de certificado en el almacén de claves especificado. Esta operación requiere el permiso certificates/managecontacts.

Ejemplo de uso:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
const contacts = await client.getContacts();
console.log(contacts);

Establece los contactos del certificado.

function getContacts(options?: OperationOptions): Promise<undefined | CertificateContact[]>

Parámetros

options
OperationOptions

Los parámetros opcionales

Devoluciones

Promise<undefined | CertificateContact[]>

getDeletedCertificate(string, OperationOptions)

recupera la información del certificado eliminado más sus atributos, como el intervalo de retención, la eliminación permanente programada y el nivel de recuperación de eliminación actual. Esta operación requiere el permiso certificates/get.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
const deletedCertificate = await client.getDeletedCertificate("MyDeletedCertificate");
console.log("Deleted certificate:", deletedCertificate);

Obtiene un certificado eliminado.

function getDeletedCertificate(certificateName: string, options?: OperationOptions): Promise<DeletedCertificate>

Parámetros

certificateName

string

Nombre del certificado

options
OperationOptions

Los parámetros opcionales

Devoluciones

Promise<DeletedCertificate>

getIssuer(string, OperationOptions)

La operación getIssuer devuelve los recursos del emisor de certificados especificados en el almacén de claves especificado. Esta operación requiere el permiso certificates/manageissuers/getissuers.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
const certificateIssuer = await client.getIssuer("IssuerName");
console.log(certificateIssuer);

Obtiene el emisor de certificados especificado.

function getIssuer(issuerName: string, options?: OperationOptions): Promise<CertificateIssuer>

Parámetros

issuerName

string

Nombre del emisor.

options
OperationOptions

Los parámetros opcionales

Devoluciones

Promise<CertificateIssuer>

importCertificate(string, Uint8Array, ImportCertificateOptions)

Importa un certificado válido existente, que contiene una clave privada, en Azure Key Vault. El certificado que se va a importar puede estar en formato PFX o PEM. Si el certificado está en formato PEM, el archivo PEM debe contener la clave, así como los certificados X509. Esta operación requiere el permiso certificados/importar.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
// See: @azure/keyvault-secrets
const certificateSecret = await secretClient.getSecret("MyCertificate");
const base64EncodedCertificate = certificateSecret.value!;
let buffer: Uint8Array;

if (isNode) {
  buffer = Buffer.from(base64EncodedCertificate, "base64");
} else {
  buffer = Uint8Array.from(atob(base64EncodedCertificate), (c) => c.charCodeAt(0));
}

await client.importCertificate("MyCertificate", buffer);

Importa un certificado a partir del valor del secreto de un certificado

function importCertificate(certificateName: string, certificateBytes: Uint8Array, options?: ImportCertificateOptions): Promise<KeyVaultCertificateWithPolicy>

Parámetros

certificateName

string

Nombre del certificado

certificateBytes

Uint8Array

El valor con formato PFX o ASCII PEM del certificado que contiene los certificados X.509 y la clave privada

options
ImportCertificateOptions

Los parámetros opcionales

Devoluciones

Promise<KeyVaultCertificateWithPolicy>

listDeletedCertificates(ListDeletedCertificatesOptions)

Recupera los certificados del almacén actual que están en un estado eliminado y listos para la recuperación o purga. Esta operación incluye información específica de la eliminación. Esta operación requiere el permiso certificates/get/list. Esta operación solo se puede habilitar en almacenes habilitados para eliminación temporal.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
for await (const deletedCertificate of client.listDeletedCertificates()) {
  console.log(deletedCertificate);
}
for await (const page of client.listDeletedCertificates().byPage()) {
  for (const deletedCertificate of page) {
    console.log(deletedCertificate);
  }
}

Enumera los certificados eliminados

function listDeletedCertificates(options?: ListDeletedCertificatesOptions): PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

Parámetros

options
ListDeletedCertificatesOptions

Los parámetros opcionales

Devoluciones

PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Itera la versión más reciente de todos los certificados del almacén. El identificador de certificado completo y los atributos se proporcionan en la respuesta. No se devuelve ningún valor para los certificados. Estas operaciones requieren el permiso certificates/list.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
// All in one call
for await (const certificateProperties of client.listPropertiesOfCertificates()) {
  console.log(certificateProperties);
}
// By pages
for await (const page of client.listPropertiesOfCertificates().byPage()) {
  for (const certificateProperties of page) {
    console.log(certificateProperties);
  }
}

Enumera todas las versiones del certificado especificado.

function listPropertiesOfCertificates(options?: ListPropertiesOfCertificatesOptions): PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

Parámetros

options
ListPropertiesOfCertificatesOptions

Los parámetros opcionales

Devoluciones

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfCertificateVersions(string, OperationOptions)

Devuelve las versiones de un certificado en el almacén de claves especificado. Esta operación requiere el permiso certificates/list.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
for await (const certificateProperties of client.listPropertiesOfCertificateVersions("MyCertificate")) {
  console.log(certificateProperties.version!);
}

Enumerar las versiones de un certificado.

function listPropertiesOfCertificateVersions(certificateName: string, options?: OperationOptions): PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

Parámetros

certificateName

string

Nombre del certificado.

options
OperationOptions

Los parámetros opcionales

Devoluciones

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfIssuers(OperationOptions)

Devuelve el conjunto de recursos del emisor de certificados en el almacén de claves especificado. Esta operación requiere el permiso certificates/manageissuers/getissuers.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
// All in one call
for await (const issuerProperties of client.listPropertiesOfIssuers()) {
  console.log(issuerProperties);
}
// By pages
for await (const page of client.listPropertiesOfIssuers().byPage()) {
  for (const issuerProperties of page) {
    console.log(issuerProperties);
  }
}

Enumere los emisores de certificados.

function listPropertiesOfIssuers(options?: OperationOptions): PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

Parámetros

options
OperationOptions

Los parámetros opcionales

Devoluciones

PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

mergeCertificate(string, Uint8Array[], OperationOptions)

Realiza la combinación de un certificado o una cadena de certificados con un par de claves disponible actualmente en el servicio. Esta operación requiere el permiso de creación de certificados.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Unknown",
  subject: "cn=MyCert"
});
const poller = await client.getCertificateOperation("MyCertificate");
const { csr } = poller.getOperationState().certificateOperation!;
const base64Csr = Buffer.from(csr!).toString("base64");
const wrappedCsr = ["-----BEGIN CERTIFICATE REQUEST-----", base64Csr, "-----END CERTIFICATE REQUEST-----"].join("\n");

const fs = require("fs");
fs.writeFileSync("test.csr", wrappedCsr);

// Certificate available locally made using:
//   openssl genrsa -out ca.key 2048
//   openssl req -new -x509 -key ca.key -out ca.crt
// You can read more about how to create a fake certificate authority here: https://gist.github.com/Soarez/9688998

const childProcess = require("child_process");
childProcess.execSync("openssl x509 -req -in test.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out test.crt");
const base64Crt = fs.readFileSync("test.crt").toString().split("\n").slice(1, -1).join("");

await client.mergeCertificate("MyCertificate", [Buffer.from(base64Crt)]);

Combina una solicitud de certificado firmada en un certificado pendiente.

function mergeCertificate(certificateName: string, x509Certificates: Uint8Array[], options?: OperationOptions): Promise<KeyVaultCertificateWithPolicy>

Parámetros

certificateName

string

Nombre del certificado

x509Certificates

Uint8Array[]

Los certificados que se van a combinar

options
OperationOptions

Parámetros opcionales

Devoluciones

Promise<KeyVaultCertificateWithPolicy>

purgeDeletedCertificate(string, OperationOptions)

Realiza una eliminación irreversible del certificado especificado, sin posibilidad de recuperación. La operación no está disponible si el nivel de recuperación no especifica "Purgable". Esta operación requiere el permiso certificate/purge.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();
// Deleting a certificate takes time, make sure to wait before purging it
client.purgeDeletedCertificate("MyCertificate");

Obtiene un certificado eliminado.

function purgeDeletedCertificate(certificateName: string, options?: OperationOptions): Promise<null>

Parámetros

certificateName

string

Nombre del certificado eliminado que se va a purgar.

options
OperationOptions

Parámetros opcionales

Devoluciones

Promise<null>

restoreCertificateBackup(Uint8Array, OperationOptions)

Restaura un certificado de copia de seguridad y todas sus versiones en un almacén. Esta operación requiere el permiso certificates/restore.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");
const poller = await client.beginDeleteCertificate("MyCertificate");
await poller.pollUntilDone();
// Some time is required before we're able to restore the certificate
await client.restoreCertificateBackup(backup!);

Restaura un certificado a partir de una copia de seguridad

function restoreCertificateBackup(backup: Uint8Array, options?: OperationOptions): Promise<KeyVaultCertificateWithPolicy>

Parámetros

backup

Uint8Array

Certificado de copia de seguridad desde el que se va a restaurar

options
OperationOptions

Parámetros opcionales

Devoluciones

Promise<KeyVaultCertificateWithPolicy>

setContacts(CertificateContact[], OperationOptions)

Establece los contactos de certificado para el almacén de claves. Esta operación requiere el permiso certificates/managecontacts.

Ejemplo de uso:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);

Establece los contactos del certificado.

function setContacts(contacts: CertificateContact[], options?: OperationOptions): Promise<undefined | CertificateContact[]>

Parámetros

contacts

CertificateContact[]

Contactos que se van a usar

options
OperationOptions

Parámetros opcionales

Devoluciones

Promise<undefined | CertificateContact[]>

updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Novedades la directiva de certificado para el certificado especificado. Esta operación requiere el permiso certificates/update. Obtiene la directiva de un certificado.

function updateCertificatePolicy(certificateName: string, policy: CertificatePolicy, options?: OperationOptions): Promise<CertificatePolicy>

Parámetros

certificateName

string

Nombre del certificado

policy
CertificatePolicy

Directiva de certificado

options
OperationOptions

Parámetros opcionales

Devoluciones

Promise<CertificatePolicy>

updateCertificateProperties(string, string, UpdateCertificateOptions)

Aplica la actualización especificada en el certificado especificado; los únicos elementos actualizados son los atributos del certificado. Esta operación requiere el permiso certificates/update.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

// You may pass an empty string for version which will update
// the latest version of the certificate
await client.updateCertificateProperties("MyCertificate", "", {
  tags: {
    customTag: "value"
  }
});

Novedades un certificado

function updateCertificateProperties(certificateName: string, version: string, options?: UpdateCertificateOptions): Promise<KeyVaultCertificate>

Parámetros

certificateName

string

Nombre del certificado

version

string

La versión del certificado que se va a actualizar (una cadena vacía actualizará la versión más reciente).

options
UpdateCertificateOptions

Las opciones, incluidas las que se van a actualizar

Devoluciones

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

La operación updateIssuer realiza una actualización en la entidad del emisor de certificados especificada. Esta operación requiere el permiso certificates/setissuers.

Ejemplo de uso:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
await client.updateIssuer("IssuerName", {
  provider: "Provider2"
});

Novedades el emisor de certificados especificado.

function updateIssuer(issuerName: string, options?: UpdateIssuerOptions): Promise<CertificateIssuer>

Parámetros

issuerName

string

Nombre del emisor.

options
UpdateIssuerOptions

Parámetros opcionales

Devoluciones

Promise<CertificateIssuer>