@azure/keyvault-certificates package

O cliente para interagir com a funcionalidade de certificados do KeyVault

Detalhes do administrador da organização do emissor de certificados.

O resultado do certificado de cópia de segurança, que contém o blob de cópia de segurança.

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

Os parâmetros opcionais aceites pelo CertificateClient do KeyVault

A forma das informações de contacto dos certificados do cofre.

Uma interface que representa as propriedades de um emissor.

É devolvida uma operação de certificado em caso de pedidos assíncronos.

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 requerente).

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

Uma interface que representa as propriedades de um certificado

Os nomes alternativos do requerente de um objeto X509.

Opções para <xref:createCertificate>.

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

Uma interface que representa um certificado eliminado.

O modelo de erro do servidor do cofre de chaves.

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

Os atributos de um emissor gerido pelo serviço Key Vault.

As credenciais a utilizar para o emissor de certificados.

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

Uma interface que representa as propriedades de um emissor de certificados

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

Representa os segmentos que compõem um ID de Certificado Key Vault.

Uma interface que representa a forma pública do estado de um Key Vault operações do Certificate Poller.

Uma interface que representa um certificado com a respetiva política

Ação e o respetivo acionador que serão efetuados por Key Vault ao longo da duração de um certificado.

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

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

Uma interface que representa as possíveis propriedades do assunto da política de um certificado. O tipo final requer que exista, pelo menos, uma destas propriedades.

Representação abstrata de um poller, destinada a expor apenas a API mínima com que o utilizador precisa de trabalhar.

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

Opções para <xref:updateCertificate>.

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

Propriedades do componente X509 de um certificado.

Define valores para ActionType.

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 transmitidos para beginDeleteCertificate(string, CertificatePollerOptions)

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

Opções para <xref:cancelCertificateOperation>.

As informações de contacto dos certificados do cofre. Cada contacto 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"

Define valores para JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> pode ser utilizado alternadamente com JsonWebKeyCurveName. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

P-256
P-384
P-521
P-256K

Define valores para JsonWebKeyType.
<xref:KnownJsonWebKeyType> pode ser utilizado alternadamente com JsonWebKeyType. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

EC
EC-HSM
RSA
RSA-HSM
oct
oct-HSM

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

A ação que será executada.

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

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

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

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

Opções para deleteContacts(OperationOptions).

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

Define valores para DeletionRecoveryLevel.
<xref:KnownDeletionRecoveryLevel> pode ser utilizado alternadamente com DeletionRecoveryLevel. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Removível: indica um estado do cofre no qual a eliminação é uma operação irreversível, sem a possibilidade de recuperação. Este nível corresponde a nenhuma proteção disponível numa operação Eliminar; os dados são perdidos irremediavelmente ao aceitar uma operação Eliminar ao nível da entidade ou superior (cofre, grupo de recursos, subscrição, etc.)
Recuperável+Removível: indica um estado do cofre no qual a eliminação é recuperável e que também permite a eliminação imediata e permanente (ou seja, remoção). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção (90 dias), a menos que seja pedida uma operação de Remoção ou a subscrição seja cancelada. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado
Recuperável: indica um estado do cofre no qual a eliminação é recuperável sem a possibilidade de eliminação imediata e permanente (ou seja, remoção). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção (90 dias) e enquanto a subscrição ainda está disponível. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado
Recoverable+ProtectedSubscription: indica um cofre e um estado de subscrição no qual a eliminação é recuperável dentro do intervalo de retenção (90 dias), a eliminação imediata e permanente (ou seja, remoção) não é permitida e na qual a subscrição em si não pode ser cancelada permanentemente. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado
CustomizedRecoverable+Purgeable: indica um estado do cofre no qual a eliminação é recuperável e que também permite a eliminação imediata e permanente (ou seja, remover quando 7<= SoftDeleteRetentionInDays < 90). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção, a menos que seja pedida uma operação de Remoção ou a subscrição seja cancelada.
CustomizedRecoverable: indica um estado do cofre no qual a eliminação é recuperável sem a possibilidade de eliminação imediata e permanente (ou seja, remover quando 7<= SoftDeleteRetentionInDays < 90). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção e enquanto a subscrição ainda está disponível.
CustomizedRecoverable+ProtectedSubscription: indica um cofre e um estado de subscrição no qual a eliminação é recuperável, imediata e permanente (isto é, remoção) não é permitida e na qual a subscrição em si não pode ser cancelada permanentemente quando 7<= SoftDeleteRetentionInDays < 90. Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção e também reflete o facto de a própria subscrição não poder 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.

Define valores para KeyUsageType.
<xref:KnownKeyUsageType> pode ser utilizado alternadamente com KeyUsageType. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

digitalSignature
nonRepudiation
keyEncipherment
dataEncipherment
keyAgreement
keyCertSign
cRLSign
encipherOnly
decipherOnly

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

Uma interface que representa parâmetros opcionais para operações paged CertificateClient transmitidas 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 inquérito de certificados eliminada

RequireAtLeastOne ajuda a criar um tipo em que pelo menos uma das propriedades de uma interface (pode ser qualquer propriedade) tem de existir.

Isto funciona devido aos tipos de utilitário 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 marca-o conforme necessário
• Partial<Pick<T, Exclude<keyof T, K>>> cria um novo tipo com todas as propriedades de T, exceto a partir 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 são permitidas.

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

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

Alternativas à propriedade do assunto. Se estiver presente, deverá ter, pelo menos, uma das propriedades de SubjectAlternativeNamesAll.

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

Valores conhecidos de CertificateKeyCurveName que o serviço aceita.

Valores conhecidos de CertificateKeyType que o serviço aceita.

Valores conhecidos de DeletionRecoveryLevel que o serviço aceita.

Valores conhecidos de KeyUsageType que o serviço aceita.

Emissores conhecidos para escolher uma predefinição

Analisa o ID de Certificado de Key Vault especificado. Um exemplo é:

https://.vault.azure.net/certificates//

Ao analisar o ID acima, esta função devolve:

  {
     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>"
  }