CertificateClient class

  • Referência
Pacote:
@azure/keyvault-certificates

O cliente para interagir com a funcionalidade de certificados KeyVault

Construtores

CertificateClient(string, TokenCredential, CertificateClientOptions)

Cria uma instância de CertificateClient.

Propriedades

vaultUrl

A URL base para o cofre

Métodos

backupCertificate(string, OperationOptions)

Solicita que um backup do certificado especificado seja baixado para o cliente. Todas as versões do certificado serão baixadas. Essa operação requer a permissão de certificados/backup.

Exemplo de uso:

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

Gera um backup de um certificado
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Cria um certificado. Se essa for a primeira versão, o recurso de certificado será criado. Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado.

Nota: O envio Self como a issuerName da política do certificado criará um certificado autoassinado.

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

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

Cria um certificado
beginDeleteCertificate(string, CertificatePollerOptions)

A operação DELETE aplica-se a qualquer certificado armazenado no Key Vault do Azure. DELETE não pode ser aplicado a uma versão individual de um certificado. Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado.

Essa operação requer a permissão de certificados/exclusão.

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

Exclui um certificado de um cofre de chaves especificado.
beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Recupera o certificado excluído no cofre especificado. Essa operação só pode ser executada em um cofre habilitado para exclusão reversível. Esta operação Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado.

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

Exemplo 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 um certificado excluído
createIssuer(string, string, CreateIssuerOptions)

A operação createIssuer adiciona ou atualiza o emissor do certificado especificado. Essa operação requer a permissão certificates/setissuers.

Exemplo de uso:

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

Define o emissor do certificado especificado.
deleteCertificateOperation(string, OperationOptions)

Exclui a operação de criação de um certificado especificado que está em processo de criação. O certificado não é mais criado. Essa operação requer a permissão de certificados/atualização.

Exemplo 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"

Excluir a operação de um certificado
deleteContacts(OperationOptions)

Exclui todos os contatos do certificado. Essa operação requer a permissão certificates/managecontacts.

Exemplo de uso:

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

Exclui todos os contatos do certificado
deleteIssuer(string, OperationOptions)

A operação deleteIssuer remove permanentemente o emissor do certificado especificado do cofre. Essa operação requer a permissão certificates/manageissuers/deleteissuers.

Exemplo de uso:

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

Exclui o emissor do certificado especificado.
getCertificate(string, OperationOptions)

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

Exemplo 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 um certificado do nome do certificado (inclui a política de certificado)
getCertificateOperation(string, CertificatePollerOptions)

Obtém a operação de criação associada a um certificado especificado. Essa operação requer a permissão de obtenção/certificados. Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado.

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

Obtém a operação de sondagem de um certificado
getCertificatePolicy(string, OperationOptions)

A operação getCertificatePolicy retorna os recursos de política de certificado especificados no cofre de chaves especificado. Essa operação requer a permissão de obtenção/certificados.

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

Obtém a política de um certificado
getCertificateVersion(string, string, OperationOptions)

Obtém informações sobre um certificado específico em uma versão específica. Ele não retornará a política do certificado. Essa operação requer a permissão de obtenção/certificados.

Exemplo 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 um certificado do nome do certificado e uma versão especificada
getContacts(OperationOptions)

Retorna o conjunto de recursos de contato de certificado no cofre de chaves especificado. Essa operação requer a permissão certificates/managecontacts.

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

Define os contatos do certificado.
getDeletedCertificate(string, OperationOptions)

recupera as informações de certificado excluídas mais seus atributos, como intervalo de retenção, exclusão permanente agendada e o nível de recuperação de exclusão atual. Essa operação requer a permissão de obtenção/certificados.

Exemplo de uso:

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

Obtém um certificado excluído
getIssuer(string, OperationOptions)

A operação getIssuer retorna os recursos especificados do emissor do certificado no cofre de chaves especificado. Essa operação requer a permissão certificates/manageissuers/getissuers.

Exemplo de uso:

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

Obtém o emissor do certificado especificado.
importCertificate(string, Uint8Array, ImportCertificateOptions)

Importa um certificado válido existente, contendo uma chave privada, para o Azure Key Vault. O certificado a ser importado deve estar no formato PFX ou PEM. Se o certificado estiver no formato PEM, o arquivo PEM deverá conter a chave, bem como os certificados x509. Essa operação requer a permissão certificados/importar.

