CertificateClient class
O cliente para interagir com a funcionalidade de certificados KeyVault
Construtores
| Certificate |
Cria uma instância de CertificateClient. |
Propriedades
| vault |
O URL base para o cofre |
Métodos
| backup |
Solicita que um backup do certificado especificado seja baixado para o cliente. Todas as versões do certificado serão baixadas. Esta operação requer a permissão de certificados/backup. Exemplo de uso:
Gera um backup de um certificado |
| begin |
Cria um novo certificado. Se esta for a primeira versão, o recurso de certificado será criado. Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado.
Nota: Enviar Esta operação requer a permissão de certificados/criação. Exemplo de uso:
Cria um certificado |
| begin |
A operação DELETE aplica-se a qualquer certificado armazenado no Cofre da Chave do Azure. DELETE não pode ser aplicado a uma versão individual de um certificado. Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado. Esta operação requer a permissão de certificados/exclusão. Exemplo de uso:
Exclui um certificado de um cofre de chaves especificado. |
| begin |
Recupera o certificado excluído no cofre especificado. Esta operação só pode ser executada em um cofre habilitado para exclusão suave. Esta operação Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado. Esta operação requer a permissão de certificados/recuperação. Exemplo de uso:
Recupera um certificado excluído |
| create |
A operação createIssuer adiciona ou atualiza o emissor de certificado especificado. Esta operação requer a permissão de certificados/setissuers. Exemplo de uso:
Define o emissor de certificado especificado. |
| delete |
Exclui a operação de criação de um certificado especificado que está em processo de criação. O certificado não é mais criado. Esta operação requer a permissão de certificados/atualização. Exemplo de uso:
Excluir a operação de um certificado |
| delete |
Exclui todos os contatos do certificado. Esta operação requer a permissão certificates/managecontacts. Exemplo de uso:
Exclui todos os contatos do certificado |
| delete |
A operação deleteIssuer remove permanentemente o emissor de certificado especificado do cofre. Esta operação requer a permissão certificates/manageissuers/deleteissuers. Exemplo de uso:
Exclui o emissor de certificado especificado. |
| get |
Obtém as informações mais recentes disponíveis de um certificado específico, incluindo a política do certificado. Esta operação requer os certificados/obter permissão. Exemplo de uso:
Recupera um certificado do nome do certificado (inclui a política de certificado) |
| get |
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 retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado. Exemplo de uso:
Obtém a operação de poller de um certificado |
| get |
A operação getCertificatePolicy retorna os recursos de política de certificado especificados no cofre de chaves especificado. Esta operação requer os certificados/obter permissão. Exemplo de uso:
Obtém a política de um certificado |
| get |
Obtém informações sobre um certificado específico em uma versão específica. Ele não retornará a política do certificado. Esta operação requer os certificados/obter permissão. Exemplo de uso:
Recupera um certificado do nome do certificado e de uma versão especificada |
| get |
Retorna o conjunto de recursos de contato de certificado no cofre de chaves especificado. Esta operação requer a permissão certificates/managecontacts. Exemplo de uso:
Define os contatos do certificado. |
| get |
Recupera as informações do certificado excluído e seus atributos, como intervalo de retenção, exclusão permanente agendada e o nível de recuperação de exclusão atual. Esta operação requer os certificados/obter permissão. Exemplo de uso:
Obtém um certificado excluído |
| get |
A operação getIssuer retorna os recursos especificados do emissor de certificados no cofre de chaves especificado. Esta operação requer a permissão certificates/manageissuers/getissuers. Exemplo de uso:
Obtém o emissor de certificado especificado. |
| import |
Importa um certificado válido existente, contendo uma chave privada, para o Cofre de Chaves do Azure. O certificado a ser importado pode estar no formato PFX ou PEM. Se o certificado estiver no formato PEM, o arquivo PEM deve conter a chave, bem como certificados x509. Esta operação requer a permissão de certificados/importação. Exemplo de uso:
Importa um certificado do valor secreto de um certificado |
| list |
Recupera os certificados no cofre atual que estão em um estado excluído e prontos para recuperação ou limpeza. Esta operação inclui informações específicas de exclusão. Esta operação requer a permissão certificates/get/list. Esta operação só pode ser ativada em cofres habilitados para exclusão suave. Exemplo de uso:
Lista de certificados excluídos |
| list |
Itera a versão mais recente de todos os certificados no vault. O identificador completo do certificado e os atributos são fornecidos na resposta. Nenhum valor é retornado para os certificados. Esta operação requer a permissão de certificados/lista. Exemplo de uso:
Liste todas as versões do certificado especificado. |
| list |
Retorna as versões de um certificado no cofre de chaves especificado. Esta operação requer a permissão de certificados/lista. Exemplo de uso:
Liste as versões de um certificado. |
| list |
Retorna o conjunto de recursos do emissor de certificados no cofre de chaves especificado. Esta operação requer a permissão certificates/manageissuers/getissuers. Exemplo de uso:
Listar os emissores de certificados. |
| merge |
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 a permissão de certificados/criação. Exemplo de uso:
Mescla uma solicitação de certificado assinada em um certificado pendente |
| purge |
Executa uma exclusão irreversível do certificado especificado, sem possibilidade de recuperação. A operação não estará disponível se o nível de recuperação não especificar 'Purgeable'. Esta operação requer a permissão de certificado/limpeza. Exemplo de uso:
Obtém um certificado excluído |
| restore |
Restaura um certificado de backup e todas as suas versões em um cofre. Esta operação requer a permissão de certificados/restauração. Exemplo de uso:
Restaura um certificado de um backup |
| set |
Define os contatos de certificado para o cofre de chaves. Esta operação requer a permissão certificates/managecontacts. Exemplo de uso:
Define os contatos do certificado. |
| update |
Atualiza a política de certificado para o certificado especificado. Esta operação requer a permissão de certificados/atualização. Obtém a política de um certificado |
| update |
Aplica a atualização especificada no certificado fornecido; Os únicos elementos atualizados são os atributos do certificado. Esta operação requer a permissão de certificados/atualização. Exemplo de uso:
Atualiza um certificado |
| update |
A operação updateIssuer executa uma atualização na entidade emissora de certificado especificada. Esta operação requer a permissão de certificados/setissuers. Exemplo de uso:
Atualiza o emissor de 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
o URL base para o cofre. Você deve validar se essa URL faz referência a um recurso válido do Cofre da Chave. Consulte https://aka.ms/azsdk/blog/vault-uri para obter detalhes.
- credential
- TokenCredential
Um objeto que implementa a interface TokenCredential usada para autenticar solicitações para o serviço. Use o pacote @azure/identity para criar uma credencial que atenda às suas necessidades.
- clientOptions
- CertificateClientOptions
Opções de pipeline usadas para configurar solicitações de API do Cofre de Chaves. Omita esse parâmetro para usar a configuração de pipeline padrão.
Detalhes de Propriedade
vaultUrl
O URL base para o cofre
vaultUrl: string
Valor de Propriedade
string
Detalhes de 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. Esta operação requer a permissão de certificados/backup.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(url, credential);
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
Devoluções
Promise<undefined | Uint8Array>
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)
Cria um novo certificado. Se esta for a primeira versão, o recurso de certificado será criado. Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado.
Nota: Enviar Self como a issuerName da política do certificado criará um certificado autoassinado.
Esta operação requer a permissão de certificados/criação.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(url, credential);
const certificateName = "MyCertificateName";
const certificatePolicy = {
issuerName: "Self",
subject: "cn=MyCert",
};
const poller = await client.beginCreateCertificate(certificateName, certificatePolicy);
// You can use the pending certificate immediately:
const pendingCertificate = poller.getResult();
// Or you can wait until the certificate finishes being signed:
const keyVaultCertificate = await poller.pollUntilDone();
console.log(keyVaultCertificate);
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
Devoluções
beginDeleteCertificate(string, CertificatePollerOptions)
A operação DELETE aplica-se a qualquer certificado armazenado no Cofre da Chave do Azure. DELETE não pode ser aplicado a uma versão individual de um certificado. Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado.
Esta operação requer a permissão de certificados/exclusão.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(keyVaultUrl, credential);
const certificateName = "MyCertificate";
const poller = await client.beginDeleteCertificate(certificateName);
// You can use the deleted certificate immediately:
const deletedCertificate = poller.getResult();
// The certificate is being deleted. Only wait for it if you want to restore it or purge it.
await poller.pollUntilDone();
// You can also get the deleted certificate this way:
await client.getDeletedCertificate(certificateName);
// Deleted certificates can also be recovered or purged.
// recoverDeletedCertificate returns a poller, just like beginDeleteCertificate.
// const recoverPoller = await client.beginRecoverDeletedCertificate(certificateName);
// await recoverPoller.pollUntilDone();
// If a certificate is done and the Key Vault has soft-delete enabled, the certificate can be purged with:
await client.purgeDeletedCertificate(certificateName);
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
Devoluções
Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>
beginRecoverDeletedCertificate(string, CertificatePollerOptions)
Recupera o certificado excluído no cofre especificado. Esta operação só pode ser executada em um cofre habilitado para exclusão suave. Esta operação Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado.
Esta operação requer a permissão de certificados/recuperação.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(url, credential);
const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();
const recoverPoller = await client.beginRecoverDeletedCertificate("MyCertificate");
// 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
Devoluções
createIssuer(string, string, CreateIssuerOptions)
A operação createIssuer adiciona ou atualiza o emissor de certificado especificado. Esta operação requer a permissão de certificados/setissuers.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(keyVaultUrl, credential);
await client.createIssuer("IssuerName", "Test");
Define o emissor de certificado especificado.
function createIssuer(issuerName: string, provider: string, options?: CreateIssuerOptions): Promise<CertificateIssuer>
Parâmetros
- issuerName
-
string
O nome do emitente.
- provider
-
string
O fornecedor do emitente.
- options
- CreateIssuerOptions
Os parâmetros opcionais
Devoluções
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. Esta operação requer a permissão de certificados/atualização.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(url, credential);
await client.beginCreateCertificate("MyCertificate", {
issuerName: "Self",
subject: "cn=MyCert",
});
await client.deleteCertificateOperation("MyCertificate");
await client.getCertificateOperation("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
Devoluções
Promise<CertificateOperation>
deleteContacts(OperationOptions)
Exclui todos os contatos do certificado. Esta operação requer a permissão certificates/managecontacts.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(keyVaultUrl, credential);
await client.deleteContacts();
Exclui todos os contatos do certificado
function deleteContacts(options?: OperationOptions): Promise<undefined | CertificateContact[]>
Parâmetros
- options
- OperationOptions
Os parâmetros opcionais
Devoluções
Promise<undefined | CertificateContact[]>
deleteIssuer(string, OperationOptions)
A operação deleteIssuer remove permanentemente o emissor de certificado especificado do cofre. Esta operação requer a permissão certificates/manageissuers/deleteissuers.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(keyVaultUrl, credential);
await client.deleteIssuer("IssuerName");
Exclui o emissor de certificado especificado.
function deleteIssuer(issuerName: string, options?: OperationOptions): Promise<CertificateIssuer>
Parâmetros
- issuerName
-
string
O nome do emitente.
- options
- OperationOptions
Os parâmetros opcionais
Devoluções
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. Esta operação requer os certificados/obter permissão.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(keyVaultUrl, credential);
const certificateName = "MyCertificate";
const result = await client.getCertificate(certificateName);
console.log(result.name);
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
Devoluções
Promise<KeyVaultCertificateWithPolicy>
getCertificateOperation(string, CertificatePollerOptions)
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 retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que o certificado seja totalmente recuperado.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(url, credential);
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 poller 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
Devoluções
getCertificatePolicy(string, OperationOptions)
A operação getCertificatePolicy retorna os recursos de política de certificado especificados no cofre de chaves especificado. Esta operação requer os certificados/obter permissão.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(url, credential);
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
Devoluções
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. Esta operação requer os certificados/obter permissão.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(url, credential);
const certificateName = "MyCertificateName";
const latestCertificate = await client.getCertificate(certificateName);
console.log(`Latest version of the certificate ${certificateName}: `, latestCertificate);
const specificCertificate = await client.getCertificateVersion(
certificateName,
latestCertificate.properties.version,
);
console.log(
`The certificate ${certificateName} at the version ${latestCertificate.properties.version}: `,
specificCertificate,
);
Recupera um certificado do nome do certificado e de 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
Devoluções
Promise<KeyVaultCertificate>
getContacts(OperationOptions)
Retorna o conjunto de recursos de contato de certificado no cofre de chaves especificado. Esta operação requer a permissão certificates/managecontacts.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(keyVaultUrl, credential);
const contacts = await client.getContacts();
for (const contact of contacts) {
console.log(contact);
}
Define os contatos do certificado.
function getContacts(options?: OperationOptions): Promise<undefined | CertificateContact[]>
Parâmetros
- options
- OperationOptions
Os parâmetros opcionais
Devoluções
Promise<undefined | CertificateContact[]>
getDeletedCertificate(string, OperationOptions)
Recupera as informações do certificado excluído e seus atributos, como intervalo de retenção, exclusão permanente agendada e o nível de recuperação de exclusão atual. Esta operação requer os certificados/obter permissão.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(url, credential);
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
Devoluções
Promise<DeletedCertificate>
getIssuer(string, OperationOptions)
A operação getIssuer retorna os recursos especificados do emissor de certificados no cofre de chaves especificado. Esta operação requer a permissão certificates/manageissuers/getissuers.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(keyVaultUrl, credential);
const certificateIssuer = await client.getIssuer("IssuerName");
console.log(certificateIssuer);
Obtém o emissor de certificado especificado.
function getIssuer(issuerName: string, options?: OperationOptions): Promise<CertificateIssuer>
Parâmetros
- issuerName
-
string
O nome do emitente.
- options
- OperationOptions
Os parâmetros opcionais
Devoluções
Promise<CertificateIssuer>
importCertificate(string, Uint8Array, ImportCertificateOptions)
Importa um certificado válido existente, contendo uma chave privada, para o Cofre de Chaves do Azure. O certificado a ser importado pode estar no formato PFX ou PEM. Se o certificado estiver no formato PEM, o arquivo PEM deve conter a chave, bem como certificados x509. Esta operação requer a permissão de certificados/importação.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
import { SecretClient } from "@azure/keyvault-secrets";
import { isNodeLike } from "@azure/core-util";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(url, credential);
const secretClient = new SecretClient(url, credential);
const certificateSecret = await secretClient.getSecret("MyCertificate");
const base64EncodedCertificate = certificateSecret.value!;
const buffer = isNodeLike
? Buffer.from(base64EncodedCertificate, "base64")
: 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 formatado PFX ou ASCII PEM do certificado que contém os certificados X.509 e a chave privada
- options
- ImportCertificateOptions
Os parâmetros opcionais
Devoluções
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. Esta operação inclui informações específicas de exclusão. Esta operação requer a permissão certificates/get/list. Esta operação só pode ser ativada em cofres habilitados para exclusão suave.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(url, credential);
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 de certificados excluídos
function listDeletedCertificates(options?: ListDeletedCertificatesOptions): PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>
Parâmetros
- options
- ListDeletedCertificatesOptions
Os parâmetros opcionais
Devoluções
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)
Itera a versão mais recente de todos os certificados no vault. O identificador completo do certificado e os atributos são fornecidos na resposta. Nenhum valor é retornado para os certificados. Esta operação requer a permissão de certificados/lista.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(keyVaultUrl, credential);
// 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);
}
}
Liste todas as versões do certificado especificado.
function listPropertiesOfCertificates(options?: ListPropertiesOfCertificatesOptions): PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>
Parâmetros
Os parâmetros opcionais
Devoluções
listPropertiesOfCertificateVersions(string, OperationOptions)
Retorna as versões de um certificado no cofre de chaves especificado. Esta operação requer a permissão de certificados/lista.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(keyVaultUrl, credential);
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
- certificateName
-
string
O nome do certificado.
- options
- OperationOptions
Os parâmetros opcionais
Devoluções
listPropertiesOfIssuers(OperationOptions)
Retorna o conjunto de recursos do emissor de certificados no cofre de chaves especificado. Esta operação requer a permissão certificates/manageissuers/getissuers.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(keyVaultUrl, credential);
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 de certificados.
function listPropertiesOfIssuers(options?: OperationOptions): PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>
Parâmetros
- options
- OperationOptions
Os parâmetros opcionais
Devoluções
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 a permissão de certificados/criação.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
import { writeFileSync, readFileSync } from "node:fs";
import { execSync } from "node:child_process";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(url, credential);
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");
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
execSync("openssl x509 -req -in test.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out test.crt");
const base64Crt = readFileSync("test.crt").toString().split("\n").slice(1, -1).join("");
await client.mergeCertificate("MyCertificate", [Buffer.from(base64Crt)]);
Mescla uma solicitação de certificado assinada em um certificado pendente
function mergeCertificate(certificateName: string, x509Certificates: Uint8Array[], options?: OperationOptions): Promise<KeyVaultCertificateWithPolicy>
Parâmetros
- certificateName
-
string
O nome do certificado
- x509Certificates
-
Uint8Array[]
O(s) certificado(s) a fundir
- options
- OperationOptions
Os parâmetros opcionais
Devoluções
Promise<KeyVaultCertificateWithPolicy>
purgeDeletedCertificate(string, OperationOptions)
Executa uma exclusão irreversível do certificado especificado, sem possibilidade de recuperação. A operação não estará disponível se o nível de recuperação não especificar 'Purgeable'. Esta operação requer a permissão de certificado/limpeza.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(url, credential);
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
Devoluções
Promise<null>
restoreCertificateBackup(Uint8Array, OperationOptions)
Restaura um certificado de backup e todas as suas versões em um cofre. Esta operação requer a permissão de certificados/restauração.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(url, credential);
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 a ser restaurado a partir de
- options
- OperationOptions
Os parâmetros opcionais
Devoluções
Promise<KeyVaultCertificateWithPolicy>
setContacts(CertificateContact[], OperationOptions)
Define os contatos de certificado para o cofre de chaves. Esta operação requer a permissão certificates/managecontacts.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(keyVaultUrl, credential);
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
Os contactos a utilizar
- options
- OperationOptions
Os parâmetros opcionais
Devoluções
Promise<undefined | CertificateContact[]>
updateCertificatePolicy(string, CertificatePolicy, OperationOptions)
Atualiza a política de certificado para o 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
- certificateName
-
string
O nome do certificado
- policy
- CertificatePolicy
A política de certificado
- options
- OperationOptions
Os parâmetros opcionais
Devoluções
Promise<CertificatePolicy>
updateCertificateProperties(string, string, UpdateCertificatePropertiesOptions)
Aplica a atualização especificada no certificado fornecido; Os únicos elementos atualizados são os atributos do certificado. Esta operação requer a permissão de certificados/atualização.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(url, credential);
// 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 um certificado
function updateCertificateProperties(certificateName: string, version: string, options?: UpdateCertificatePropertiesOptions): 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
Devoluções
Promise<KeyVaultCertificate>
updateIssuer(string, UpdateIssuerOptions)
A operação updateIssuer executa uma atualização na entidade emissora de certificado especificada. Esta operação requer a permissão de certificados/setissuers.
Exemplo de uso:
import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;
const client = new CertificateClient(keyVaultUrl, credential);
await client.updateIssuer("IssuerName", {
provider: "Provider2",
});
Atualiza o emissor de certificado especificado.
function updateIssuer(issuerName: string, options?: UpdateIssuerOptions): Promise<CertificateIssuer>
Parâmetros
- issuerName
-
string
O nome do emitente.
- options
- UpdateIssuerOptions
Os parâmetros opcionais
Devoluções
Promise<CertificateIssuer>