CertificateClient class

Cria uma instância de CertificateClient.

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

Parâmetros

O URL base para o cofre

vaultUrl: string

Valor de Propriedade

Pede que seja transferida uma cópia de segurança do certificado especificado para o cliente. Todas as versões do certificado serão transferidas. Esta operação requer a permissão de certificados/cópia de segurança.

Utilização de exemplo:

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

Gera uma cópia de segurança de um certificado

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

Parâmetros

Devoluções

Cria um novo certificado. Se esta for a primeira versão, o recurso de certificado é criado. Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que o certificado seja totalmente recuperado.

Nota: Enviar Self como a issuerName política do certificado irá criar um certificado autoassinado.

Esta operação requer a permissão certificados/criar.

Utilização de exemplo:

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);

Cria um certificado

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

Parâmetros

Devoluções

A operação DELETE aplica-se a qualquer certificado armazenado no Azure Key Vault. Não é possível aplicar a DELETE a uma versão individual de um certificado. Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que o certificado seja totalmente recuperado.

Esta operação requer a permissão de certificados/eliminação.

Utilização de exemplo:

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 um certificado de um cofre de chaves especificado.

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

Parâmetros

Devoluções

Recupera o certificado eliminado no cofre especificado. Esta operação só pode ser efetuada num cofre ativado para eliminação recuperável. Esta operação Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que o certificado seja totalmente recuperado.

Esta operação requer a permissão de certificados/recuperação.

Utilização de exemplo:

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 um certificado eliminado

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

Parâmetros

Devoluções

A operação createIssuer adiciona ou atualiza o emissor de certificados especificado. Esta operação requer a permissão certificados/setissuers.

Utilização de exemplo:

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

Define o emissor de certificados especificado.

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

Parâmetros

Devoluções

Elimina a operação de criação de um certificado especificado que está em processo de criação. O certificado já não foi criado. Esta operação requer a permissão de certificados/atualização.

Utilização de exemplo:

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 a operação de um certificado

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

Parâmetros

Devoluções

Elimina todos os contactos do certificado. Esta operação requer a permissão certificados/managecontacts.

Utilização de exemplo:

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

Elimina todos os contactos do certificado

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

Parâmetros

Devoluções

A operação deleteIssuer remove permanentemente o emissor de certificados especificado do cofre. Esta operação requer a permissão certificados/manageissuers/deleteissuers.

Utilização de exemplo:

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

Elimina o emissor de certificados especificado.

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

Parâmetros

Devoluções

Obtém as informações mais recentes disponíveis a partir de um certificado específico, incluindo a política do certificado. Esta operação requer os certificados/obter permissão.

Utilização de exemplo:

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);

Obtém um certificado do nome do certificado (inclui a política de certificado)

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

Parâmetros

Devoluções

Obtém a operação de criação associada a um certificado especificado. Esta operação requer os certificados/obter permissão. Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que o certificado seja totalmente recuperado.

Utilização de exemplo:

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);

Obtém a operação do poller de um certificado

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

Parâmetros

Devoluções

A operação getCertificatePolicy devolve os recursos de política de certificado especificados no cofre de chaves especificado. Esta operação requer os certificados/obter permissão.

Utilização de exemplo:

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

Obtém a política de um certificado

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

Parâmetros

Devoluções

Obtém informações sobre um certificado específico numa versão específica. Não devolverá a política do certificado. Esta operação requer os certificados/obter permissão.

Utilização de exemplo:

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);

Obtém um certificado a partir do nome do certificado e de uma versão especificada

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

Parâmetros

Devoluções

Devolve o conjunto de recursos de contacto do certificado no cofre de chaves especificado. Esta operação requer a permissão certificados/managecontacts.

Utilização de exemplo:

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);

Define os contactos do certificado.

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

Parâmetros

Devoluções