Exemplo 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 um certificado do valor secreto de um certificado
listDeletedCertificates(ListDeletedCertificatesOptions)

Recupera os certificados no cofre atual que estão em um estado excluído e prontos para recuperação ou limpeza. Essa operação inclui informações específicas de exclusão. Essa operação requer a permissão certificates/get/list. Essa operação só pode ser habilitada em cofres habilitados para exclusão reversível.

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

Lista certificados excluídos
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Itera a versão mais recente de todos os certificados no cofre. O identificador de certificado completo e os atributos são fornecidos na resposta. Nenhum valor é retornado para os certificados. Essas operações exigem a permissão de certificados/lista.

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

Listar todas as versões do certificado especificado.
listPropertiesOfCertificateVersions(string, OperationOptions)

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

Exemplo de uso:

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

Listar as versões de um certificado.
listPropertiesOfIssuers(OperationOptions)

Retorna o conjunto de recursos do emissor do certificado no cofre de chaves especificado. Essa operação requer a permissão certificates/manageissuers/getissuers.

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

Listar os emissores do certificado.
mergeCertificate(string, Uint8Array[], OperationOptions)

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

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

Mescla uma solicitação de certificado assinado em um certificado pendente
purgeDeletedCertificate(string, OperationOptions)

Executa uma exclusão irreversível do certificado especificado, sem a possibilidade de recuperação. A operação não estará disponível se o nível de recuperação não especificar 'Purgeable'. Essa operação requer a permissão de certificado/limpeza.

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

Obtém um certificado excluído
restoreCertificateBackup(Uint8Array, OperationOptions)

Restaura um certificado de backup e todas as suas versões para um cofre. Essa operação requer a permissão de certificados/restauração.

Exemplo 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 um certificado de um backup
setContacts(CertificateContact[], OperationOptions)

Define os contatos de certificado para o cofre de chaves. Essa operação requer a permissão certificates/managecontacts.

Exemplo de uso:

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

Define os contatos do certificado.
updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Atualizações a política de certificado para o certificado especificado. Essa operação requer a permissão de certificados/atualização. Obtém a política de um certificado
updateCertificateProperties(string, string, UpdateCertificateOptions)

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

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

Atualizações um certificado
updateIssuer(string, UpdateIssuerOptions)

A operação updateIssuer executa uma atualização na entidade de emissor de certificado especificada. Essa operação requer a permissão certificates/setissuers.

Exemplo de uso:

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

Atualizações o emissor do certificado especificado.

Detalhes do construtor

CertificateClient(string, TokenCredential, CertificateClientOptions)

Cria uma instância de CertificateClient.

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

Parâmetros

vaultUrl

string

a URL base para o cofre. Você deve validar se essa URL faz referência a um recurso de Key Vault válido. Para obter detalhes, consulte https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Um objeto que implementa a TokenCredential interface usada para autenticar solicitações para o serviço. Use o @azure/identity pacote para criar uma credencial que atenda às suas necessidades.

clientOptions
CertificateClientOptions

Opções de pipeline usadas para configurar Key Vault solicitações de API. Omita esse parâmetro para usar a configuração de pipeline padrão.

Detalhes da propriedade

vaultUrl

A URL base para o cofre

vaultUrl: string

Valor da propriedade

string

Detalhes do método

backupCertificate(string, OperationOptions)

Solicita que um backup do certificado especificado seja baixado para o cliente. Todas as versões do certificado serão baixadas. Essa operação requer a permissão de certificados/backup.

Exemplo de uso:

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

Gera um backup de um certificado

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

Parâmetros

certificateName

string

O nome do certificado

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<undefined | Uint8Array>

beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Cria um certificado. Se essa for a primeira versão, o recurso de certificado será criado. Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado.

Nota: O envio Self como a issuerName da política do certificado criará um certificado autoassinado.

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

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

Cria um certificado

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

Parâmetros

certificateName

string

O nome do certificado

policy
CertificatePolicy
options
BeginCreateCertificateOptions

Parâmetros opcionais

Retornos

Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

beginDeleteCertificate(string, CertificatePollerOptions)

A operação DELETE aplica-se a qualquer certificado armazenado no Key Vault do Azure. DELETE não pode ser aplicado a uma versão individual de um certificado. Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado.

Essa operação requer a permissão de certificados/exclusão.

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

Exclui um certificado de um cofre de chaves especificado.

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

Parâmetros

certificateName

