@azure/keyvault-certificates package

Classi

Client per interagire con la funzionalità dei certificati KeyVault

Interfacce

AdministratorContact	Dettagli dell'amministratore dell'organizzazione dell'autorità emittente del certificato.
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 da CertificateClient dell'insieme di credenziali delle chiavi
CertificateContactAll	Forma delle informazioni di contatto per i certificati dell'insieme di credenziali.
CertificateIssuer	Interfaccia che rappresenta le proprietà di un'emittente.
CertificateOperation	Un'operazione di certificato viene restituita 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), beginDeleteCertificate(string, CertificatePollerOptions) e 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à emittente gestita dal servizio Key Vault.
IssuerCredentials	Credenziali da usare per l'autorità emittente del certificato.
IssuerParameters	Parametri per l'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 dell'insieme di credenziali delle chiavi.
KeyVaultCertificatePollOperationState	Interfaccia che rappresenta la forma pubblica dello stato delle operazioni del poller di un certificato dell'insieme di credenziali delle chiavi.
KeyVaultCertificateWithPolicy	Interfaccia che rappresenta un certificato con i relativi criteri
LifetimeAction	Azione e trigger che verranno eseguiti da Key Vault per tutta la durata di un certificato.
ListDeletedCertificatesOptions	Interfaccia che rappresenta i parametri facoltativi per le operazioni di paging CertificateClient passate a listDeletedCertificates(ListDeletedCertificatesOptions).
ListPropertiesOfCertificatesOptions	Interfaccia che rappresenta i parametri facoltativi per le operazioni di paging CertificateClient passate a listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).
PolicySubjectProperties	Interfaccia che rappresenta le possibili proprietà del soggetto dei criteri di un certificato. Il tipo finale richiede che esista almeno una di queste proprietà.
PollerLike	Rappresentazione astratta di un poller, destinata a esporre solo l'API minima con cui l'utente deve lavorare.
PollerLikeWithCancellation	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	Azione che verrà eseguita.
ArrayOneOrMore	Matrice con almeno una proprietà.
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	Nome curva ellittica. Per i valori validi, vedere JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> può essere usato in modo intercambiabile con JsonWebKeyCurveName, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio curva ellittica P-256: curva ellittica NIST P-256, curva AKA SECG SECP256R1. P-384: curva ellittica NIST P-384, curva AKA SECG SECP384R1. P-521: curva ellittica NIST P-521, curva AKA SECG SECP521R1. P-256K: la curva ellittica SECP256K1 SECG.
CertificateKeyType	Tipo di coppia di chiavi da usare per il certificato. <xref:KnownJsonWebKeyType> può essere usato in modo intercambiabile con JsonWebKeyType, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio EC: curva ellittica. EC-HSM: curva ellittica con una chiave privata che non è esportabile dal modulo di protezione hardware. RSA: RSA (https://tools.ietf.org/html/rfc3447). RSA-HSM: RSA con una chiave privata che non è esportabile dal modulo di protezione hardware. oct: sequenza ottetto (usata per rappresentare chiavi simmetriche). oct-HSM: sequenza ottet con una chiave privata che non è esportabile dal modulo di protezione hardware.
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 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	Riflette il livello di ripristino di eliminazione attualmente attivo per i segreti nell'insieme di credenziali corrente. Se contiene "Purgeable", il segreto può essere eliminato definitivamente da un utente con privilegi; in caso contrario, solo il sistema può ripulire il segreto, alla fine dell'intervallo di conservazione. <xref:KnownDeletionRecoveryLevel> possono essere usati in modo intercambiabile con DeletionRecoveryLevel, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio purgeable: 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 per un'operazione di eliminazione; i dati vengono persi in modo irreversibile quando si accetta un'operazione di eliminazione a livello di entità o superiore (insieme di credenziali, gruppo di risorse, sottoscrizione e così via) Ripristinabile+Eliminabile: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente (ad esempio ripulitura). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni), a meno che non venga richiesta un'operazione di ripulitura o che la sottoscrizione venga annullata. Il sistema lo elimini definitivamente dopo 90 giorni, se non ripristinato Ripristinabile: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminazione immediata e permanente (ad esempio ripulitura). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni) e mentre la sottoscrizione è ancora disponibile. Il sistema lo elimini definitivamente dopo 90 giorni, se non ripristinato Recoverable+ProtectedSubscription: indica un insieme di credenziali e uno stato della sottoscrizione in cui l'eliminazione è recuperabile entro l'intervallo di conservazione (90 giorni), l'eliminazione immediata e permanente (ad esempio l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata in modo permanente. Il sistema lo elimini definitivamente dopo 90 giorni, se non ripristinato CustomizedRecoverable+Purgeable: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente (ad esempio, ripulire quando 7 <= SoftDeleteRetentionInDays < 90). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione, a meno che non venga richiesta un'operazione di ripulitura o che la sottoscrizione venga annullata. CustomizedRecoverable: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminazione immediata e permanente (ad esempio, ripulire quando 7 <= SoftDeleteRetentionInDays < 90). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione e mentre la sottoscrizione è ancora disponibile. CustomizedRecoverable+ProtectedSubscription: indica un insieme di credenziali e uno stato di 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 recuperabilità 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 di PollerLike di core-lro.
KeyUsageType	Utilizzi supportati di una chiave del certificato. <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: indica che la chiave del certificato può essere usata come firma digitale. nonRepudiation: indica che la chiave del certificato può essere usata per l'autenticazione. keyEncipherment: indica che la chiave del certificato può essere usata per la crittografia della chiave. crittografia dei dati: indica che la chiave del certificato può essere usata per la crittografia dei dati. keyAgreement: indica che la chiave del certificato può essere usata per determinare il contratto di chiave, ad esempio una chiave creata usando l'algoritmo del contratto di chiave Diffie-Hellman. keyCertSign: indica che la chiave del certificato può essere usata per firmare i certificati. cRLSign: indica che la chiave del certificato può essere usata per firmare un elenco di revoche di certificati. encipherOnly: indica che la chiave del certificato può essere usata solo per la crittografia. decipherOnly: indica che la chiave del certificato può essere usata solo per la decrittografia.
ListPropertiesOfCertificateVersionsOptions	Interfaccia che rappresenta i parametri facoltativi per le operazioni di paging CertificateClient passate a listPropertiesOfCertificateVersions(string, OperationOptions).
ListPropertiesOfIssuersOptions	Interfaccia che rappresenta i parametri facoltativi per le operazioni di paging CertificateClient passate a listPropertiesOfIssuers(OperationOptions).
MergeCertificateOptions	Interfaccia che rappresenta parametri facoltativi per mergeCertificate(string, Uint8Array[], OperationOptions).
PurgeDeletedCertificateOptions	Opzioni per purgeDeletedCertificate(string, OperationOptions).
RecoverDeletedCertificateState	Deprecato: rappresentazione pubblica del ripristino di un'operazione di polling del certificato eliminato
RequireAtLeastOne	RequireAtLeastOne consente di creare un tipo in cui sia necessaria almeno una delle proprietà di un'interfaccia (può essere qualsiasi proprietà). Questo funziona a causa dei tipi di utilità di TypeScript: https://www.typescriptlang.org/docs/handbook/utility-types.html Esaminiamolo: `[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 la contrassegna come richiesto `Partial<Pick<T, Exclude<keyof T, K>>>` crea un nuovo tipo con tutte le proprietà di T, ad eccezione della proprietà K. `&` è ciò che unisce il tipo con una sola proprietà obbligatoria da `Required<...>` con tutte le proprietà facoltative di `Partial<...>`. `[keyof T]` garantisce che siano consentite solo le proprietà di T.
RestoreCertificateBackupOptions	Interfaccia che rappresenta parametri facoltativi per restoreCertificateBackup(Uint8Array, OperationOptions).
SetContactsOptions	Opzioni per setContacts(CertificateContact[], OperationOptions).
SubjectAlternativeNames	Alternative alla proprietà subject. Se presente, deve avere almeno una delle proprietà di 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	Riflette il livello di ripristino di eliminazione attualmente attivo per i segreti nell'insieme di credenziali corrente. Se contiene "Purgeable", il segreto può essere eliminato definitivamente da un utente con privilegi; in caso contrario, solo il sistema può ripulire il segreto, alla fine dell'intervallo di conservazione.
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 dell'insieme di credenziali delle chiavi specificato. Un esempio è:

https://< nome-cassaforte.vault.azure.net/certificates/>< nome-certificato>/<id-versione-univoco>

Durante l'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 dell'insieme di credenziali delle chiavi specificato. Un esempio è:

https://< nome-cassaforte.vault.azure.net/certificates/>< nome-certificato>/<id-versione-univoco>

Durante l'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 dell'insieme di credenziali delle chiavi.

Restituisce

KeyVaultCertificateIdentifier

Condividi tramite

@azure/keyvault-certificates package

Classi

Interfacce

Alias tipo

Valori noti supportati dal servizio

Valori noti supportati dal servizio

Valori noti supportati dal servizio

Valori noti supportati dal servizio

Enumerazioni

Funzioni

Dettagli funzione

parseKeyVaultCertificateIdentifier(string)

Parametri

Restituisce