@azure/core-rest-pipeline package

Klassen

RestError

Ein benutzerdefinierter Fehlertyp für fehlerhafte Pipelineanforderungen.

Schnittstellen

AddPipelineOptions	Optionen beim Hinzufügen einer Richtlinie zur Pipeline. Wird verwendet, um Abhängigkeiten von anderen Richtlinien auszudrücken.
Agent	Eine Schnittstelle, die mit NodeJS kompatibel http.Agentist. Wir möchten vermeiden, dass die tatsächliche Schnittstelle öffentlich erneut exportiert wird, da sie je nach Laufzeitversion variieren kann.
AuthorizeRequestOnChallengeOptions	An den Rückruf von authorizeRequestOnChallenge gesendete Optionen
AuthorizeRequestOptions	An den authorizeRequest-Rückruf gesendete Optionen
AuxiliaryAuthenticationHeaderPolicyOptions	Optionen zum Konfigurieren des HilfsprogrammAuthenticationHeaderPolicy
BearerTokenAuthenticationPolicyOptions	Optionen zum Konfigurieren der bearerTokenAuthenticationPolicy
ChallengeCallbacks	Optionen zum Überschreiben der Verarbeitung von Herausforderungen bei der Kontinuierlichen Zugriffsauswertung .
DefaultRetryPolicyOptions	Optionen, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden.
ExponentialRetryPolicyOptions	Optionen, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden.
HttpClient	Die erforderliche Schnittstelle für einen Client, der HTTP-Anforderungen im Auftrag einer Pipeline sendet.
HttpHeaders	Stellt eine Gruppe von HTTP-Headern für eine Anforderung/Antwort dar. Bei Headernamen wird die Groß-/Kleinschreibung nicht beachtet.
InternalPipelineOptions	Definiert Optionen, die zum Konfigurieren interner Optionen der HTTP-Pipeline für einen SDK-Client verwendet werden.
KeyObject	Eine Schnittstelle, die mit NodeJS kompatibel tls.KeyObjectist. Wir möchten vermeiden, dass die tatsächliche Schnittstelle öffentlich erneut exportiert wird, da sie je nach Laufzeitversion variieren kann.
LogPolicyOptions	Optionen zum Konfigurieren der logPolicy.
Pipeline	Stellt eine Pipeline zum Stellen einer HTTP-Anforderung an eine URL dar. Pipelines können über mehrere Richtlinien verfügen, um die Bearbeitung jeder Anforderung vor und nach ihrer Erstellung an den Server zu verwalten.
PipelineOptions	Definiert Optionen, die zum Konfigurieren der HTTP-Pipeline für einen SDK-Client verwendet werden.
PipelinePolicy	Eine Pipelinerichtlinie bearbeitet eine Anforderung, während sie die Pipeline durchläuft. Es ist konzeptionell eine Middleware, die die Anforderung ändern darf, bevor sie erfolgt, sowie die Antwort, wenn sie empfangen wird.
PipelineRequest	Metadaten zu einer Anforderung, die von der Pipeline gestellt wird.
PipelineRequestOptions	Einstellungen zum Initialisieren einer Anforderung. Fast gleichbedeutend mit Partial, aber URL ist obligatorisch.
PipelineResponse	Metadaten zu einer Antwort, die von der Pipeline empfangen wird.
PipelineRetryOptions	Optionen, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden.
ProxySettings	Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen (nur Node.js).
PxfObject	Eine Schnittstelle, die mit NodeJS kompatibel tls.PxfObjectist. Wir möchten vermeiden, dass die tatsächliche Schnittstelle öffentlich erneut exportiert wird, da sie je nach Laufzeitversion variieren kann.
RedirectPolicyOptions	Optionen für die Behandlung von Umleitungsantworten.
RestErrorOptions	Die von RestError unterstützten Optionen.
RetryInformation	Informationen zur Wiederholungsstrategie über den aktuellen Fortschritt der Wiederholungsrichtlinie.
RetryModifiers	Eigenschaften, die das Verhalten der Wiederholungsrichtlinie ändern können.
RetryPolicyOptions	Optionen für die retryPolicy
RetryStrategy	Mit einer Wiederholungsstrategie soll definiert werden, ob ein Wiederholungsversuch durchgeführt werden soll oder nicht, und wie ein Wiederholungsversuch durchgeführt werden soll.
SystemErrorRetryPolicyOptions	Optionen, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden.
TelemetryOptions	Definiert Optionen, die zum Konfigurieren allgemeiner Telemetrie- und Ablaufverfolgungsinformationen verwendet werden.
ThrottlingRetryPolicyOptions	Optionen, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden.
TlsSettings	Stellt ein Zertifikat für die TLS-Authentifizierung dar.
TracingPolicyOptions	Optionen zum Konfigurieren der Ablaufverfolgungsrichtlinie.
UserAgentPolicyOptions	Optionen zum Hinzufügen von Benutzer-Agent-Details zu ausgehenden Anforderungen.

