@azure/keyvault-certificates package

O cliente para interagir com a funcionalidade de certificados KeyVault

Detalhes do administrador da organização do emissor do certificado.

O resultado do certificado de backup, contendo o blob de backup.

Uma interface que representa os parâmetros opcionais que podem ser passados para beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Os parâmetros opcionais aceitos pelo CertificateClient do KeyVault

A forma das informações de contato para os certificados do vault.

Uma interface que representa as propriedades de um emissor.

Uma operação de certificado é retornada em caso de solicitações assíncronas.

O erro do servidor do cofre de chaves.

Uma interface que representa as propriedades publicamente disponíveis do estado do CertificateOperationPoller.

Uma interface que representa a política de um certificado (sem as propriedades do assunto).

Uma interface que representa os parâmetros opcionais que podem ser passados para beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) e beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Uma interface que representa as propriedades de um certificado

O assunto alterna nomes de um objeto X509.

Opções para <xref:createCertificate>.

Opções para createIssuer(string, string, CreateIssuerOptions).

Uma interface que representa um certificado excluído.

O modelo de erro do servidor do cofre de chaves.

Opções para importCertificate(string, Uint8Array, ImportCertificateOptions).

Os atributos de um emissor gerenciado pelo serviço Cofre de Chaves.

As credenciais a serem usadas para o emissor do certificado.

Parâmetros para o emissor do componente X509 de um certificado.

Uma interface que representa as propriedades de um emissor de certificado

Uma interface que representa um certificado sem a política do certificado

Representa os segmentos que compõem uma ID de Certificado do Cofre da Chave.

Uma interface que representa a forma pública do estado das operações de um Poller de Certificados do Cofre de Chaves.

Uma interface que representa um certificado com sua política

Ação e seu gatilho que será executado pelo Key Vault ao longo da vida útil de um certificado.

Uma interface que representa parâmetros opcionais para operações paginadas CertificateClient passadas para listDeletedCertificates(ListDeletedCertificatesOptions).

Uma interface que representa parâmetros opcionais para operações paginadas CertificateClient passadas para listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).

Uma interface que representa as possíveis propriedades de assunto da política de um certificado. O tipo final requer pelo menos uma dessas propriedades para existir.

Representação abstrata de um poller, destinada a expor apenas a API mínima com a qual o usuário precisa trabalhar.

Representação abstrata de um poller, destinada a expor apenas a API mínima com a qual o usuário precisa trabalhar.

Uma interface que representa os nomes alternativos do assunto de uma política de certificado.

Opções para <xref:updateCertificate>.

Opções para updateIssuer(string, UpdateIssuerOptions).

Propriedades do componente X509 de um certificado.

A ação que será executada.

Uma matriz com uma propriedade no mínimo.

Opções para backupCertificate(string, OperationOptions).

Uma interface que representa os parâmetros opcionais que podem ser passados para beginDeleteCertificate(string, CertificatePollerOptions)

Uma interface que representa os parâmetros opcionais que podem ser passados para beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Opções para <xref:cancelCertificateOperation>.

As informações de contato dos certificados do vault. Cada contato terá pelo menos uma das propriedades de CertificateContactAll, que são: emailAddress, nome ou telefone.

Define valores para contentType. Os valores possíveis incluem: 'application/x-pem-file', 'application/x-pkcs12'

Nome da curva elíptica. Para valores válidos, consulte JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> pode ser usado de forma intercambiável com JsonWebKeyCurveName, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

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

O tipo de par de chaves a ser usado para o certificado.
<xref:KnownJsonWebKeyType> pode ser usado de forma intercambiável com JsonWebKeyType, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

EC: Curva Elíptica.
EC-HSM: Curva elíptica com uma chave privada que não é exportável do HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447).
RSA-HSM: RSA com uma chave privada que não é exportável do HSM.
out: Sequência Octet (usada para representar chaves simétricas).
oct-HSM: Sequência Octet com uma chave privada que não é exportável do HSM.

Um tipo que representa a política de um certificado com pelo menos uma das propriedades de assunto.

A ação que será executada.

Uma interface que representa a forma das Tags de Certificado. As tags são apenas pares chave-valor de cadeia de caracteres.

A representação pública do estado da operação CreateCertificatePoller.

Opções para deleteCertificateOperation(string, OperationOptions).

A representação pública do estado da operação DeleteCertificatePoller.

Opções para deleteContacts(OperationOptions).

