@azure/keyvault-certificates package

Classi

CertificateClient

Client per interagire con la funzionalità dei certificati KeyVault

Interfacce

AdministratorContact	Dettagli dell'amministratore dell'organizzazione dell'autorità di certificazione.
BackupCertificateResult	Risultato del certificato di backup contenente il BLOB di backup.
BeginCreateCertificateOptions	Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)
CertificateClientOptions	Parametri facoltativi accettati dal CertificateClient di KeyVault
CertificateContactAll	Forma delle informazioni di contatto per i certificati dell'insieme di credenziali.
CertificateIssuer	Interfaccia che rappresenta le proprietà di un'autorità di certificazione.
CertificateOperation	Viene restituita un'operazione di certificato in caso di richieste asincrone.
CertificateOperationError	Errore del server dell'insieme di credenziali delle chiavi.
CertificateOperationState	Interfaccia che rappresenta le proprietà disponibili pubblicamente dello stato di CertificateOperationPoller.
CertificatePolicyProperties	Interfaccia che rappresenta i criteri di un certificato (senza le proprietà del soggetto).
CertificatePollerOptions	Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)e beginDeleteCertificate(string, CertificatePollerOptions)beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CertificateProperties	Interfaccia che rappresenta le proprietà di un certificato
CoreSubjectAlternativeNames	Nomi alternativi dell'oggetto di un oggetto X509.
CreateCertificateOptions	Opzioni per <xref:createCertificate>.
CreateIssuerOptions	Opzioni per createIssuer(string, string, CreateIssuerOptions).
DeletedCertificate	Interfaccia che rappresenta un certificato eliminato.
ErrorModel	Modello di errore del server dell'insieme di credenziali delle chiavi.
ImportCertificateOptions	Opzioni per importCertificate(string, Uint8Array, ImportCertificateOptions).
IssuerAttributes	Attributi di un'autorità di certificazione gestita dal servizio Key Vault.
IssuerCredentials	Credenziali da usare per l'autorità di certificazione.
IssuerParameters	Parametri per l'autorità emittente del componente X509 di un certificato.
IssuerProperties	Interfaccia che rappresenta le proprietà di un'autorità di certificazione
KeyVaultCertificate	Interfaccia che rappresenta un certificato senza i criteri del certificato
KeyVaultCertificateIdentifier	Rappresenta i segmenti che compongono un ID certificato Key Vault.
KeyVaultCertificatePollOperationState	Interfaccia che rappresenta la forma pubblica dello stato delle operazioni di un Key Vault Certificato Poller.
KeyVaultCertificateWithPolicy	Interfaccia che rappresenta un certificato con i relativi criteri
LifetimeAction	Azione e trigger che verranno eseguiti da Key Vault durante la durata di un certificato.
ListDeletedCertificatesOptions	Interfaccia che rappresenta i parametri facoltativi per le operazioni di pagina CertificateClient passate a listDeletedCertificates(ListDeletedCertificatesOptions).
ListPropertiesOfCertificatesOptions	Interfaccia che rappresenta i parametri facoltativi per le operazioni di pagina CertificateClient passate a listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).
PolicySubjectProperties	Interfaccia che rappresenta le possibili proprietà oggetto dei criteri di un certificato. Il tipo finale richiede almeno una di queste proprietà.
PollerLike	Rappresentazione astratta di un poller, destinata a esporre solo l'API minima con cui l'utente deve lavorare.
SubjectAlternativeNamesAll	Interfaccia che rappresenta i nomi alternativi dell'oggetto di un criterio di certificato.
UpdateCertificateOptions	Opzioni per <xref:updateCertificate>.
UpdateIssuerOptions	Opzioni per updateIssuer(string, UpdateIssuerOptions).
X509CertificateProperties	Proprietà del componente X509 di un certificato.

Alias tipo

