@azure/core-rest-pipeline package
Klassen
| RestError |
Ein benutzerdefinierter Fehlertyp für fehlgeschlagene 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 dem |
| AuthorizeRequestOnChallengeOptions |
An den authorizeRequestOnChallenge-Rückruf gesendete Optionen |
| AuthorizeRequestOptions |
An den authorizeRequest-Rückruf gesendete Optionen |
| AuxiliaryAuthenticationHeaderPolicyOptions |
Optionen zum Konfigurieren der hilfsautorisierenAuthenticationHeaderPolicy |
| BearerTokenAuthenticationPolicyOptions |
Optionen zum Konfigurieren der BearerTokenAuthenticationPolicy |
| BodyPart |
Ein Teil des Anforderungstexts in einer mehrteiligen Anforderung. |
| ChallengeCallbacks |
Optionen zum Außerkraftsetzen der Verarbeitung von Kontinuierlichen Zugriffsauswertung Herausforderungen. |
| CreateFileFromStreamOptions |
Zusätzliche Optionen für createFile, wenn ein Datenstrom übergeben wird. |
| CreateFileOptions |
An createFile übergebene Optionen, die Metadaten zur Datei angeben. |
| DefaultRetryPolicyOptions |
Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden. |
| ExponentialRetryPolicyOptions |
Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden. |
| HttpClient |
Die erforderliche Schnittstelle für einen Client, der HTTP-Anforderungen im Auftrag einer Pipeline sendet. |
| HttpHeaders |
Stellt eine Reihe von HTTP-Headern für eine Anforderung/Antwort dar. Kopfzeilennamen werden bei nicht beachteter Groß-/Kleinschreibung behandelt. |
| InternalPipelineOptions |
Definiert Optionen, die zum Konfigurieren interner Optionen der HTTP-Pipeline für einen SDK-Client verwendet werden. |
| KeyObject |
Eine Schnittstelle, die mit dem |
| LogPolicyOptions |
Optionen zum Konfigurieren der logPolicy. |
| MultipartRequestBody |
Ein Anforderungstext, der aus mehreren Teilen besteht. |
| Pipeline |
Stellt eine Pipeline zum Erstellen einer HTTP-Anforderung an eine URL dar. Pipelines können über mehrere Richtlinien verfügen, um die Bearbeitung jeder Anforderung vor und nach dem Ausführen 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 durch die Pipeline geht. Es handelt sich um 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 Partielle, url ist jedoch obligatorisch. |
| PipelineResponse |
Metadaten zu einer antwort, die von der Pipeline empfangen wurde. |
| PipelineRetryOptions |
Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden. |
| ProxySettings |
Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen ( nurNode.js). |
| PxfObject |
Eine Schnittstelle, die mit dem |
| 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 |
Eine Wiederholungsstrategie soll definieren, ob sie erneut versuchen oder nicht, und wie Sie den Vorgang wiederholen. |
| SystemErrorRetryPolicyOptions |
Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden. |
| TelemetryOptions |
Definiert Optionen, die zum Konfigurieren allgemeiner Telemetrie- und Ablaufverfolgungsinformationen verwendet werden. |
| ThrottlingRetryPolicyOptions |
Optionen, die steuern, wie fehlgeschlagene 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, als ob aus einem Browserformular. |
| FormDataValue |
Jeder Formulardateneintrag kann eine Zeichenfolge, ein Blob oder eine Datei sein. Wenn Sie eine Datei mit einem Namen übergeben möchten, aber keinen Zugriff auf die Dateiklasse haben, können Sie die CreateFile-Hilfsprogramm verwenden, um eine datei zu erstellen. |
| HttpMethods |
Unterstützte HTTP-Methoden, die beim Senden von Anforderungen verwendet werden sollen. |
| PipelinePhase |
Richtlinien werden in Phasen ausgeführt. Die Ausführungsreihenfolge lautet:
|
| RawHttpHeaders |
Eine HttpHeaders-Auflistung, die als einfaches JSON-Objekt dargestellt wird. |
| RawHttpHeadersInput |
Eine HttpHeaders-Auflistung für Eingaben, dargestellt als einfaches JSON-Objekt. |
| RequestBodyType |
Typen von Textkörpern, die auf der Anforderung unterstützt werden. NodeJS.ReadableStream und () => NodeJS.ReadableStream ist nur Node. Blob, ReadableStream und () => ReadableStream sind nur Browser. |
| SendRequest |
Eine einfache Schnittstelle zum Erstellen einer Pipelineanforderung und zum Empfangen einer Antwort. |
| TransferProgressEvent |
Wird als Reaktion auf den Upload- oder Downloadfortschritt ausgelöst. |
Functions
| agent |
Ruft eine Pipelinerichtlinie ab, die http.agent festlegt |
| auxiliary |
Eine Richtlinie für externe Token zum |
| bearer |
Eine Richtlinie, die ein Token aus einer TokenCredential-Implementierung anfordern und dann auf den Autorisierungsheader einer Anforderung als Bearertoken anwenden kann. |
| create |
Erstellen Sie den richtigen HttpClient für die aktuelle Umgebung. |
| create |
Erstellt eine völlig leere Pipeline. Nützlich zum Testen oder Erstellen eines benutzerdefinierten. |
| create |
Erstellen Sie ein Objekt, das die Dateischnittstelle implementiert. Dieses Objekt soll an RequestBodyType.formData übergeben werden und ist nicht garantiert, dass es in anderen Situationen wie erwartet funktioniert. Verwenden Sie diese Funktion, um ein File-Objekt für die Verwendung in RequestBodyType.formData in Umgebungen zu erstellen, in denen das globale File-Objekt nicht verfügbar ist. |
| create |
Erstellen Sie ein Objekt, das die Dateischnittstelle implementiert. Dieses Objekt soll an RequestBodyType.formData übergeben werden und ist nicht garantiert, dass es in anderen Situationen wie erwartet funktioniert. Verwenden Sie diese Funktion, um:
|
| create |
Erstellt ein Objekt, das die |
| create |
Erstellen Sie eine neue Pipeline mit einem Standardsatz anpassbarer Richtlinien. |
| create |
Erstellt eine neue Pipelineanforderung mit den angegebenen Optionen. Diese Methode besteht darin, die einfache Einstellung von Standardwerten zu ermöglichen und nicht erforderlich. |
| decompress |
Eine Richtlinie zum Aktivieren der Antwortdekomprimierung gemäß Accept-Encoding Header-https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding |
| default |
Eine Richtlinie, die nach drei Strategien erneut ausgeführt wird:
|
| exponential |
Eine Richtlinie, die versucht, Anforderungen erneut auszuführen, während eine exponentiell zunehmende Verzögerung eingeführt wird. |
| form |
Eine Richtlinie, die FormData für die Anforderung im Textkörper codiert. |
| get |
Diese Methode konvertiert eine Proxy-URL in |
| is |
Typeguard für RestError |
| log |
Eine Richtlinie, die alle Anforderungen und Antworten protokolliert. |
| multipart |
Pipelinerichtlinie für mehrteilige Anforderungen |
| nd |
"ndJsonPolicy" ist eine Richtlinie, die verwendet wird, um die Keep Alive-Einstellungen für jede Anforderung zu steuern. |
| proxy |
Eine Richtlinie, mit der eine Proxyeinstellungen auf alle Anforderungen anwenden kann. Wenn keine statischen Einstellungen übergeben werden, werden sie aus den HTTPS_PROXY- oder HTTP_PROXY Umgebungsvariablen abgerufen. |
| redirect |
Eine Richtlinie zum Folgen von Standortheadern vom Server, um die serverseitige Umleitung zu unterstützen. Im Browser wird diese Richtlinie nicht verwendet. |
| retry |
retryPolicy ist eine generische Richtlinie zum Aktivieren der Wiederholungsanforderungen, wenn bestimmte Bedingungen erfüllt sind. |
| set |
Jede PipelineRequest erhält beim Erstellen eine eindeutige ID. Diese Richtlinie übergibt diese eindeutige ID über einen HTTP-Header, um eine bessere Telemetrie und Ablaufverfolgung zu ermöglichen. |
| system |
Eine Wiederholungsrichtlinie, die speziell versucht, Fehler in der zugrunde liegenden Transportebene (z. B. DNS-Nachschlagefehler) zu behandeln, anstatt fehlercodes vom Server selbst zu wiederholen. |
| throttling |
Eine Richtlinie, die erneut ausgeführt wird, wenn der Server eine 429-Antwort mit einem Retry-After Header sendet. Weitere Informationen finden Sie unter https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits und https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors |
| tls |
Ruft eine Pipelinerichtlinie ab, die das Clientzertifikat zum HttpClient-Agent für die Authentifizierung hinzufügt. |
| tracing |
Eine einfache Richtlinie zum Erstellen von OpenTelemetry Spans für jede Anforderung, die von der Pipeline mit SpanOptions mit einem übergeordneten Element vorgenommen wurde. Anfragen ohne übergeordnete Span werden nicht aufgezeichnet. |
| user |
Eine Richtlinie, die die User-Agent Kopfzeile (oder gleichwertig) festlegt, um die Bibliotheksversion widerzuspiegeln. |
Details zur Funktion
agentPolicy(Agent)
Ruft eine Pipelinerichtlinie ab, die http.agent festlegt
function agentPolicy(agent?: Agent): PipelinePolicyParameter
- agent
- Agent
Gibt zurück
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)
Eine Richtlinie für externe Token zum x-ms-authorization-auxiliary Header.
Dieser Header wird verwendet, wenn eine mandantenübergreifende Anwendung erstellt wird, die wir möglicherweise für Authentifizierungsanforderungen für Ressourcen in verschiedenen Mandanten verarbeiten müssen.
Sie könnten ARM-Dokumente sehen, um zu erfahren, wie dieses Feature funktioniert.
function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicyParameter
Gibt zurück
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)
Eine Richtlinie, die ein Token aus einer TokenCredential-Implementierung anfordern und dann auf den Autorisierungsheader einer Anforderung als Bearertoken anwenden kann.
function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicyParameter
Gibt zurück
createDefaultHttpClient()
Erstellen Sie den richtigen HttpClient für die aktuelle Umgebung.
function createDefaultHttpClient(): HttpClientGibt zurück
createEmptyPipeline()
Erstellt eine völlig leere Pipeline. Nützlich zum Testen oder Erstellen eines benutzerdefinierten.
function createEmptyPipeline(): PipelineGibt zurück
createFile(Uint8Array, string, CreateFileOptions)
Erstellen Sie ein Objekt, das die Dateischnittstelle implementiert. Dieses Objekt soll an RequestBodyType.formData übergeben werden und ist nicht garantiert, dass es in anderen Situationen wie erwartet funktioniert.
Verwenden Sie diese Funktion, um ein File-Objekt für die Verwendung in RequestBodyType.formData in Umgebungen zu erstellen, in denen das globale File-Objekt nicht verfügbar ist.
function createFile(content: Uint8Array, name: string, options?: CreateFileOptions): FileParameter
- content
-
Uint8Array
der Inhalt der Datei als Uint8Array im Arbeitsspeicher.
- name
-
string
der Name der Datei.
- options
- CreateFileOptions
optionale Metadaten zur Datei, z. B. Dateiname, Dateigröße, MIME-Typ.
Gibt zurück
File
createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)
Erstellen Sie ein Objekt, das die Dateischnittstelle implementiert. Dieses Objekt soll an RequestBodyType.formData übergeben werden und ist nicht garantiert, dass es in anderen Situationen wie erwartet funktioniert.
Verwenden Sie diese Funktion, um:
- Erstellen Sie ein File-Objekt für die Verwendung in RequestBodyType.formData in Umgebungen, in denen das globale File-Objekt nicht verfügbar ist.
- Erstellen Sie ein Dateiähnliches Objekt aus einem lesbaren Datenstrom, ohne den Datenstrom in den Arbeitsspeicher zu lesen.
function createFileFromStream(stream: () => ReadableStream<Uint8Array> | ReadableStream, name: string, options?: CreateFileFromStreamOptions): FileParameter
- stream
-
() => ReadableStream<Uint8Array> | ReadableStream
der Inhalt der Datei als Rückruf, der einen Datenstrom zurückgibt. Wenn ein Mit createFile erstelltes File-Objekt in der Formulardatenzuordnung einer Anforderung übergeben wird, wird der Datenstrom nicht in den Arbeitsspeicher gelesen und stattdessen gestreamt, wenn die Anforderung erfolgt. Im Falle eines Wiederholungsvorgangs muss der Datenstrom erneut gelesen werden, sodass dieser Rückruf ggf. einen neuen Datenstrom zurückgeben sollte.
- name
-
string
der Name der Datei.
- options
- CreateFileFromStreamOptions
optionale Metadaten zur Datei, z. B. Dateiname, Dateigröße, MIME-Typ.
Gibt zurück
File
createHttpHeaders(RawHttpHeadersInput)
Erstellt ein Objekt, das die HttpHeaders Schnittstelle erfüllt.
function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeadersParameter
- rawHeaders
- RawHttpHeadersInput
Ein einfaches Objekt, das anfängliche Kopfzeilen darstellt
Gibt zurück
createPipelineFromOptions(InternalPipelineOptions)
Erstellen Sie eine neue Pipeline mit einem Standardsatz anpassbarer Richtlinien.
function createPipelineFromOptions(options: InternalPipelineOptions): PipelineParameter
- options
- InternalPipelineOptions
Optionen zum Konfigurieren einer benutzerdefinierten Pipeline.
Gibt zurück
createPipelineRequest(PipelineRequestOptions)
Erstellt eine neue Pipelineanforderung mit den angegebenen Optionen. Diese Methode besteht darin, die einfache Einstellung von Standardwerten zu ermöglichen und nicht erforderlich.
function createPipelineRequest(options: PipelineRequestOptions): PipelineRequestParameter
- options
- PipelineRequestOptions
Die Optionen zum Erstellen der Anforderung mit.
Gibt zurück
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(): PipelinePolicyGibt zurück
defaultRetryPolicy(DefaultRetryPolicyOptions)
Eine Richtlinie, die nach drei Strategien erneut ausgeführt wird:
- Wenn der Server eine 429-Antwort mit einem Retry-After Header sendet.
- Wenn fehler in der zugrunde liegenden Transportebene auftreten (z. B. DNS-Nachschlagefehler).
- Oder wenn die ausgehende Anforderung fehlschlägt, wird sie mit einer exponentiell steigenden Verzögerung wiederholt.
function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicyParameter
- options
- DefaultRetryPolicyOptions
Gibt zurück
exponentialRetryPolicy(ExponentialRetryPolicyOptions)
Eine Richtlinie, die versucht, Anforderungen erneut auszuführen, während eine exponentiell zunehmende Verzögerung eingeführt wird.
function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicyParameter
- options
- ExponentialRetryPolicyOptions
Optionen zum Konfigurieren der Wiederholungslogik.
Gibt zurück
formDataPolicy()
Eine Richtlinie, die FormData für die Anforderung im Textkörper codiert.
function formDataPolicy(): PipelinePolicyGibt zurück
getDefaultProxySettings(string)
Warnung
Diese API ist nun veraltet.
- Internally this method is no longer necessary when setting proxy information.
Diese Methode konvertiert eine Proxy-URL in ProxySettings für die Verwendung mit ProxyPolicy.
Wenn kein Argument angegeben wird, wird versucht, eine Proxy-URL aus den Umgebungsvariablen HTTPS_PROXY oder HTTP_PROXYzu analysieren.
function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefinedParameter
- 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): eParameter
- e
-
unknown
Etwas, das von einer Catch-Klausel abgefangen wird.
Gibt zurück
e
logPolicy(LogPolicyOptions)
Eine Richtlinie, die alle Anforderungen und Antworten protokolliert.
function logPolicy(options?: LogPolicyOptions): PipelinePolicyParameter
- options
- LogPolicyOptions
Optionen zum Konfigurieren von logPolicy.
Gibt zurück
multipartPolicy()
Pipelinerichtlinie für mehrteilige Anforderungen
function multipartPolicy(): PipelinePolicyGibt zurück
ndJsonPolicy()
"ndJsonPolicy" ist eine Richtlinie, die verwendet wird, um die Keep Alive-Einstellungen für jede Anforderung zu steuern.
function ndJsonPolicy(): PipelinePolicyGibt zurück
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })
Eine Richtlinie, mit der eine Proxyeinstellungen auf alle Anforderungen anwenden kann. Wenn keine statischen Einstellungen übergeben werden, werden sie aus den HTTPS_PROXY- oder HTTP_PROXY Umgebungsvariablen abgerufen.
function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): PipelinePolicyParameter
- 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
redirectPolicy(RedirectPolicyOptions)
Eine Richtlinie zum Folgen von Standortheadern vom Server, um die serverseitige Umleitung zu unterstützen. Im Browser wird diese Richtlinie nicht verwendet.
function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicyParameter
- options
- RedirectPolicyOptions
Optionen zum Steuern des Richtlinienverhaltens.
Gibt zurück
retryPolicy(RetryStrategy[], RetryPolicyOptions)
retryPolicy ist eine generische Richtlinie zum Aktivieren der Wiederholungsanforderungen, wenn bestimmte Bedingungen erfüllt sind.
function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicyParameter
- strategies
- options
- RetryPolicyOptions
Gibt zurück
setClientRequestIdPolicy(string)
Jede PipelineRequest erhält beim Erstellen 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): PipelinePolicyParameter
- requestIdHeaderName
-
string
Der Name des Headers, an den die Anforderungs-ID übergeben werden soll.
Gibt zurück
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)
Eine Wiederholungsrichtlinie, die speziell versucht, Fehler in der zugrunde liegenden Transportebene (z. B. DNS-Nachschlagefehler) zu behandeln, anstatt fehlercodes vom Server selbst zu wiederholen.
function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicyParameter
- options
- SystemErrorRetryPolicyOptions
Optionen, die die Richtlinie anpassen.
Gibt zurück
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)
Eine Richtlinie, die erneut ausgeführt wird, wenn der Server eine 429-Antwort mit einem Retry-After Header sendet.
Weitere Informationen finden Sie unter https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits und https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicyParameter
- options
- ThrottlingRetryPolicyOptions
Optionen zum Konfigurieren der Wiederholungslogik.
Gibt zurück
tlsPolicy(TlsSettings)
Ruft eine Pipelinerichtlinie ab, die das Clientzertifikat zum HttpClient-Agent für die Authentifizierung hinzufügt.
function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicyParameter
- tlsSettings
- TlsSettings
Gibt zurück
tracingPolicy(TracingPolicyOptions)
Eine einfache Richtlinie zum Erstellen von OpenTelemetry Spans für jede Anforderung, die von der Pipeline mit SpanOptions mit einem übergeordneten Element vorgenommen wurde. Anfragen ohne übergeordnete Span werden nicht aufgezeichnet.
function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicyParameter
- options
- TracingPolicyOptions
Optionen zum Konfigurieren der Telemetrie, die von der Ablaufverfolgungsrichtlinie protokolliert wird.
Gibt zurück
userAgentPolicy(UserAgentPolicyOptions)
Eine Richtlinie, die die User-Agent Kopfzeile (oder gleichwertig) festlegt, um die Bibliotheksversion widerzuspiegeln.
function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicyParameter
- options
- UserAgentPolicyOptions
Optionen zum Anpassen des Benutzer-Agent-Werts.