Dela via


@azure/keyvault-common package

Gränssnitt

AdditionalPolicyConfig

Används för att konfigurera ytterligare principer som läggs till i pipelinen vid konstruktion.

CommonClientOptions

Den vanliga uppsättningen alternativ som klienter på hög nivå förväntas exponera.

KeepAliveOptions

Alternativ för att hålla HTTP-anslutningarna vid liv.

KeyVaultAuthenticationPolicyOptions

Ytterligare alternativ för den utmaningsbaserade autentiseringsprincipen.

KeyVaultEntityIdentifier

De tolkade komponenterna i en Key Vault-entitetsidentifierare.

RedirectOptions

Alternativ för hur omdirigeringssvar hanteras.

Typalias

ExtendedCommonClientOptions

Utökade vanliga klientalternativ som inkluderar att hålla sig vid liv och omdirigera alternativ. Denna typ kombinerar standarden CommonClientOptions med ytterligare alternativ för att styra HTTP-anslutningens keep-alive och omdirigeringsbeteende.

Funktioner

keyVaultAuthenticationPolicy(TokenCredential, KeyVaultAuthenticationPolicyOptions)

En anpassad implementation av identifieringspolicyn för bärartoken som hanterar Key Vault- och CAE-utmaningar.

Key Vault stöder andra autentiseringsscheman, men vi säkerställer att utmaningsautentisering används genom att först skicka en kopia av förfrågan, utan auktorisation eller innehåll.

När utmaningen tas emot autentiseras den och används för att skicka den ursprungliga begäran med auktorisering.

Efter den första begäran från en klient hämtar uppföljningsbegäranden den cachelagrade token om möjligt.

parseKeyVaultIdentifier(string, undefined | string)

Analyserar en Key Vault-identifierare i dess komponenter.

Variabler

keyVaultAuthenticationPolicyName

Namnet på Key Vault-autentiseringspolicyn.

Funktionsinformation

keyVaultAuthenticationPolicy(TokenCredential, KeyVaultAuthenticationPolicyOptions)

En anpassad implementation av identifieringspolicyn för bärartoken som hanterar Key Vault- och CAE-utmaningar.

Key Vault stöder andra autentiseringsscheman, men vi säkerställer att utmaningsautentisering används genom att först skicka en kopia av förfrågan, utan auktorisation eller innehåll.

När utmaningen tas emot autentiseras den och används för att skicka den ursprungliga begäran med auktorisering.

Efter den första begäran från en klient hämtar uppföljningsbegäranden den cachelagrade token om möjligt.

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

Parametrar

credential
TokenCredential

Returer

parseKeyVaultIdentifier(string, undefined | string)

Analyserar en Key Vault-identifierare i dess komponenter.

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

Parametrar

collection

string

Samlingen av Key Vault-identifieraren.

identifier

undefined | string

Key Vault-identifieraren som ska tolkas.

Returer

Variabelinformation

keyVaultAuthenticationPolicyName

Namnet på Key Vault-autentiseringspolicyn.

keyVaultAuthenticationPolicyName: "keyVaultAuthenticationPolicy"

Typ

"keyVaultAuthenticationPolicy"