ActionType	Definisce i valori per ActionType.
ArrayOneOrMore	Matrice con una proprietà minima.
BackupCertificateOptions	Opzioni per backupCertificate(string, OperationOptions).
BeginDeleteCertificateOptions	Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginDeleteCertificate(string, CertificatePollerOptions)
BeginRecoverDeletedCertificateOptions	Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CancelCertificateOperationOptions	Opzioni per <xref:cancelCertificateOperation>.
CertificateContact	Informazioni di contatto per i certificati dell'insieme di credenziali. Ogni contatto avrà almeno una delle proprietà di CertificateContactAll, ovvero emailAddress, nome o telefono.
CertificateContentType	Definisce i valori per contentType. I valori possibili includono: 'application/x-pem-file', 'application/x-pkcs12'
CertificateKeyCurveName	Definisce i valori per JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> può essere usato in modo interscambiabile con JsonWebKeyCurveName, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio P-256 P-384 P-521 P-256K
CertificateKeyType	Definisce i valori per JsonWebKeyType. <xref:KnownJsonWebKeyType> può essere usato in modo interscambiabile con JsonWebKeyType, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio EC EC-HSM RSA RSA-HSM Ottobre oct-HSM
CertificatePolicy	Tipo che rappresenta i criteri di un certificato con almeno una delle proprietà del soggetto.
CertificatePolicyAction	Azione che verrà eseguita.
CertificateTags	Interfaccia che rappresenta la forma dei tag di certificato. I tag sono solo coppie chiave-valore stringa.
CreateCertificateState	Rappresentazione pubblica dello stato dell'operazione CreateCertificatePoller.
DeleteCertificateOperationOptions	Opzioni per deleteCertificateOperation(string, OperationOptions).
DeleteCertificateState	Rappresentazione pubblica dello stato dell'operazione DeleteCertificatePoller.
DeleteContactsOptions	Opzioni per deleteContacts(OperationOptions).
DeleteIssuerOptions	Opzioni per deleteIssuer(string, OperationOptions).
DeletionRecoveryLevel	Definisce i valori per DeletionRecoveryLevel. <xref:KnownDeletionRecoveryLevel> può essere usato in modo interscambiabile con DeletionRecoveryLevel, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Eliminabile: indica uno stato dell'insieme di credenziali in cui l'eliminazione è un'operazione irreversibile, senza la possibilità di ripristino. Questo livello corrisponde a nessuna protezione disponibile su un'operazione Di eliminazione; i dati sono irreperibili quando si accetta un'operazione Di eliminazione a livello di entità o superiore (insieme di credenziali, gruppo di risorse, sottoscrizione e così via) Recuperabile+Eliminabile: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente (ad esempio l'eliminazione). Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni), a meno che non venga richiesta un'operazione di eliminazione o la sottoscrizione venga annullata. Il sistema lo elimina definitivamente dopo 90 giorni, se non ripristinato Recuperabile: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminazione immediata e permanente (ad esempio l'eliminazione). Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione(90 giorni) e mentre la sottoscrizione è ancora disponibile. Il sistema lo elimina definitivamente dopo 90 giorni, se non ripristinato Recuperabile+ProtectedSubscription: indica uno stato di insieme di credenziali e sottoscrizione in cui l'eliminazione è recuperabile entro l'intervallo di conservazione (90 giorni), l'eliminazione immediata e permanente (ovvero l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata definitivamente. Il sistema lo elimina definitivamente dopo 90 giorni, se non ripristinato CustomdRecoverable+Purgeable: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente ,ad esempio, quando 7<= SoftDeleteRetentionInDays < 90. Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione, a meno che non venga richiesta un'operazione di eliminazione o la sottoscrizione venga annullata. CustomdRecoverable: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminare immediatamente e definitivamente (ad esempio, eliminare quando 7<= SoftDeleteRetentionInDays < 90). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione e mentre la sottoscrizione è ancora disponibile. CustomdRecoverable+ProtectedSubscription: indica uno stato dell'insieme di credenziali e della sottoscrizione in cui l'eliminazione è recuperabile, immediata e permanente (ovvero l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata definitivamente quando 7<= SoftDeleteRetentionInDays < 90. Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione e riflette anche il fatto che la sottoscrizione stessa non può essere annullata.
GetCertificateOperationOptions	Opzioni per getCertificateOperation(string, CertificatePollerOptions).
GetCertificateOptions	Opzioni per getCertificate(string, OperationOptions).
GetCertificatePolicyOptions	Opzioni per getCertificatePolicy(string, OperationOptions).
GetCertificateVersionOptions	Opzioni per getCertificateVersion(string, string, OperationOptions).
GetContactsOptions	Opzioni per getContacts(OperationOptions).
GetDeletedCertificateOptions	Opzioni per getDeletedCertificate(string, OperationOptions).
GetIssuerOptions	Opzioni per getIssuer(string, OperationOptions).
GetPlainCertificateOperationOptions	Opzioni per <xref:getPlainCertificateOperation>.
ImportCertificatePolicy	Tipo che rappresenta i criteri di un certificato per l'importazione che non richiede una san o un oggetto
KVPollerLike	Copia deprecata di KeyVault del pollerLike di core-lro.
KeyUsageType	Definisce i valori per KeyUsageType. <xref:KnownKeyUsageType> può essere usato in modo intercambiabile con KeyUsageType, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Digitalsignature nonRepudiation keyEncipherment dataEncipherment keyAgreement keyCertSign cRLSign encipherOnly decipherOnly
ListPropertiesOfCertificateVersionsOptions	Interfaccia che rappresenta i parametri facoltativi per le operazioni di pagina CertificateClient passate a listPropertiesOfCertificateVersions(string, OperationOptions).
ListPropertiesOfIssuersOptions	Interfaccia che rappresenta i parametri facoltativi per le operazioni di pagina CertificateClient passate a listPropertiesOfIssuers(OperationOptions).
MergeCertificateOptions	Interfaccia che rappresenta i parametri facoltativi per mergeCertificate(string, Uint8Array[], OperationOptions).
PurgeDeletedCertificateOptions	Opzioni per purgeDeletedCertificate(string, OperationOptions).
RecoverDeletedCertificateState	Deprecato: rappresentazione pubblica del recupero di un'operazione di polling del certificato eliminata
RequireAtLeastOne	RequireAtLeastOne consente di creare un tipo in cui è necessaria almeno una delle proprietà di un'interfaccia (può essere qualsiasi proprietà). Ciò funziona a causa dei tipi di utilità di TypeScript: esaminiamolo: https://www.typescriptlang.org/docs/handbook/utility-types.html [K in keyof T]-? questa proprietà (K) è valida solo se ha lo stesso nome di qualsiasi proprietà di T. Required<Pick<T, K>> crea un nuovo tipo da T con solo la proprietà corrente nell'iterazione e lo contrassegna come richiesto Partial<Pick<T, Exclude<keyof T, K>>> rende un nuovo tipo con tutte le proprietà di T, ad eccezione della proprietà K. & è ciò che unisce il tipo a una sola proprietà obbligatoria da Required<...> con tutte le proprietà facoltative da Partial<...>. [keyof T] garantisce che siano consentite solo le proprietà di T.
RestoreCertificateBackupOptions	Interfaccia che rappresenta i parametri facoltativi per restoreCertificateBackup(Uint8Array, OperationOptions).
SetContactsOptions	Opzioni per setContacts(CertificateContact[], OperationOptions).
SubjectAlternativeNames	Alternative alla proprietà oggetto. Se presente, deve avere almeno una delle proprietà SubjectAlternativeNamesAll.
UpdateCertificatePolicyOptions	Opzioni per updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

Enumerazioni

KnownCertificateKeyCurveNames	Valori noti di CertificateKeyCurveName accettati dal servizio.
KnownCertificateKeyTypes	Valori noti di CertificateKeyType accettati dal servizio.
KnownDeletionRecoveryLevels	Valori noti di DeletionRecoveryLevel accettati dal servizio.
KnownKeyUsageTypes	Valori noti di KeyUsageType accettati dal servizio.
WellKnownIssuer	Autorità emittenti note per la scelta di un valore predefinito

Funzioni

parseKeyVaultCertificateIdentifier(string)

Analizza l'ID certificato specificato Key Vault. Un esempio è: https://.vault.azure.net/certificates// Nell'analisi dell'ID precedente, questa funzione restituisce: { 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>" }

Dettagli funzione

parseKeyVaultCertificateIdentifier(string)

Analizza l'ID certificato specificato Key Vault. Un esempio è:

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

Nell'analisi dell'ID precedente, questa funzione restituisce:

  {
     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

Parametri

id

string

ID del certificato di Key Vault.

Restituisce

KeyVaultCertificateIdentifier