@azure/core-https package

Klassen

DefaultHttpsClient	Eine HttpsClient-Implementierung, die das "https"-Modul von Node verwendet, um HTTPS-Anforderungen zu senden.
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.
BearerTokenAuthenticationPolicyOptions	Optionen zum Konfigurieren der BearerTokenAuthenticationPolicy
ExponentialRetryPolicyOptions	Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden.
HttpHeaders	Stellt eine Reihe von HTTP-Headern für eine Anforderung/Antwort dar. Kopfzeilennamen werden bei nicht beachteter Groß-/Kleinschreibung behandelt.
HttpsClient	Die erforderliche Schnittstelle für einen Client, der HTTPS-Anforderungen im Namen einer Pipeline sendet.
InternalPipelineOptions	Definiert Optionen, die zum Konfigurieren interner Optionen der HTTP-Pipeline für einen SDK-Client verwendet werden.
LogPolicyOptions	Optionen zum Konfigurieren der logPolicy.
Pipeline	Stellt eine Pipeline zum Senden einer HTTPS-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 äquivalent zu Partial<PipelineRequest>, aber die URL ist obligatorisch.
PipelineResponse	Metadaten zu einer antwort, die von der Pipeline empfangen wurde.
ProxySettings	Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen ( nurNode.js).
RedirectPolicyOptions	Optionen für die Behandlung von Umleitungsantworten.
RestErrorOptions	Die von RestError unterstützten Optionen.
SystemErrorRetryPolicyOptions	Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden.
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 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: Serialisieren der Phase Richtlinien, die nicht in einer Phase sind Deserialisieren der Phase Wiederholungsphase
RawHttpHeaders	Eine HttpHeaders-Auflistung, die als einfaches JSON-Objekt dargestellt wird.
RequestBodyType	Typen von Textkörpern, die auf der Anforderung unterstützt werden. NodeJS.ReadableStream ist nur Node. Blob ist nur im Browser verfügbar.
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

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	Eine Richtlinie, die ein Token aus einer TokenCredential-Implementierung anfordern und dann auf den Autorisierungsheader einer Anforderung als Bearertoken anwenden kann.
createEmptyPipeline()	Erstellt eine völlig leere Pipeline. Nützlich zum Testen oder Erstellen eines benutzerdefinierten.
createHttpHeaders(RawHttpHeaders)	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 besteht darin, die einfache Einstellung von Standardwerten zu ermöglichen und 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
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	Eine Richtlinie, die versucht, Anforderungen erneut auszuführen, während eine exponentiell zunehmende Verzögerung eingeführt wird.
formDataPolicy()	Eine Richtlinie, die FormData für die Anforderung im Textkörper codiert.
getDefaultProxySettings(string)	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_PROXY`zu analysieren.
logPolicy(LogPolicyOptions)	Eine Richtlinie, die alle Anforderungen und Antworten protokolliert.
ndJsonPolicy()	"ndJsonPolicy" ist eine Richtlinie, die verwendet wird, um die Keep Alive-Einstellungen für jede Anforderung zu steuern.
proxyPolicy(ProxySettings)	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.
redirectPolicy(RedirectPolicyOptions)	Eine Richtlinie zum Folgen von Standortheadern vom Server, um die serverseitige Umleitung zu unterstützen.
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.
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.
throttlingRetryPolicy()	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://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits und https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
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.
userAgentPolicy(UserAgentPolicyOptions)	Eine Richtlinie, die die User-Agent Kopfzeile (oder gleichwertig) festlegt, um die Bibliotheksversion widerzuspiegeln.

Variablen

bearerTokenAuthenticationPolicyName	Die programmatische Kennung der bearerTokenAuthenticationPolicy.
decompressResponsePolicyName	Die programmatische Identifikatorin der decompressResponsePolicy.
expontentialRetryPolicyName	Die programmatische Identifikatorin der exponentiellen RetryPolicy.
formDataPolicyName	Die programmatische Identifikatorin der formDataPolicy.
logPolicyName	Die programmatische Identifikatorin der logPolicy.
ndJsonPolicyName	Der programmatische Identifikator der ndJsonPolicy.
proxyPolicyName	Die programmatische Identifikatorin der proxyPolicy.
redirectPolicyName	Der programmatische Kenner der redirectPolicy.
setClientRequestIdPolicyName	Die programmatische Identifikatorin des setClientRequestIdPolicy.
systemErrorRetryPolicyName	Die programmatische Identifikatorin des systemErrorRetryPolicy.
throttlingRetryPolicyName	Der programmatische Identifikator des throttlingRetryPolicy.
tracingPolicyName	Der programmatische Identifikator der tracingPolicy.
userAgentPolicyName	Die programmatische Identifikatorin der userAgentPolicy.

Details zur Funktion

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): PipelinePolicy

Parameter

options: BearerTokenAuthenticationPolicyOptions

Gibt zurück

PipelinePolicy

createEmptyPipeline()

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

function createEmptyPipeline(): Pipeline

Gibt zurück

Pipeline

createHttpHeaders(RawHttpHeaders)

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

function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders

Parameter

rawHeaders: RawHttpHeaders

Ein einfaches Objekt, das anfängliche Kopfzeilen 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 besteht darin, die einfache Einstellung von Standardwerten zu ermöglichen und nicht erforderlich.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parameter

options: PipelineRequestOptions

Die Optionen zum Erstellen der Anforderung mit.

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

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Eine Richtlinie, die versucht, Anforderungen erneut auszuführen, während eine exponentiell zunehmende Verzögerung eingeführt wird.

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 im Textkörper codiert.

function formDataPolicy(): PipelinePolicy

Gibt zurück

PipelinePolicy

getDefaultProxySettings(string)

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 | undefined

Parameter

proxyUrl: string

Die URL des zu verwendenden Proxys. Kann Authentifizierungsinformationen enthalten.

Gibt zurück

ProxySettings | undefined

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 die Keep Alive-Einstellungen für jede Anforderung zu steuern.

function ndJsonPolicy(): PipelinePolicy

Gibt zurück

PipelinePolicy

proxyPolicy(ProxySettings)

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): PipelinePolicy

Parameter

proxySettings: ProxySettings

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

Gibt zurück

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Eine Richtlinie zum Folgen von Standortheadern vom Server, um die serverseitige Umleitung zu unterstützen.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parameter

options: RedirectPolicyOptions

Optionen zum Steuern des Richtlinienverhaltens.

Gibt zurück

PipelinePolicy

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): 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 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): PipelinePolicy

Parameter

options: SystemErrorRetryPolicyOptions

Optionen, die die Richtlinie anpassen.

Gibt zurück

PipelinePolicy

throttlingRetryPolicy()

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://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits und https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): PipelinePolicy

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 vorgenommen wurde. Anfragen ohne übergeordnete Span werden nicht aufgezeichnet.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Parameter

options: TracingPolicyOptions

Optionen zum Konfigurieren der Telemetrie, die von der Ablaufverfolgungsrichtlinie protokolliert wird.

Gibt zurück

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

Eine Richtlinie, die die User-Agent Kopfzeile (oder gleichwertig) festlegt, um die Bibliotheksversion widerzuspiegeln.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Parameter

options: UserAgentPolicyOptions

Optionen zum Anpassen des Benutzer-Agent-Werts.

Gibt zurück

PipelinePolicy

Variable Details

bearerTokenAuthenticationPolicyName

Die programmatische Kennung der bearerTokenAuthenticationPolicy.

bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"

Typ

"bearerTokenAuthenticationPolicy"

decompressResponsePolicyName

Die programmatische Identifikatorin der decompressResponsePolicy.

decompressResponsePolicyName: "decompressResponsePolicy"

Typ

"decompressResponsePolicy"

expontentialRetryPolicyName

Die programmatische Identifikatorin der exponentiellen RetryPolicy.

expontentialRetryPolicyName: "exponentialRetryPolicy"

Typ

"exponentialRetryPolicy"

formDataPolicyName

Die programmatische Identifikatorin der formDataPolicy.

formDataPolicyName: "formDataPolicy"

Typ

"formDataPolicy"

logPolicyName

Die programmatische Identifikatorin der logPolicy.

logPolicyName: "logPolicy"

Typ

"logPolicy"

ndJsonPolicyName

Der programmatische Identifikator der ndJsonPolicy.

ndJsonPolicyName: "ndJsonPolicy"

Typ

"ndJsonPolicy"

proxyPolicyName

Die programmatische Identifikatorin der proxyPolicy.

proxyPolicyName: "proxyPolicy"

Typ

"proxyPolicy"

redirectPolicyName

Der programmatische Kenner der redirectPolicy.

redirectPolicyName: "redirectPolicy"

Typ

"redirectPolicy"

setClientRequestIdPolicyName

Die programmatische Identifikatorin des setClientRequestIdPolicy.

setClientRequestIdPolicyName: "setClientRequestIdPolicy"

Typ

"setClientRequestIdPolicy"

systemErrorRetryPolicyName

Die programmatische Identifikatorin des systemErrorRetryPolicy.

systemErrorRetryPolicyName: "systemErrorRetryPolicy"

Typ

"systemErrorRetryPolicy"

throttlingRetryPolicyName

Der programmatische Identifikator des throttlingRetryPolicy.

throttlingRetryPolicyName: "throttlingRetryPolicy"

Typ

"throttlingRetryPolicy"

tracingPolicyName

Der programmatische Identifikator der tracingPolicy.

tracingPolicyName: "tracingPolicy"

Typ

"tracingPolicy"

userAgentPolicyName

Die programmatische Identifikatorin der userAgentPolicy.

userAgentPolicyName: "userAgentPolicy"

Typ

"userAgentPolicy"

Feedback

War diese Seite hilfreich?