string

O nome do certificado.

options
CertificatePollerOptions

Os parâmetros opcionais

Retornos

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Recupera o certificado excluído no cofre especificado. Essa operação só pode ser executada em um cofre habilitado para exclusão reversível. Esta operação Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado.

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

Exemplo 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 um certificado excluído

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

Parâmetros

certificateName

string

O nome do certificado excluído

options
CertificatePollerOptions

Os parâmetros opcionais

Retornos

Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

createIssuer(string, string, CreateIssuerOptions)

A operação createIssuer adiciona ou atualiza o emissor do certificado especificado. Essa operação requer a permissão certificates/setissuers.

Exemplo de uso:

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

Define o emissor do certificado especificado.

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

Parâmetros

issuerName

string

O nome do emissor.

provider

string

O provedor do emissor.

options
CreateIssuerOptions

Os parâmetros opcionais

Retornos

Promise<CertificateIssuer>

deleteCertificateOperation(string, OperationOptions)

Exclui a operação de criação de um certificado especificado que está em processo de criação. O certificado não é mais criado. Essa operação requer a permissão de certificados/atualização.

Exemplo 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"

Excluir a operação de um certificado

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

Parâmetros

certificateName

string

O nome do certificado

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<CertificateOperation>

deleteContacts(OperationOptions)

Exclui todos os contatos do certificado. Essa operação requer a permissão certificates/managecontacts.

Exemplo de uso:

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

Exclui todos os contatos do certificado

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

Parâmetros

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<undefined | CertificateContact[]>

deleteIssuer(string, OperationOptions)

A operação deleteIssuer remove permanentemente o emissor do certificado especificado do cofre. Essa operação requer a permissão certificates/manageissuers/deleteissuers.

Exemplo de uso:

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

Exclui o emissor do certificado especificado.

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

Parâmetros

issuerName

string

O nome do emissor.

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<CertificateIssuer>

getCertificate(string, OperationOptions)

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

Exemplo 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 um certificado do nome do certificado (inclui a política de certificado)

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

Parâmetros

certificateName

string

O nome do certificado

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, CertificatePollerOptions)

Obtém a operação de criação associada a um certificado especificado. Essa operação requer a permissão de obtenção/certificados. Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado.

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

Obtém a operação de sondagem de um certificado

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

Parâmetros

certificateName

string

O nome do certificado

options
CertificatePollerOptions

Os parâmetros opcionais

Retornos

Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

getCertificatePolicy(string, OperationOptions)

A operação getCertificatePolicy retorna os recursos de política de certificado especificados no cofre de chaves especificado. Essa operação requer a permissão de obtenção/certificados.

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

Obtém a política de um certificado

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

Parâmetros

certificateName

string

O nome do certificado

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<CertificatePolicy>

getCertificateVersion(string, string, OperationOptions)

Obtém informações sobre um certificado específico em uma versão específica. Ele não retornará a política do certificado. Essa operação requer a permissão de obtenção/certificados.

Exemplo 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 um certificado do nome do certificado e uma versão especificada

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

Parâmetros

certificateName

string

O nome do certificado

version

string

A versão específica do certificado

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<KeyVaultCertificate>

getContacts(OperationOptions)

Retorna o conjunto de recursos de contato de certificado no cofre de chaves especificado. Essa operação requer a permissão certificates/managecontacts.

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

Define os contatos do certificado.

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

Parâmetros

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<undefined | CertificateContact[]>

getDeletedCertificate(string, OperationOptions)

recupera as informações de certificado excluídas mais seus atributos, como intervalo de retenção, exclusão permanente agendada e o nível de recuperação de exclusão atual. Essa operação requer a permissão de obtenção/certificados.

Exemplo de uso:

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

Obtém um certificado excluído

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

Parâmetros

certificateName

string

O nome do certificado

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<DeletedCertificate>

getIssuer(string, OperationOptions)

A operação getIssuer retorna os recursos especificados do emissor do certificado no cofre de chaves especificado. Essa operação requer a permissão certificates/manageissuers/getissuers.

Exemplo de uso:

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

Obtém o emissor do certificado especificado.

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

Parâmetros

issuerName

string

O nome do emissor.

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<CertificateIssuer>

importCertificate(string, Uint8Array, ImportCertificateOptions)

