Condividi tramite


@azure/keyvault-common package

Interfacce

AdditionalPolicyConfig

Usato per configurare criteri aggiuntivi aggiunti alla pipeline in fase di costruzione.

CommonClientOptions

Il set comune di opzioni che i client di alto livello devono esporre.

KeepAliveOptions

Opzioni per mantenere vivo il comportamento delle connessioni HTTP.

KeyVaultAuthenticationPolicyOptions

Opzioni aggiuntive per i criteri di autenticazione basati sulla richiesta di verifica.

KeyVaultEntityIdentifier

I componenti analizzati di un identificatore di entità Key Vault.

RedirectOptions

Opzioni per la gestione delle risposte di reindirizzamento.

Alias tipo

ExtendedCommonClientOptions

Opzioni estese per i clienti comuni che includono opzioni di mantenere in vita e reindirizzare. Questo tipo combina il CommonClientOptions standard con opzioni aggiuntive per controllare il mantenimento della connessione HTTP e il comportamento di reindirizzamento.

Funzioni

keyVaultAuthenticationPolicy(TokenCredential, KeyVaultAuthenticationPolicyOptions)

Un'implementazione personalizzata della politica di autenticazione bearer-token che gestisce le sfide Key Vault e CAE.

Key Vault supporta altri schemi di autenticazione, ma garantiamo che l'autenticazione a sfida venga utilizzata inviando prima una copia della richiesta, senza autorizzazione o contenuti.

quando viene ricevuta la richiesta di verifica, verrà autenticata e usata per inviare la richiesta originale con autorizzazione.

Dopo la prima richiesta di un client, le richieste di completamento otterranno il token memorizzato nella cache, se possibile.

parseKeyVaultIdentifier(string, undefined | string)

Analizza un identificatore Key Vault nei suoi componenti.

Variabili

keyVaultAuthenticationPolicyName

Nome della politica di autenticazione di Key Vault.

Dettagli funzione

keyVaultAuthenticationPolicy(TokenCredential, KeyVaultAuthenticationPolicyOptions)

Un'implementazione personalizzata della politica di autenticazione bearer-token che gestisce le sfide Key Vault e CAE.

Key Vault supporta altri schemi di autenticazione, ma garantiamo che l'autenticazione a sfida venga utilizzata inviando prima una copia della richiesta, senza autorizzazione o contenuti.

quando viene ricevuta la richiesta di verifica, verrà autenticata e usata per inviare la richiesta originale con autorizzazione.

Dopo la prima richiesta di un client, le richieste di completamento otterranno il token memorizzato nella cache, se possibile.

function keyVaultAuthenticationPolicy(credential: TokenCredential, options?: KeyVaultAuthenticationPolicyOptions): PipelinePolicy

Parametri

credential
TokenCredential

Valori restituiti

parseKeyVaultIdentifier(string, undefined | string)

Analizza un identificatore Key Vault nei suoi componenti.

function parseKeyVaultIdentifier(collection: string, identifier: undefined | string): KeyVaultEntityIdentifier

Parametri

collection

string

La raccolta dell'identificatore Key Vault.

identifier

undefined | string

L'identificatore Key Vault da analizzare.

Valori restituiti

Dettagli delle variabili

keyVaultAuthenticationPolicyName

Nome della politica di autenticazione di Key Vault.

keyVaultAuthenticationPolicyName: "keyVaultAuthenticationPolicy"

Tipo

"keyVaultAuthenticationPolicy"