Typaliase

FormDataMap	Ein einfaches Objekt, das Formulardaten bereitstellt, wie aus einem Browserformular.
FormDataValue	Jeder Formulardateneintrag kann eine Zeichenfolge oder (im Browser) ein Blob sein.
HttpMethods	Unterstützte HTTP-Methoden, die beim Senden von Anforderungen verwendet werden sollen.
PipelinePhase	Richtlinien werden in Phasen ausgeführt. Die Ausführungsreihenfolge lautet: Serialisierungsphase Richtlinien nicht in einer Phase Deserialisierungsphase Wiederholungsphase Signierenphase
RawHttpHeaders	Eine HttpHeaders-Auflistung, die als einfaches JSON-Objekt dargestellt wird.
RawHttpHeadersInput	Eine HttpHeaders-Auflistung für die Eingabe, die als einfaches JSON-Objekt dargestellt wird.
RequestBodyType	Typen von Textkörpern, die für die Anforderung unterstützt werden. NodeJS.ReadableStream und () => NodeJS.ReadableStream ist nur Node. Blob, ReadableStream und () => ReadableStream sind nur Browser.
SendRequest	Eine einfache Schnittstelle zum Stellen einer Pipelineanforderung und zum Empfangen einer Antwort.
TransferProgressEvent	Ausgelöst als Reaktion auf den Upload- oder Downloadstatus.

