@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
| key |
En anpassad implementation av identifieringspolicyn för bärartoken som hanterar Key Vault- och CAE-utmaningar. Denna policy använder utmaningsautentisering och håller tillbaka den ursprungliga förfrågningskroppen tills tjänstens invändning har validerats. När utmaningen tas emot kommer den att autentiseras och användas för att skicka den ursprungliga begäran med auktorisation. Efter den första begäran från en klient hämtar uppföljningsbegäranden den cachelagrade token om möjligt. |
| parse |
Analyserar en Key Vault-identifierare i dess komponenter. |
Variabler
| key |
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.
Denna policy använder utmaningsautentisering och håller tillbaka den ursprungliga förfrågningskroppen tills tjänstens invändning har validerats.
När utmaningen tas emot kommer den att autentiseras och användas för att skicka den ursprungliga begäran med auktorisation.
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, string | undefined)
Analyserar en Key Vault-identifierare i dess komponenter.
function parseKeyVaultIdentifier(collection: string, identifier: string | undefined): KeyVaultEntityIdentifier
Parametrar
- collection
-
string
Samlingen av Key Vault-identifieraren.
- identifier
-
string | undefined
Key Vault-identifieraren som ska tolkas.
Returer
Variabelinformation
keyVaultAuthenticationPolicyName
Namnet på Key Vault-autentiseringspolicyn.
keyVaultAuthenticationPolicyName: "keyVaultAuthenticationPolicy"
Typ
"keyVaultAuthenticationPolicy"