Importa um certificado válido existente, contendo uma chave privada, para o Azure Key Vault. O certificado a ser importado deve estar no formato PFX ou PEM. Se o certificado estiver no formato PEM, o arquivo PEM deverá conter a chave, bem como os certificados x509. Essa operação requer a permissão certificados/importar.

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

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

Parâmetros

certificateName

string

O nome do certificado

certificateBytes

Uint8Array

O valor PFX ou ASCII PEM formatado do certificado que contém os certificados X.509 e a chave privada

options
ImportCertificateOptions

Os parâmetros opcionais

Retornos

Promise<KeyVaultCertificateWithPolicy>

listDeletedCertificates(ListDeletedCertificatesOptions)

Recupera os certificados no cofre atual que estão em um estado excluído e prontos para recuperação ou limpeza. Essa operação inclui informações específicas de exclusão. Essa operação requer a permissão certificates/get/list. Essa operação só pode ser habilitada em cofres habilitados para exclusão reversível.

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

Lista certificados excluídos

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

Parâmetros

options
ListDeletedCertificatesOptions

Os parâmetros opcionais

Retornos

PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Itera a versão mais recente de todos os certificados no cofre. O identificador de certificado completo e os atributos são fornecidos na resposta. Nenhum valor é retornado para os certificados. Essas operações exigem a permissão de certificados/lista.

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

Listar todas as versões do certificado especificado.

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

Parâmetros

options
ListPropertiesOfCertificatesOptions

Os parâmetros opcionais

Retornos

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfCertificateVersions(string, OperationOptions)

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

Exemplo de uso:

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

Listar as versões de um certificado.

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

Parâmetros

certificateName

string

O nome do certificado.

options
OperationOptions

Os parâmetros opcionais

Retornos

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfIssuers(OperationOptions)

Retorna o conjunto de recursos do emissor do certificado no cofre de chaves especificado. Essa operação requer a permissão certificates/manageissuers/getissuers.

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

Listar os emissores do certificado.

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

Parâmetros

options
OperationOptions

Os parâmetros opcionais

Retornos

PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

mergeCertificate(string, Uint8Array[], OperationOptions)

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

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

Mescla uma solicitação de certificado assinado em um certificado pendente

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

Parâmetros

certificateName

string

O nome do certificado

x509Certificates

Uint8Array[]

Os certificados a serem mesclados

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<KeyVaultCertificateWithPolicy>

purgeDeletedCertificate(string, OperationOptions)

Executa uma exclusão irreversível do certificado especificado, sem a possibilidade de recuperação. A operação não estará disponível se o nível de recuperação não especificar 'Purgeable'. Essa operação requer a permissão de certificado/limpeza.

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

Obtém um certificado excluído

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

Parâmetros

certificateName

string

O nome do certificado excluído a ser limpo

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<null>

restoreCertificateBackup(Uint8Array, OperationOptions)

Restaura um certificado de backup e todas as suas versões para um cofre. Essa operação requer a permissão de certificados/restauração.

Exemplo 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 um certificado de um backup

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

Parâmetros

backup

Uint8Array

O certificado de backup do qual restaurar

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<KeyVaultCertificateWithPolicy>

setContacts(CertificateContact[], OperationOptions)

Define os contatos de certificado para o cofre de chaves. Essa operação requer a permissão certificates/managecontacts.

Exemplo de uso:

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

Define os contatos do certificado.

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

Parâmetros

contacts

CertificateContact[]

Os contatos a serem usados

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<undefined | CertificateContact[]>

updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Atualizações a política de certificado para o certificado especificado. Essa 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

certificateName

string

O nome do certificado

policy
CertificatePolicy

A política de certificado

options
OperationOptions

Os parâmetros opcionais

Retornos

Promise<CertificatePolicy>

updateCertificateProperties(string, string, UpdateCertificateOptions)

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

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

Atualizações um certificado

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

Parâmetros

certificateName

string

O nome do certificado

version

string

A versão do certificado a ser atualizada (uma cadeia de caracteres vazia atualizará a versão mais recente)

options
UpdateCertificateOptions

As opções, incluindo o que atualizar

Retornos

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

A operação updateIssuer executa uma atualização na entidade de emissor de certificado especificada. Essa operação requer a permissão certificates/setissuers.

Exemplo de uso:

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

Atualizações o emissor do certificado especificado.

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

Parâmetros

issuerName

string

O nome do emissor.

options
UpdateIssuerOptions

Os parâmetros opcionais

Retornos

Promise<CertificateIssuer>