Functions

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	Eine Richtlinie für externe Token zum x-ms-authorization-auxiliary Header. Dieser Header wird beim Erstellen einer mandantenübergreifenden Anwendung verwendet, die wir möglicherweise zur Verarbeitung von Authentifizierungsanforderungen für Ressourcen in unterschiedlichen Mandanten benötigen. Sie können ARM-Dokumentationen sehen, um eine Übersicht über die Funktionsweise dieses Features zu finden.
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	Eine Richtlinie, die ein Token von einer TokenCredential-Implementierung anfordern und dann als Bearertoken auf den Autorisierungsheader einer Anforderung anwenden kann.
createDefaultHttpClient()	Erstellen Sie den richtigen HttpClient für die aktuelle Umgebung.
createEmptyPipeline()	Erstellt eine völlig leere Pipeline. Nützlich zum Testen oder Erstellen einer benutzerdefinierten.
createHttpHeaders(RawHttpHeadersInput)	Erstellt ein -Objekt, das die HttpHeaders Schnittstelle erfüllt.
createPipelineFromOptions(InternalPipelineOptions)	Erstellen Sie eine neue Pipeline mit einem Standardsatz anpassbarer Richtlinien.
createPipelineRequest(PipelineRequestOptions)	Erstellt eine neue Pipelineanforderung mit den angegebenen Optionen. Diese Methode ermöglicht das einfache Festlegen von Standardwerten und ist nicht erforderlich.
decompressResponsePolicy()	Eine Richtlinie zum Aktivieren der Antwortdekomprimierung gemäß Accept-Encoding Header https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
defaultRetryPolicy(DefaultRetryPolicyOptions)	Eine Richtlinie, die nach drei Strategien wiederholt wird: Wenn der Server eine 429-Antwort mit einem Retry-After-Header sendet. Wenn fehler in der zugrunde liegenden Transportschicht vorhanden sind (z. B. DNS-Lookupfehler). Wenn die ausgehende Anforderung fehlschlägt, wird ein Wiederholungsversuch mit exponentiell steigender Verzögerung ausgeführt.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	Eine Richtlinie, die versucht, Anforderungen erneut auszuführen und gleichzeitig eine exponentiell zunehmende Verzögerung einführt.
formDataPolicy()	Eine Richtlinie, die FormData für die Anforderung in den Text codiert.
getDefaultProxySettings(string)	Diese Methode konvertiert eine Proxy-URL ProxySettings zur Verwendung mit ProxyPolicy. Wenn kein Argument angegeben wird, versucht es, eine Proxy-URL aus den Umgebungsvariablen HTTPS_PROXY oder HTTP_PROXYzu analysieren.
isRestError(unknown)	Typeguard für RestError
logPolicy(LogPolicyOptions)	Eine Richtlinie, die alle Anforderungen und Antworten protokolliert.
ndJsonPolicy()	ndJsonPolicy ist eine Richtlinie, die verwendet wird, um einstellungen für jede Anforderung zu steuern.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Eine Richtlinie, die es ihnen ermöglicht, Proxyeinstellungen auf alle Anforderungen anzuwenden. Wenn statische Einstellungen nicht übergeben werden, werden sie aus der HTTPS_PROXY oder HTTP_PROXY Umgebungsvariablen abgerufen.
redirectPolicy(RedirectPolicyOptions)	Eine Richtlinie zum Befolgen von Standortheadern vom Server, um die serverseitige Umleitung zu unterstützen. Im Browser wird diese Richtlinie nicht verwendet.
retryPolicy(RetryStrategy[], RetryPolicyOptions)	retryPolicy ist eine generische Richtlinie zum Aktivieren von Wiederholungsanforderungen, wenn bestimmte Bedingungen erfüllt sind
setClientRequestIdPolicy(string)	Jede PipelineRequest erhält bei der Erstellung eine eindeutige ID. Diese Richtlinie übergibt diese eindeutige ID über einen HTTP-Header, um eine bessere Telemetrie und Ablaufverfolgung zu ermöglichen.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	Eine Wiederholungsrichtlinie, die insbesondere Fehler in der zugrunde liegenden Transportschicht (z. B. DNS-Nachschlagefehler) behandeln soll, anstatt wiederholungsfähige Fehlercodes vom Server selbst zu behandeln.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)	Eine Richtlinie, die wiederholt wird, wenn der Server eine 429-Antwort mit einem Retry-After-Header sendet. Weitere Informationen finden Sie unter https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitsund https://docs.microsoft.com/en-us/azure/azure-subscription-service-limitshttps://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tlsPolicy(TlsSettings)	Ruft eine Pipelinerichtlinie ab, die das Clientzertifikat zum HttpClient-Agent zur Authentifizierung hinzufügt.
tracingPolicy(TracingPolicyOptions)	Eine einfache Richtlinie zum Erstellen von OpenTelemetry Spans für jede Anforderung, die von der Pipeline mit SpanOptions mit einem übergeordneten Element ausgeführt wird. Anforderungen ohne übergeordnete Span werden nicht aufgezeichnet.
userAgentPolicy(UserAgentPolicyOptions)	Eine Richtlinie, die den User-Agent-Header (oder äquivalent) so festlegt, dass er die Bibliotheksversion widerspiegelt.

Details zur Funktion

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Eine Richtlinie für externe Token zum x-ms-authorization-auxiliary Header. Dieser Header wird beim Erstellen einer mandantenübergreifenden Anwendung verwendet, die wir möglicherweise zur Verarbeitung von Authentifizierungsanforderungen für Ressourcen in unterschiedlichen Mandanten benötigen. Sie können ARM-Dokumentationen sehen, um eine Übersicht über die Funktionsweise dieses Features zu finden.

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Parameter