obtém as informações de certificado eliminadas e os respetivos atributos, como o intervalo de retenção, a eliminação permanente agendada e o nível de recuperação de eliminação atual. Esta operação requer os certificados/obter permissão.

Utilização de exemplo:

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

Obtém um certificado eliminado

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

Parâmetros

Devoluções

A operação getIssuer devolve os recursos do emissor de certificados especificados no cofre de chaves especificado. Esta operação requer a permissão certificados/manageissuers/getissuers.

Utilização de exemplo:

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

Obtém o emissor de certificados especificado.

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

Parâmetros

Devoluções

Importa um certificado válido existente, que contém uma chave privada, para o Azure Key Vault. O certificado a importar pode estar no formato PFX ou PEM. Se o certificado estiver no formato PEM, o ficheiro PEM tem de conter a chave, bem como certificados x509. Esta operação requer a permissão certificados/importar.

Utilização de exemplo:

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 um certificado do valor secreto de um certificado

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

Parâmetros

Devoluções

Obtém os certificados no cofre atual que estão num estado eliminado e estão prontos para recuperação ou remoção. Esta operação inclui informações específicas de eliminação. Esta operação requer a permissão certificados/get/list. Esta operação só pode ser ativada em cofres com eliminação recuperável ativada.

Utilização de exemplo:

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);
  }
}

Listas de certificados eliminados

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

Parâmetros

Devoluções

Itera a versão mais recente de todos os certificados no cofre. O identificador completo do certificado e os atributos são fornecidos na resposta. Não são devolvidos valores para os certificados. Estas operações requerem a permissão certificados/lista.

Utilização de exemplo:

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);
  }
}

Listar todas as versões do certificado especificado.

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

Parâmetros

Devoluções

Devolve as versões de um certificado no cofre de chaves especificado. Esta operação requer a permissão certificados/lista.

Utilização de exemplo:

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

Liste as versões de um certificado.

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

Parâmetros

Devoluções

Devolve o conjunto de recursos do emissor de certificados no cofre de chaves especificado. Esta operação requer a permissão certificados/manageissuers/getissuers.

Utilização de exemplo:

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);
  }
}

Liste os emissores de certificados.

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

Parâmetros

Devoluções

Efetua a intercalação de um certificado ou cadeia de certificados com um par de chaves atualmente disponível no serviço. Esta operação requer a permissão certificados/criar.

Utilização de exemplo:

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)]);

Intercala um pedido de certificado assinado num certificado pendente

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

Parâmetros

Devoluções

Efetua uma eliminação irreversível do certificado especificado, sem possibilidade de recuperação. A operação não está disponível se o nível de recuperação não especificar "Purgável". Esta operação requer a permissão de certificado/remoção.

Utilização de exemplo:

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");

Obtém um certificado eliminado

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

Parâmetros

Devoluções

Restaura um certificado de cópia de segurança e todas as respetivas versões para um cofre. Esta operação requer a permissão de certificados/restauro.

Utilização de exemplo:

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 um certificado a partir de uma cópia de segurança

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

Parâmetros

Devoluções

Define os contactos do certificado para o cofre de chaves. Esta operação requer a permissão certificados/managecontacts.

Utilização de exemplo:

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

Define os contactos do certificado.

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

Parâmetros

Devoluções

Atualizações a política de certificado do certificado especificado. Esta operação requer a permissão de certificados/atualização. Obtém a política de um certificado

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

Parâmetros

Devoluções

Aplica a atualização especificada no certificado especificado; os únicos elementos atualizados são os atributos do certificado. Esta operação requer a permissão de certificados/atualização.

Utilização de exemplo:

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"
  }
});

Atualizações um certificado

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

Parâmetros

Devoluções

A operação updateIssuer efetua uma atualização na entidade do emissor de certificados especificada. Esta operação requer a permissão certificados/setissuers.

Utilização de exemplo:

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

Atualizações o emissor de certificados especificado.

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

Parâmetros

Devoluções