Share via

@azure/keyvault-certificates package

  • Referência

Classes

CertificateClient

O cliente para interagir com a funcionalidade de certificados KeyVault

Interfaces

AdministratorContact

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

O resultado do certificado de backup, que contém o blob de backup.
BeginCreateCertificateOptions

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

Os parâmetros opcionais aceitos pelo CertificateClient do KeyVault
CertificateContactAll

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

Uma interface que representa as propriedades de um emissor.
CertificateOperation

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

O erro do servidor do cofre de chaves.
CertificateOperationState

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

Uma interface que representa a política de um certificado (sem as propriedades da entidade).
CertificatePollerOptions

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

Uma interface que representa as propriedades de um certificado
CoreSubjectAlternativeNames

Os nomes alternativos de assunto de um objeto X509.
CreateCertificateOptions

Opções para <xref:createCertificate>.
CreateIssuerOptions

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

Uma interface que representa um certificado excluído.
ErrorModel

O modelo de erro do servidor do cofre de chaves.
ImportCertificateOptions

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

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

As credenciais a serem usadas para o emissor do certificado.
IssuerParameters

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

Uma interface que representa as propriedades de um emissor de certificado
KeyVaultCertificate

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

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

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

Uma interface que representa um certificado com sua política
LifetimeAction

A ação e seu gatilho que serão executados por Key Vault ao longo do tempo de vida de um certificado.
ListDeletedCertificatesOptions

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

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

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

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

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

Opções para <xref:updateCertificate>.
UpdateIssuerOptions

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

Propriedades do componente X509 de um certificado.

Aliases de tipo

ActionType

Define valores para ActionType.
ArrayOneOrMore

Uma matriz com uma propriedade no mínimo.
BackupCertificateOptions

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

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

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

Opções para <xref:cancelCertificateOperation>.
CertificateContact

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

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

Define valores para JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> pode ser usado de forma intercambiável com JsonWebKeyCurveName, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

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

Define valores para JsonWebKeyType.
<xref:KnownJsonWebKeyType> pode ser usado de forma intercambiável com JsonWebKeyType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

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

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

A ação que será executada.
CertificateTags

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

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

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

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

Opções para deleteContacts(OperationOptions).
DeleteIssuerOptions

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

Define valores para DeletionRecoveryLevel.
<xref:KnownDeletionRecoveryLevel> pode ser usado de forma intercambiável com DeletionRecoveryLevel, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Purgável: indica um estado de cofre no qual a exclusão é uma operação irreversível, sem a possibilidade de recuperação. Esse nível corresponde a nenhuma proteção disponível em relação a uma operação De exclusão; 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.)
Recuperável+Purgável: indica um estado de cofre no qual a exclusão é recuperável e que também permite exclusão imediata e permanente (ou seja, limpeza). 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 o excluirá permanentemente após 90 dias, se não for recuperado
Recuperável: indica um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpeza). 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 o excluirá permanentemente após 90 dias, se não for recuperado
Recoverable+ProtectedSubscription: indica um cofre e um estado de 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 o excluirá permanentemente após 90 dias, se não for recuperado
CustomizedRecoverable+Purgeable: denota um estado de cofre no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, limpar 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 de limpeza 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, limpar 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 está disponível.
CustomizedRecoverable+ProtectedSubscription: denota um cofre e um estado de 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 própria assinatura não pode ser cancelada.
GetCertificateOperationOptions

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

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

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

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

Opções para getContacts(OperationOptions).
GetDeletedCertificateOptions

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

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

Opções para <xref:getPlainCertificateOperation>.
ImportCertificatePolicy

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

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

Define valores para KeyUsageType.
<xref:KnownKeyUsageType> pode ser usado de forma intercambiável com KeyUsageType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Digitalsignature
nonRepudiation
keyEncipherment
dataEncipherment
keyAgreement
keyCertSign
cRLSign
encipherOnly
decipherOnly
ListPropertiesOfCertificateVersionsOptions

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

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

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

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

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

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

Isso 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]-? essa propriedade (K) só será válida se tiver o mesmo nome que qualquer propriedade de T.
  • Required<Pick<T, K>> faz um novo tipo de T com apenas a propriedade atual na iteração e marca-o como 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 somente as propriedades de T sejam permitidas.
RestoreCertificateBackupOptions

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

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

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

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

Enumerações

KnownCertificateKeyCurveNames

Valores conhecidos de CertificateKeyCurveName que o serviço aceita.
KnownCertificateKeyTypes

Valores conhecidos de CertificateKeyType que o serviço aceita.
KnownDeletionRecoveryLevels

Valores conhecidos de DeletionRecoveryLevel que o serviço aceita.
KnownKeyUsageTypes

Valores conhecidos de KeyUsageType que o serviço aceita.
WellKnownIssuer

Emissores conhecidos para escolher um padrão

Funções

parseKeyVaultCertificateIdentifier(string)

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

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

Ao analisar a 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>"
  }

Detalhes da função

parseKeyVaultCertificateIdentifier(string)

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

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

Ao analisar a 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>"
  }

function parseKeyVaultCertificateIdentifier(id: string): KeyVaultCertificateIdentifier

Parâmetros

id

string

A ID do Certificado Key Vault.

Retornos

KeyVaultCertificateIdentifier