options

AuxiliaryAuthenticationHeaderPolicyOptions

Gibt zurück

PipelinePolicy

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Eine Richtlinie, die ein Token von einer TokenCredential-Implementierung anfordern und dann als Bearertoken auf den Autorisierungsheader einer Anforderung anwenden kann.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Parameter

options

BearerTokenAuthenticationPolicyOptions

Gibt zurück

PipelinePolicy

createDefaultHttpClient()

Erstellen Sie den richtigen HttpClient für die aktuelle Umgebung.

function createDefaultHttpClient(): HttpClient

Gibt zurück

HttpClient

createEmptyPipeline()

Erstellt eine völlig leere Pipeline. Nützlich zum Testen oder Erstellen einer benutzerdefinierten.

function createEmptyPipeline(): Pipeline

Gibt zurück

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Erstellt ein -Objekt, das die HttpHeaders Schnittstelle erfüllt.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parameter

rawHeaders

RawHttpHeadersInput

Ein einfaches Objekt, das erste Header darstellt

Gibt zurück

HttpHeaders

createPipelineFromOptions(InternalPipelineOptions)

Erstellen Sie eine neue Pipeline mit einem Standardsatz anpassbarer Richtlinien.

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

Parameter

options

InternalPipelineOptions

Optionen zum Konfigurieren einer benutzerdefinierten Pipeline.

Gibt zurück

Pipeline

createPipelineRequest(PipelineRequestOptions)

Erstellt eine neue Pipelineanforderung mit den angegebenen Optionen. Diese Methode ermöglicht das einfache Festlegen von Standardwerten und ist nicht erforderlich.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parameter

options

PipelineRequestOptions

Die Optionen, mit denen die Anforderung erstellt werden soll.

Gibt zurück

PipelineRequest

decompressResponsePolicy()

Eine Richtlinie zum Aktivieren der Antwortdekomprimierung gemäß Accept-Encoding Header https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

Gibt zurück

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

Eine Richtlinie, die nach drei Strategien wiederholt wird:

• Wenn der Server eine 429-Antwort mit einem Retry-After-Header sendet.
• Wenn fehler in der zugrunde liegenden Transportschicht vorhanden sind (z. B. DNS-Lookupfehler).
• Wenn die ausgehende Anforderung fehlschlägt, wird ein Wiederholungsversuch mit exponentiell steigender Verzögerung ausgeführt.

function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Parameter

options

DefaultRetryPolicyOptions

Gibt zurück

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Eine Richtlinie, die versucht, Anforderungen erneut auszuführen und gleichzeitig eine exponentiell zunehmende Verzögerung einführt.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Parameter

options

ExponentialRetryPolicyOptions

Optionen zum Konfigurieren der Wiederholungslogik.

Gibt zurück

PipelinePolicy

formDataPolicy()

Eine Richtlinie, die FormData für die Anforderung in den Text codiert.

function formDataPolicy(): PipelinePolicy

Gibt zurück

PipelinePolicy

getDefaultProxySettings(string)

Diese Methode konvertiert eine Proxy-URL ProxySettings zur Verwendung mit ProxyPolicy. Wenn kein Argument angegeben wird, versucht es, eine Proxy-URL aus den Umgebungsvariablen HTTPS_PROXY oder HTTP_PROXYzu analysieren.

function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined

Parameter

proxyUrl

string

Die URL des zu verwendenden Proxys. Kann Authentifizierungsinformationen enthalten.

Gibt zurück

ProxySettings | undefined

isRestError(unknown)

Typeguard für RestError

function isRestError(e: unknown): e

Parameter

e

unknown

Etwas, das von einer Catch-Klausel erfasst wird.

Gibt zurück

e

logPolicy(LogPolicyOptions)

Eine Richtlinie, die alle Anforderungen und Antworten protokolliert.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Parameter

options

LogPolicyOptions

