@azure/keyvault-common package

Schnittstellen

AdditionalPolicyConfig

Wird verwendet, um zusätzliche Richtlinien zu konfigurieren, die der Pipeline beim Bau hinzugefügt wurden.

CommonClientOptions

Die allgemeinen Optionen, die Clients auf hoher Ebene verfügbar machen sollen.

KeepAliveOptions

Optionen zur Erhaltung des Live-Verhaltens von HTTP-Verbindungen.

KeyVaultAuthenticationPolicyOptions

Zusätzliche Optionen für die abfragebasierte Authentifizierungsrichtlinie.

KeyVaultEntityIdentifier

Die analysierten Komponenten einer Key Vault-Entitätskennung.

RedirectOptions

Optionen für die Behandlung von Umleitungsantworten.

Typaliase

ExtendedCommonClientOptions

Erweiterte gängige Kundenoptionen, darunter "am Leben halten" und Umleitungsoptionen. Dieser Typ kombiniert die Standard-CommonClientOptions mit zusätzlichen Optionen zur Steuerung des HTTP-Verbindungs-Keep-alive- und Redirect-Verhaltens.

Functions

keyVaultAuthenticationPolicy(TokenCredential, KeyVaultAuthenticationPolicyOptions)

Eine individuelle Implementierung der Inhabertoken-Authentifizierungsrichtlinie, die Key Vault- und CAE-Herausforderungen bewältigt.

Diese Richtlinie verwendet Challenge-Authentifizierung, wobei der ursprüngliche Anfragebody zurückgehalten wird, bis die Challenge des Dienstes validiert ist.

Wenn die Challenge eingeht, wird sie authentifiziert und zur Sendung der ursprünglichen Anfrage mit Autorisierung verwendet.

Nach der ersten Anforderung eines Clients erhalten nach Möglichkeit Nachverfolgungsanforderungen das zwischengespeicherte Token.

parseKeyVaultIdentifier(string, string | undefined)

Analysiert eine Key Vault-Identikatorin in ihre Komponenten.

Variablen

keyVaultAuthenticationPolicyName

Name der Key Vault-Authentifizierungsrichtlinie.

Details zur Funktion

keyVaultAuthenticationPolicy(TokenCredential, KeyVaultAuthenticationPolicyOptions)

Eine individuelle Implementierung der Inhabertoken-Authentifizierungsrichtlinie, die Key Vault- und CAE-Herausforderungen bewältigt.

Diese Richtlinie verwendet Challenge-Authentifizierung, wobei der ursprüngliche Anfragebody zurückgehalten wird, bis die Challenge des Dienstes validiert ist.

Wenn die Challenge eingeht, wird sie authentifiziert und zur Sendung der ursprünglichen Anfrage mit Autorisierung verwendet.

Nach der ersten Anforderung eines Clients erhalten nach Möglichkeit Nachverfolgungsanforderungen das zwischengespeicherte Token.

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

Parameter

credential
TokenCredential

Gibt zurück

parseKeyVaultIdentifier(string, string | undefined)

Analysiert eine Key Vault-Identikatorin in ihre Komponenten.

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

Parameter

collection

string

Die Sammlung der Key Vault-Kennung.

identifier

string | undefined

Die zu analysierende Key Vault-Kennung.

Gibt zurück

Details zu Variablen

keyVaultAuthenticationPolicyName

Name der Key Vault-Authentifizierungsrichtlinie.

keyVaultAuthenticationPolicyName: "keyVaultAuthenticationPolicy"

Typ

"keyVaultAuthenticationPolicy"