Opções para deleteIssuer(string, OperationOptions).

Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se contiver 'Purgeable', o segredo pode ser permanentemente eliminado por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar o segredo, no final do intervalo de retenção.
<xref:KnownDeletionRecoveryLevel> pode ser usado de forma intercambiável com DeletionRecoveryLevel, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Purgeable: Indica um estado vault no qual a exclusão é uma operação irreversível, sem a possibilidade de recuperação. Este nível corresponde a nenhuma proteção disponível contra uma operação Delete; os dados são irremediavelmente perdidos ao aceitar uma operação de Exclusão no nível da entidade ou superior (cofre, grupo de recursos, assinatura, etc.)
Recoverable+Purgeable: Indica um estado vault no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, purga). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias), a menos que uma operação de limpeza seja solicitada ou a assinatura seja cancelada. O sistema irá excluí-lo permanentemente após 90 dias, se não for recuperado
recuperável : Indica um estado vault no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, purga). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias) e enquanto a assinatura ainda estiver disponível. O sistema irá excluí-lo permanentemente após 90 dias, se não for recuperado
Recoverable+ProtectedSubscription: indica um estado de cofre e assinatura no qual a exclusão é recuperável dentro do intervalo de retenção (90 dias), a exclusão imediata e permanente (ou seja, limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente. O sistema irá excluí-lo permanentemente após 90 dias, se não for recuperado
CustomizedRecoverable+Purgeable: Indica um estado do cofre no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, purga quando 7 <= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção, a menos que uma operação Purge seja solicitada ou a assinatura seja cancelada.
CustomizedRecoverable: Indica um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpeza quando 7 <= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e enquanto a assinatura ainda estiver disponível.
CustomizedRecoverable+ProtectedSubscription: Indica um estado de cofre e assinatura no qual a exclusão é recuperável, a exclusão imediata e permanente (ou seja, limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente quando 7 <= SoftDeleteRetentionInDays < 90. Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e também reflete o fato de que a assinatura em si não pode ser cancelada.

Opções para getCertificateOperation(string, CertificatePollerOptions).

Opções para getCertificate(string, OperationOptions).

Opções para getCertificatePolicy(string, OperationOptions).

Opções para getCertificateVersion(string, string, OperationOptions).

Opções para getContacts(OperationOptions).

Opções para getDeletedCertificate(string, OperationOptions).

Opções para getIssuer(string, OperationOptions).

Opções para <xref:getPlainCertificateOperation>.

Um tipo que representa a política de importação de um certificado que não requer uma SAN ou um Assunto

Cópia do KeyVault preterida do PollerLike do core-lro.

Usos suportados de uma chave de certificado.
<xref:KnownKeyUsageType> pode ser usado de forma intercambiável com KeyUsageType, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

digitalSignature: Indica que a chave do certificado pode ser usada como uma assinatura digital.
nonRepudiation: Indica que a chave de certificado pode ser usada para autenticação.
keyEncipherment: Indica que a chave de certificado pode ser usada para criptografia de chave.
dataEncipherment: indica que a chave do certificado pode ser usada para criptografia de dados.
keyAgreement: Indica que a chave de certificado pode ser usada para determinar o acordo de chave, como uma chave criada usando o algoritmo de acordo de chave Diffie-Hellman.
keyCertSign: indica que a chave de certificado pode ser usada para assinar certificados.
cRLSign : Indica que a chave de certificado pode ser usada para assinar uma lista de revogação de certificados.
encipherOnly: Indica que a chave do certificado pode ser usada apenas para criptografia.
decipherOnly: Indica que a chave de certificado pode ser usada apenas para desencriptação.

Uma interface que representa parâmetros opcionais para operações paginadas CertificateClient passadas para listPropertiesOfCertificateVersions(string, OperationOptions).

Uma interface que representa parâmetros opcionais para operações paginadas CertificateClient passadas para listPropertiesOfIssuers(OperationOptions).

Uma interface que representa parâmetros opcionais para mergeCertificate(string, Uint8Array[], OperationOptions).

Opções para purgeDeletedCertificate(string, OperationOptions).

Preterido: representação pública da recuperação de uma operação de pesquisa de certificado excluído

RequireAtLeastOne ajuda a criar um tipo onde pelo menos uma das propriedades de uma interface (pode ser qualquer propriedade) é necessária para existir.

Isso funciona devido aos tipos de utilidade do TypeScript: https://www.typescriptlang.org/docs/handbook/utility-types.html Vamos examiná-lo:

• [K in keyof T]-? esta propriedade (K) só é válida se tiver o mesmo nome que qualquer propriedade de T.
• Required<Pick<T, K>> cria um novo tipo de T apenas com a propriedade atual na iteração e a marca conforme necessário
• Partial<Pick<T, Exclude<keyof T, K>>> faz um novo tipo com todas as propriedades de T, exceto da propriedade K.
• & é o que une o tipo com apenas uma propriedade necessária de Required<...> com todas as propriedades opcionais de Partial<...>.
• [keyof T] garante que apenas as propriedades de T sejam permitidas.

Uma interface que representa parâmetros opcionais para restoreCertificateBackup(Uint8Array, OperationOptions).

Opções para setContacts(CertificateContact[], OperationOptions).

Alternativas à propriedade do sujeito. Se presente, ele deve ter pelo menos uma das propriedades de SubjectAlternativeNamesAll.

Opções para updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

Os valores conhecidos de CertificateKeyCurveName que o serviço aceita.

Os valores conhecidos de CertificateKeyType que o serviço aceita.

Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se contiver 'Purgeable', o segredo pode ser permanentemente eliminado por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar o segredo, no final do intervalo de retenção.

Valores conhecidos de KeyUsageType que o serviço aceita.

Emissores bem conhecidos para escolher um padrão

Analisa a ID do certificado do Key Vault fornecida. Um exemplo é:

https://< keyvault-name.vault.azure.net/certificates/<> certificate-name>/<unique-version-id>

Ao analisar o ID acima, essa função retorna:

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