Optionen zum Konfigurieren von logPolicy.

Gibt zurück

PipelinePolicy

ndJsonPolicy()

ndJsonPolicy ist eine Richtlinie, die verwendet wird, um einstellungen für jede Anforderung zu steuern.

function ndJsonPolicy(): PipelinePolicy

Gibt zurück

PipelinePolicy

proxyPolicy(ProxySettings, { customNoProxyList?: string[] })

Eine Richtlinie, die es ihnen ermöglicht, Proxyeinstellungen auf alle Anforderungen anzuwenden. Wenn statische Einstellungen nicht übergeben werden, werden sie aus der HTTPS_PROXY oder HTTP_PROXY Umgebungsvariablen abgerufen.

function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): PipelinePolicy

Parameter

proxySettings

ProxySettings

ProxySettings, die für jede Anforderung verwendet werden sollen.

options

{ customNoProxyList?: string[] }

zusätzliche Einstellungen, z. B. benutzerdefinierte NO_PROXY Muster

Gibt zurück

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Eine Richtlinie zum Befolgen von Standortheadern vom Server, um die serverseitige Umleitung zu unterstützen. Im Browser wird diese Richtlinie nicht verwendet.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parameter

options

RedirectPolicyOptions

Optionen zum Steuern des Richtlinienverhaltens.

Gibt zurück

PipelinePolicy

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy ist eine generische Richtlinie zum Aktivieren von Wiederholungsanforderungen, wenn bestimmte Bedingungen erfüllt sind

function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy

Parameter

strategies

RetryStrategy[]

options

RetryPolicyOptions

Gibt zurück

PipelinePolicy

setClientRequestIdPolicy(string)

Jede PipelineRequest erhält bei der Erstellung eine eindeutige ID. Diese Richtlinie übergibt diese eindeutige ID über einen HTTP-Header, um eine bessere Telemetrie und Ablaufverfolgung zu ermöglichen.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Parameter

requestIdHeaderName

string

Der Name des Headers, an den die Anforderungs-ID übergeben werden soll.

Gibt zurück

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Eine Wiederholungsrichtlinie, die insbesondere Fehler in der zugrunde liegenden Transportschicht (z. B. DNS-Nachschlagefehler) behandeln soll, anstatt wiederholungsfähige Fehlercodes vom Server selbst zu behandeln.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Parameter

options

SystemErrorRetryPolicyOptions

Optionen, die die Richtlinie anpassen.

Gibt zurück

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

Eine Richtlinie, die wiederholt wird, wenn der Server eine 429-Antwort mit einem Retry-After-Header sendet.

Weitere Informationen finden Sie unter https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitsund https://docs.microsoft.com/en-us/azure/azure-subscription-service-limitshttps://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

Parameter

options

ThrottlingRetryPolicyOptions

Optionen zum Konfigurieren der Wiederholungslogik.

Gibt zurück

PipelinePolicy

tlsPolicy(TlsSettings)

Ruft eine Pipelinerichtlinie ab, die das Clientzertifikat zum HttpClient-Agent zur Authentifizierung hinzufügt.

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

Parameter

tlsSettings

TlsSettings

Gibt zurück

PipelinePolicy

tracingPolicy(TracingPolicyOptions)

Eine einfache Richtlinie zum Erstellen von OpenTelemetry Spans für jede Anforderung, die von der Pipeline mit SpanOptions mit einem übergeordneten Element ausgeführt wird. Anforderungen ohne übergeordnete Span werden nicht aufgezeichnet.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Parameter

options

TracingPolicyOptions

Optionen zum Konfigurieren der Telemetriedaten, die von der Ablaufverfolgungsrichtlinie protokolliert werden.

Gibt zurück

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

Eine Richtlinie, die den User-Agent-Header (oder äquivalent) so festlegt, dass er die Bibliotheksversion widerspiegelt.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Parameter

options

UserAgentPolicyOptions

Optionen zum Anpassen des Werts des Benutzer-Agents.

Gibt zurück

PipelinePolicy