@azure/core-http package

Referenz

Klassen

AccessTokenRefresher	Unterstützt die Core-HTTP-Tokenauthentifizierungsrichtlinien beim Anfordern eines neuen Tokens, wenn wir derzeit nicht auf ein neues Token warten.
ApiKeyCredentials	Authentifiziert sich mit einem API-Schlüssel bei einem Dienst.
BaseRequestPolicy	Die Basisklasse, von der alle Anforderungsrichtlinien abgeleitet werden.
BasicAuthenticationCredentials	Eine einfache <xref:ServiceClientCredential>, die sich mit einem Benutzernamen und einem Kennwort authentifiziert.
DefaultHttpClient	Ein HTTP-Client, der `node-fetch`verwendet.
ExpiringAccessTokenCache	Stellt eine AccessTokenCache- Implementierung bereit, die das zwischengespeicherte AccessToken's nach Ablauf des Ablaufs VonOnTimestamp gelöscht wird.
HttpHeaders	Eine Sammlung von HTTP-Headerschlüssel-Wert-Paaren.
RequestPolicyOptions	Optionale Eigenschaften, die beim Erstellen einer RequestPolicy verwendet werden können.
RestError	Ein Fehler, der sich aus einer HTTP-Anforderung an einen Dienstendpunkt ergibt.
Serializer	Wird verwendet, um unformatierte Antwortobjekte endgültigen Shapes zuzuordnen. Hilft beim Packen und Entpacken von Datumsangaben und anderen codierten Typen, die nicht in JSON systemintern sind. Ermöglicht außerdem das Abrufen von Werten aus Kopfzeilen sowie das Einfügen von Standardwerten und Konstanten.
ServiceClient	ServiceClient sendet Dienstanforderungen und empfängt Antworten.
TopicCredentials	Ein TopicCredentials- Objekt, das für Azure Event Grid verwendet wird.
URLBuilder	Eine Klasse, die das Erstellen, Ändern und Analysieren von URLs behandelt.
URLQuery	Eine Klasse, die den Abfrageteil eines URLBuilders behandelt.
WebResource	Erstellt ein neues WebResource -Objekt. Diese Klasse stellt eine Abstraktion über einen REST-Aufruf bereit, indem sie bibliotheks-/implementierungsagnostisch sind und die erforderlichen Eigenschaften umschließen, um eine Anforderung zu initiieren.

Schnittstellen

AbortSignalLike	Ermöglicht das Abbrechen der Anforderung beim Auslösen des "abort"-Ereignisses. Kompatibel mit dem browser integrierten AbortSignal und gängigen Polyfills.
AccessToken	Stellt ein Zugriffstoken mit einer Ablaufzeit dar.
AccessTokenCache	Stellt einen Cache für ein AccessToken bereit, das von einem TokenCredential zurückgegeben wurde.
ApiKeyCredentialOptions	Beschreibt die Optionen, die beim Erstellen einer Instanz von ApiKeyCredentials bereitgestellt werden sollen.
BaseMapper	Die Basisdefinition eines Mappers. Kann für XML- und einfache JavaScript-Objekte verwendet werden.
CompositeMapper	Ein Mapper, der aus anderen Mappern besteht.
CompositeMapperType	Hilft beim Erstellen eines Mappers, der beschreibt, wie eine Reihe von Eigenschaften eines Objekts basierend auf anderen Mappern zugeordnet wird. Es sollte nur eine der folgenden Eigenschaften vorhanden sein: `className`, `modelProperties` und `additionalProperties`.
DeserializationContentTypes	Die Inhaltstypen, die angeben, dass eine Vorgangsantwort auf eine bestimmte Weise deserialisiert werden soll.
DeserializationOptions	Optionen zum Konfigurieren der API-Antwort-Deserialisierung.
DictionaryMapper	Ein Mapper, der einfache JavaScript-Objekte beschreibt, die als Schlüssel-Wert-Paare verwendet werden.
DictionaryMapperType	Hilft beim Erstellen eines Mappers, der beschreibt, wie ein Wörterbuch mit zugeordneten Werten analysiert wird.
EnumMapper	Ein Mapper, der einen Enumerationswert beschreibt.
EnumMapperType	Hilft beim Erstellen eines Mappers, der beschreibt, wie ein Enumerationswert analysiert wird.
GetTokenOptions	Definiert Optionen für TokenCredential.getToken.
HttpClient	Eine Schnittstelle, die HttpRequests senden und versprochene HttpResponses empfangen kann.
HttpHeader	Ein einzelner Header in einer HttpHeaders-Auflistung.
HttpHeadersLike	Eine Sammlung von HTTP-Headerschlüssel-Wert-Paaren.
HttpOperationResponse	Wrapperobjekt für HTTP-Anforderung und -Antwort. Das deserialisierte Objekt wird in der eigenschaft `parsedBody` gespeichert, wenn der Antworttext in JSON oder XML empfangen wird.
HttpPipelineLogger	Ein Logger, der einer HttpPipeline hinzugefügt werden kann. Dadurch kann jede RequestPolicy Nachrichten protokollieren, die für Debuggingzwecke verwendet werden können.
HttpResponse	Die Eigenschaften für eine HTTP-Antwort, die immer vorhanden ist.
InternalPipelineOptions	Definiert Optionen, die zum Konfigurieren interner Optionen der HTTP-Pipeline für einen SDK-Client verwendet werden.
KeepAliveOptions	Optionen zum Verwalten von HTTP-Verbindungen für zukünftige Anforderungen.
LogPolicyOptions	Optionen, die an die logPolicyübergeben werden sollen. Standardmäßig werden nur eine festgelegte Liste von Headern protokolliert, dies kann jedoch konfiguriert werden. Anforderungs- und Antworttexte werden nie protokolliert.
MapperConstraints	Beschreibung verschiedener Werteinschränkungen wie ganzzahlige Bereiche und Zeichenfolgen-Regex.
OperationArguments	Eine Auflistung von Eigenschaften, die auf einen einzelnen Aufruf eines Vorgangs angewendet werden.
OperationOptions	Der Basisoptionentyp für alle Vorgänge.
OperationParameter	Eine allgemeine Schnittstelle, die alle Operation-Parameter erweitern.
OperationQueryParameter	Ein Parameter für einen Vorgang, der als Abfrageparameter zur HTTP-Anforderung des Vorgangs hinzugefügt wird.
OperationRequestOptions	Optionen, mit denen die Verarbeitung von HTTP-Anforderungen durch einen SDK-Vorgang konfiguriert werden kann.
OperationResponse	Eine OperationResponse, die von einer Vorgangsanforderung für einen einzelnen Statuscode zurückgegeben werden kann.
OperationSpec	Eine Spezifikation, die definiert, wie ein bestimmter Dienstvorgang über HTTP ausgeführt wird, einschließlich der ordnungsgemäßen Serialisierung von Anforderungsinformationen in und deserialisieren von Antwortinformationen in eine Objektnutzlast, die vom ServiceClient-zurückgegeben werden kann.
OperationURLParameter	Ein Parameter für einen Vorgang, der in die Anforderungs-URL des Vorgangs ersetzt wird.
ParameterValue	Der parameterwert, der für Pfad- oder Abfrageparameter in RequestPrepareOptions bereitgestellt wird
PipelineOptions	Definiert Optionen, die zum Konfigurieren der HTTP-Pipeline für einen SDK-Client verwendet werden.
PolymorphicDiscriminator	Wird verwendet, um mehrdeutige Diskriminierte Vereinigungen zu unterscheiden. Wenn die Antwort beispielsweise viele Shapes enthalten kann, aber auch ein "Art"-Feld (oder ähnliches) enthält, kann dieses Feld verwendet werden, um zu bestimmen, wie die Antwort auf den richtigen Typ deserialisiert wird.
ProxySettings	Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen ( nurNode.js).
RedirectOptions	Optionen für die Behandlung von Umleitungsantworten.
RequestOptionsBase	Beschreibt die Basisstruktur des Optionsobjekts, das in jedem Vorgang verwendet wird.
RequestPolicy	Die zugrunde liegende Struktur einer Anforderungsrichtlinie.
RequestPolicyOptionsLike	Optionale Eigenschaften, die beim Erstellen einer RequestPolicy verwendet werden können.
RequestPrepareOptions	Optionen zum Vorbereiten einer ausgehenden HTTP-Anforderung.
RestResponse	Die flache Antwort auf einen REST-Aufruf. Enthält die zugrunde liegenden HttpOperationResponse- sowie die zusammengeführten Eigenschaften der `parsedBody`, `parsedHeaders`usw.
RetryOptions	Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden.
SequenceMapper	Ein Mapper, der Arrays beschreibt.
SequenceMapperType	Hilft beim Erstellen eines Mappers, der beschreibt, wie eine Sequenz von zugeordneten Werten analysiert wird.
SerializerOptions	Optionen zum Steuern des Verhaltens des XML-Parsers und des Generators.
ServiceCallback
ServiceClientCredentials	Stellt ein Objekt oder eine Klasse mit einer `signRequest` Methode dar, die ausgehende Anforderungen signiert (z. B. durch Festlegen des `Authorization`-Headers).
ServiceClientOptions	Optionen, die beim Erstellen des Clients bereitgestellt werden sollen.
SimpleMapperType	Der Typ eines einfachen Mappers.
TokenCredential	Stellt eine Anmeldeinformation dar, die ein Authentifizierungstoken bereitstellen kann.
TracingPolicyOptions	Optionen zum Anpassen der Ablaufverfolgungsrichtlinie.
UrlParameterValue	Eine Schnittstelle, die einen URL-Parameterwert darstellt.
UserAgentOptions	Optionen zum Hinzufügen von Benutzer-Agent-Details zu ausgehenden Anforderungen.
WebResourceLike	Eine Beschreibung einer HTTP-Anforderung, die an einem Remoteserver gesendet werden soll.

Typaliase

Authenticator	Eine Funktion, die eine Abfrage empfängt und eine Zusage mit einem Zeichenfolgentoken löst.
CommonRequestInfo	Zeichenfolgen-URLs, die beim Aufrufen von `fetch()`verwendet werden.
CommonRequestInit	Ein Objekt, das Informationen zur ausgehenden HTTP-Anforderung enthält.
CommonResponse	Ein Objekt, das Informationen zur eingehenden HTTP-Antwort enthält.
HttpMethods	Liste der unterstützten HTTP-Methoden.
HttpRequestBody	Mögliche HTTP-Anforderungstexttypen
Mapper	Mapper sind Definitionen der datenmodelle, die in der Bibliothek verwendet werden. Diese Datenmodelle sind Teil der Vorgangs- oder Clientdefinitionen in den Antworten oder Parametern.
MapperType	Typ des Mappers. Enthält bekannte Mapper.
ParameterPath	Ein Pfad, der beschreibt, wie auf eine bestimmte Eigenschaft in einer bestimmten Objektdatenquelle zugegriffen wird. Kann ein einzelner Eigenschaftsname, ein Array, das geschachtelte Eigenschaftsnamen angibt, oder eine Gruppe mehrerer benannter Eigenschaften mit Pfaden im Fall komplexer Objektwerte sein.
ProxyOptions	Ein Alias von ProxySettings für die zukünftige Verwendung.
RawHttpHeaders	Eine HttpHeaders-Auflistung, die als einfaches JSON-Objekt dargestellt wird.
RequestPolicyFactory	Erstellt eine neue RequestPolicy pro Anforderung, die die bereitgestellte nextPolicy verwendet.
TelemetryInfo	Telemetrieinformationen. Schlüssel-Wert-Paare, die in die User-Agent Zeichenfolge eingeschlossen werden sollen.
TransferProgressEvent	Wird als Reaktion auf den Upload- oder Downloadfortschritt ausgelöst.

Enumerationen

HttpPipelineLogLevel	Die verschiedenen Ebenen von Protokollen, die mit httpPipelineLogger verwendet werden können.
QueryCollectionFormat	Das Format, das verwendet wird, um ein Array von Werten für einen Abfrageparameterwert zu verbinden.
RetryMode	Beschreibt den Typ "Wiederholungsmodus". Derzeit wird nur exponentielle Unterstützung unterstützt.

Functions

applyMixins(unknown, any[])	Wendet die Eigenschaften für den Prototyp von sourceCtors auf den Prototyp von targetCtor an.
bearerTokenAuthenticationPolicy(TokenCredential, string \| string[])	Erstellt eine neue Factory für eine RequestPolicy, die ein Bearertoken auf die `Authorization` Header der Anforderungen anwendet.
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	Erstellt eine HTTP-Pipeline basierend auf den angegebenen Optionen.
delay(number, DelayOptions)	Ein Wrapper für setTimeout, der eine Zusage nach timeInMs Millisekunden aufgelöst.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	Erstellen Sie eine neue Serialisierung RequestPolicyCreator, die http-Anforderungstexte serialisiert, während sie über die HTTP-Pipeline übergeben werden.
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	Bei einer bestimmten Gruppe von Inhaltstypen, die als JSON oder XML analysiert werden sollen, wird die HTTP-Antwort verwendet, um das Ergebnisobjekt zu erzeugen, das durch die OperationSpec-der Anforderung definiert wird.
disableResponseDecompressionPolicy()	Gibt eine Anforderungsrichtlinienfactory zurück, die zum Erstellen einer Instanz von <xref:DisableResponseDecompressionPolicy>verwendet werden kann.
encodeUri(string)	Codiert einen URI.
executePromisesSequentially(any[], unknown)	Führt ein Array von Zusagen sequenziell aus. Inspiration dieser Methode ist hier: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Ein fantastischer Blog zu Zusagen!
exponentialRetryPolicy(number, number, number)	Richtlinie, die die Anforderung so oft wie konfiguriert wiederholt, solange das angegebene maximale Wiederholungszeitintervall erneut ausgeführt wird, jeder Wiederholungsversuch, der länger wartet als das letzte Mal.
flattenResponse(HttpOperationResponse, undefined \| OperationResponse)	Analysiert eine HttpOperationResponse- in ein normalisiertes HTTP-Antwortobjekt (RestResponse).
generateClientRequestIdPolicy(string)	Erstellt eine Richtlinie, die ausgehenden Anforderungen eine eindeutige Anforderungs-ID zuweist.
generateUuid()	Generierte UUID
getDefaultProxySettings(string)	Konvertiert eine bestimmte URL eines Proxyservers in `ProxySettings` oder versucht, `ProxySettings` aus der aktuellen Umgebung abzurufen, wenn eine nicht übergeben wird.
getDefaultUserAgentValue()	Der Standardansatz zum Generieren von Benutzer-Agents. Verwendet statische Informationen aus diesem Paket sowie Systeminformationen, die über die Laufzeit verfügbar sind.
isDuration(string)	Gibt an, ob die angegebene Zeichenfolge im ISO 8601-Format vorliegt.
isTokenCredential(unknown)	Testet ein Objekt, um festzustellen, ob tokenCredential implementiert wird.
isValidUuid(string)	Überprüft die angegebene uuid als Zeichenfolge.
keepAlivePolicy(KeepAliveOptions)	Erstellt eine Richtlinie, die steuert, ob HTTP-Verbindungen für zukünftige Anforderungen verwaltet werden.
logPolicy(LogPolicyOptions)	Erstellt eine Richtlinie, die Informationen über die ausgehende Anforderung und die eingehenden Antworten protokolliert.
operationOptionsToRequestOptionsBase<T>(T)	Konvertiert eine OperationOptions in eine RequestOptionsBase
parseXML(string, SerializerOptions)	Konvertiert die angegebene XML-Zeichenfolge in JSON.
promiseToCallback(Promise<any>)	Konvertiert eine Zusage in einen Rückruf.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Konvertiert eine Zusage in einen Dienstrückruf.
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.
redirectPolicy(number)	Erstellt eine Umleitungsrichtlinie, die eine wiederholte Anforderung an ein neues Ziel sendet, wenn eine Antwort mit einem "Location"-Header eingeht, und einen Statuscode zwischen 300 und 307.
serializeObject(unknown)	Hilfsfunktion, die ein Objekt serialisiert, das binäre Informationen in ein einfaches Objekt, ein Array oder eine Zeichenfolge enthalten kann.
signingPolicy(ServiceClientCredentials)	Erstellt eine Richtlinie, die ausgehende Anforderungen signiert, indem sie die bereitgestellte `authenticationProvider`'`signRequest`-Methode aufrufen.
stringifyXML(unknown, SerializerOptions)	Konvertiert das angegebene JSON-Objekt in eine XML-Zeichenfolge.
stripRequest(WebResourceLike)	Gibt eine strippede Version der HTTP-Anforderung zurück, die nicht den Autorisierungsheader enthält.
stripResponse(HttpOperationResponse)	Gibt eine gestreifte Version der Http-Antwort zurück, die nur Textkörper, Header und den Status enthält.
systemErrorRetryPolicy(number, number, number, number)	Eine Richtlinie, die erneut auftritt, wenn ein Systemfehler auftritt, der durch die Codes "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" oder "ENOENT" identifiziert wird.
throttlingRetryPolicy()	Erstellt eine Richtlinie, die die Anforderung erneut sendet, wenn die Antwort angibt, dass die Anforderung aufgrund von Einschränkungsgründen fehlgeschlagen ist. Wenn die Antwort beispielsweise einen `Retry-After` Header enthält, wird das Senden der Anforderung basierend auf dem Wert dieses Headers wiederholt. 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)	Erstellt eine Richtlinie, die ausgehende Anforderungen mit einer Ablaufverfolgungsspanne umschließt.
userAgentPolicy(TelemetryInfo)	Gibt eine Richtlinie zurück, die den Benutzer-Agent-Header ausgehenden Anforderungen basierend auf dem angegebenen TelemetryInfo-hinzufügt.

Details zur Funktion

applyMixins(unknown, any[])

Wendet die Eigenschaften für den Prototyp von sourceCtors auf den Prototyp von targetCtor an.

function applyMixins(targetCtorParam: unknown, sourceCtors: any[])

Parameter

targetCtorParam: unknown

sourceCtors: any[]

Ein Array von Quellobjekten, aus denen die Eigenschaften entnommen werden müssen.

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Erstellt eine neue Factory für eine RequestPolicy, die ein Bearertoken auf die Authorization Header der Anforderungen anwendet.

function bearerTokenAuthenticationPolicy(credential: TokenCredential, scopes: string | string[]): RequestPolicyFactory

Parameter

credential: TokenCredential

Die TokenCredential-Implementierung, die das Bearertoken bereitstellen kann.

scopes: string | string[]

Die Bereiche, für die das Bearertoken gilt.

Gibt zurück

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Erstellt eine HTTP-Pipeline basierend auf den angegebenen Optionen.

function createPipelineFromOptions(pipelineOptions: InternalPipelineOptions, authPolicyFactory?: RequestPolicyFactory): ServiceClientOptions

Parameter

pipelineOptions: InternalPipelineOptions

Definiert Optionen, die zum Konfigurieren von Richtlinien in der HTTP-Pipeline für einen SDK-Client verwendet werden.

authPolicyFactory: RequestPolicyFactory

Eine optionale Authentifizierungsrichtlinienfactory, die zum Signieren von Anforderungen verwendet werden soll.

Gibt zurück

ServiceClientOptions

Eine Reihe von Optionen, die übergeben werden können, um eine neue ServiceClient-zu erstellen.

delay(number, DelayOptions)

Ein Wrapper für setTimeout, der eine Zusage nach timeInMs Millisekunden aufgelöst.

function delay(timeInMs: number, options?: DelayOptions): Promise<void>

Parameter

timeInMs: number

Die Anzahl der zu verzögernden Millisekunden.

options: DelayOptions

Die Optionen für Verzögerung – derzeit abgebrochene Optionen

Gibt zurück

Promise<void>

Zusage, die nach timeInMs aufgelöst wird

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Erstellen Sie eine neue Serialisierung RequestPolicyCreator, die http-Anforderungstexte serialisiert, während sie über die HTTP-Pipeline übergeben werden.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

Parameter

deserializationContentTypes: DeserializationContentTypes

parsingOptions: SerializerOptions

Gibt zurück

RequestPolicyFactory

deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)

Bei einer bestimmten Gruppe von Inhaltstypen, die als JSON oder XML analysiert werden sollen, wird die HTTP-Antwort verwendet, um das Ergebnisobjekt zu erzeugen, das durch die OperationSpec-der Anforderung definiert wird.

function deserializeResponseBody(jsonContentTypes: string[], xmlContentTypes: string[], response: HttpOperationResponse, options?: SerializerOptions): Promise<HttpOperationResponse>

Parameter

jsonContentTypes: string[]

Antwortinhaltstypen, um den Textkörper als JSON zu analysieren.

xmlContentTypes: string[]

Antwortinhaltstypen, um den Textkörper als XML zu analysieren.

response: HttpOperationResponse

HTTP-Antwort von der Pipeline.

options: SerializerOptions

Optionen für den Serialisierer, hauptsächlich zum Konfigurieren des XML-Parsers bei Bedarf.

Gibt zurück

Promise<HttpOperationResponse>

Ein analysiertes HttpOperationResponse--Objekt, das vom ServiceClient-zurückgegeben werden kann.

disableResponseDecompressionPolicy()

Gibt eine Anforderungsrichtlinienfactory zurück, die zum Erstellen einer Instanz von <xref:DisableResponseDecompressionPolicy>verwendet werden kann.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

Gibt zurück

RequestPolicyFactory

encodeUri(string)

Codiert einen URI.

function encodeUri(uri: string): string

Parameter

uri: string

Der zu codierenden URI.

Gibt zurück

string

Der codierte URI.

executePromisesSequentially(any[], unknown)

Führt ein Array von Zusagen sequenziell aus. Inspiration dieser Methode ist hier: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Ein fantastischer Blog zu Zusagen!

function executePromisesSequentially(promiseFactories: any[], kickstart: unknown): Promise<any>

Parameter

promiseFactories: any[]

Ein Array von Zusagefabriken(Eine Funktion, die eine Zusage zurückgibt)

kickstart: unknown

Eingabe für die erste Zusage, die verwendet wird, um die Zusagekette zu starten. Wenn nicht angegeben, beginnt die Zusagekette mit undefiniert.

Gibt zurück

Promise<any>

Eine Kette aufgelöster oder abgelehnter Zusagen

exponentialRetryPolicy(number, number, number)

Richtlinie, die die Anforderung so oft wie konfiguriert wiederholt, solange das angegebene maximale Wiederholungszeitintervall erneut ausgeführt wird, jeder Wiederholungsversuch, der länger wartet als das letzte Mal.

function exponentialRetryPolicy(retryCount?: number, retryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

Parameter

retryCount: number

Maximale Anzahl von Wiederholungsversuchen.

retryInterval: number

Basiszeit zwischen Wiederholungen.

maxRetryInterval: number

Maximale Wartezeit zwischen Wiederholungen.

Gibt zurück

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Analysiert eine HttpOperationResponse- in ein normalisiertes HTTP-Antwortobjekt (RestResponse).

function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse

Parameter

_response: HttpOperationResponse

Wrapperobjekt für http-Antwort.

responseSpec: undefined | OperationResponse

Mapper zum Analysieren der Antworteigenschaften.

Gibt zurück

RestResponse

Ein normalisiertes Antwortobjekt.

generateClientRequestIdPolicy(string)

Erstellt eine Richtlinie, die ausgehenden Anforderungen eine eindeutige Anforderungs-ID zuweist.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parameter

requestIdHeaderName: string

Der Name des Headers, der beim Zuweisen der eindeutigen ID zur Anforderung verwendet werden soll.

Gibt zurück

RequestPolicyFactory

generateUuid()

Generierte UUID

function generateUuid(): string

Gibt zurück

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

Konvertiert eine bestimmte URL eines Proxyservers in ProxySettings oder versucht, ProxySettings aus der aktuellen Umgebung abzurufen, wenn eine nicht übergeben wird.

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

Parameter

proxyUrl: string

URL des Proxys

Gibt zurück

ProxySettings | undefined

Die Standardproxyeinstellungen oder nicht definiert.

getDefaultUserAgentValue()

Der Standardansatz zum Generieren von Benutzer-Agents. Verwendet statische Informationen aus diesem Paket sowie Systeminformationen, die über die Laufzeit verfügbar sind.

function getDefaultUserAgentValue(): string

Gibt zurück

string

isDuration(string)

Gibt an, ob die angegebene Zeichenfolge im ISO 8601-Format vorliegt.

function isDuration(value: string): boolean

Parameter

value: string

Der wert, der für das ISO 8601-Dauerformat überprüft werden soll.

Gibt zurück

boolean

andernfalls truefalse.

isTokenCredential(unknown)

Testet ein Objekt, um festzustellen, ob tokenCredential implementiert wird.

function isTokenCredential(credential: unknown): credential

Parameter

credential: unknown

Die angenommenen Tokenanmeldeinformationen, die getestet werden sollen.

Gibt zurück

credential

isValidUuid(string)

Überprüft die angegebene uuid als Zeichenfolge.

function isValidUuid(uuid: string): boolean

Parameter

uuid: string

Die uuid als Zeichenfolge, die überprüft werden muss

Gibt zurück

boolean

True, wenn die uuid gültig ist; andernfalls "false".

keepAlivePolicy(KeepAliveOptions)

Erstellt eine Richtlinie, die steuert, ob HTTP-Verbindungen für zukünftige Anforderungen verwaltet werden.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Parameter

keepAliveOptions: KeepAliveOptions

Keep alive options. Standardmäßig werden HTTP-Verbindungen für zukünftige Anforderungen verwaltet.

Gibt zurück

RequestPolicyFactory

Eine Instanz des <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

Erstellt eine Richtlinie, die Informationen über die ausgehende Anforderung und die eingehenden Antworten protokolliert.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

Parameter

loggingOptions: LogPolicyOptions

Protokollierungsoptionen.

Gibt zurück

RequestPolicyFactory

Eine Instanz des <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

Konvertiert eine OperationOptions in eine RequestOptionsBase

function operationOptionsToRequestOptionsBase<T>(opts: T): RequestOptionsBase

Parameter

opts: T

OperationOptions-Objekt zum Konvertieren in RequestOptionsBase

Gibt zurück

RequestOptionsBase

parseXML(string, SerializerOptions)

Konvertiert die angegebene XML-Zeichenfolge in JSON.

function parseXML(str: string, opts?: SerializerOptions): Promise<any>

Parameter

str: string

Zeichenfolge, die den XML-Inhalt enthält, der in JSON analysiert werden soll

opts: SerializerOptions

Optionen, die die Analyse der angegebenen XML-Zeichenfolge steuern

Gibt zurück

Promise<any>

promiseToCallback(Promise<any>)

Warnung

Diese API ist nun veraltet.

generated code should instead depend on responseToBody

Konvertiert eine Zusage in einen Rückruf.

function promiseToCallback(promise: Promise<any>): (cb: Function) => void

Parameter

promise: Promise<any>

Die zu konvertierende Zusage in einen Rückruf

Gibt zurück

(cb: Function) => void

Eine Funktion, die den Rückruf (cb: Function) => void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Konvertiert eine Zusage in einen Dienstrückruf.

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): (cb: ServiceCallback<T>) => void

Parameter

promise: Promise<HttpOperationResponse>

Die Zusage von HttpOperationResponse, die in einen Dienstrückruf konvertiert werden soll

Gibt zurück

(cb: ServiceCallback<T>) => void

Eine Funktion, die den Dienstrückruf verwendet (cb: ServiceCallback): void

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[] }): RequestPolicyFactory

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

RequestPolicyFactory

redirectPolicy(number)

Erstellt eine Umleitungsrichtlinie, die eine wiederholte Anforderung an ein neues Ziel sendet, wenn eine Antwort mit einem "Location"-Header eingeht, und einen Statuscode zwischen 300 und 307.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parameter

maximumRetries: number

Maximale Anzahl von Umleitungen, denen sie folgen sollen.

Gibt zurück

RequestPolicyFactory

Eine Instanz des <xref:RedirectPolicy>

serializeObject(unknown)

Hilfsfunktion, die ein Objekt serialisiert, das binäre Informationen in ein einfaches Objekt, ein Array oder eine Zeichenfolge enthalten kann.

function serializeObject(toSerialize: unknown): any

Parameter

toSerialize: unknown

Gibt zurück

any

signingPolicy(ServiceClientCredentials)

Erstellt eine Richtlinie, die ausgehende Anforderungen signiert, indem sie die bereitgestellte authenticationProvider'signRequest-Methode aufrufen.

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parameter

authenticationProvider: ServiceClientCredentials

Der Authentifizierungsanbieter.

Gibt zurück

RequestPolicyFactory

Eine Instanz des <xref:SigningPolicy>.

stringifyXML(unknown, SerializerOptions)

Konvertiert das angegebene JSON-Objekt in eine XML-Zeichenfolge.

function stringifyXML(obj: unknown, opts?: SerializerOptions): string

Parameter

obj: unknown

JSON-Objekt, das in EINE XML-Zeichenfolge konvertiert werden soll

opts: SerializerOptions

Optionen, die die Analyse des angegebenen JSON-Objekts steuern

Gibt zurück

string

stripRequest(WebResourceLike)

Gibt eine strippede Version der HTTP-Anforderung zurück, die nicht den Autorisierungsheader enthält.

function stripRequest(request: WebResourceLike): WebResourceLike

Parameter

request: WebResourceLike

Das Http-Anforderungsobjekt

Gibt zurück

WebResourceLike

Die entfernte Version der Http-Anforderung.

stripResponse(HttpOperationResponse)

Gibt eine gestreifte Version der Http-Antwort zurück, die nur Textkörper, Header und den Status enthält.

function stripResponse(response: HttpOperationResponse): any

Parameter

response: HttpOperationResponse

Die HTTP-Antwort

Gibt zurück

any

Die entfernte Version der Http-Antwort.

systemErrorRetryPolicy(number, number, number, number)

Eine Richtlinie, die erneut auftritt, wenn ein Systemfehler auftritt, der durch die Codes "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" oder "ENOENT" identifiziert wird.

function systemErrorRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

Parameter

retryCount: number

Maximale Anzahl von Wiederholungsversuchen.

retryInterval: number

Das Client-Wiederholungsintervall in Millisekunden.

minRetryInterval: number

Das minimale Wiederholungsintervall in Millisekunden.

maxRetryInterval: number

Das maximale Wiederholungsintervall in Millisekunden.

Gibt zurück

RequestPolicyFactory

Eine Instanz des <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

Erstellt eine Richtlinie, die die Anforderung erneut sendet, wenn die Antwort angibt, dass die Anforderung aufgrund von Einschränkungsgründen fehlgeschlagen ist. Wenn die Antwort beispielsweise einen Retry-After Header enthält, wird das Senden der Anforderung basierend auf dem Wert dieses Headers wiederholt.

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(): RequestPolicyFactory

Gibt zurück

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

Erstellt eine Richtlinie, die ausgehende Anforderungen mit einer Ablaufverfolgungsspanne umschließt.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

Parameter

tracingOptions: TracingPolicyOptions

Ablaufverfolgungsoptionen.

Gibt zurück

RequestPolicyFactory

Eine Instanz der <xref:TracingPolicy> Klasse.

userAgentPolicy(TelemetryInfo)

Gibt eine Richtlinie zurück, die den Benutzer-Agent-Header ausgehenden Anforderungen basierend auf dem angegebenen TelemetryInfo-hinzufügt.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parameter

userAgentData: TelemetryInfo

Telemetrieinformationen.

Gibt zurück

RequestPolicyFactory

Eine neue <xref:UserAgentPolicy>.

Freigeben über

@azure/core-http package

Klassen

Schnittstellen

Typaliase

Enumerationen

Functions

Details zur Funktion

applyMixins(unknown, any[])

Parameter

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Parameter

Gibt zurück

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Parameter

Gibt zurück

delay(number, DelayOptions)

Parameter

Gibt zurück

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Parameter

Gibt zurück

deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)

Parameter

Gibt zurück

disableResponseDecompressionPolicy()

Gibt zurück

encodeUri(string)

Parameter

Gibt zurück

executePromisesSequentially(any[], unknown)

Parameter

Gibt zurück

exponentialRetryPolicy(number, number, number)

Parameter

Gibt zurück

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Parameter

Gibt zurück

generateClientRequestIdPolicy(string)

Parameter

Gibt zurück

generateUuid()

Gibt zurück

getDefaultProxySettings(string)

Parameter

Gibt zurück

getDefaultUserAgentValue()

Gibt zurück

isDuration(string)

Parameter

Gibt zurück

isTokenCredential(unknown)

Parameter

Gibt zurück

isValidUuid(string)

Parameter

Gibt zurück

keepAlivePolicy(KeepAliveOptions)

Parameter

Gibt zurück

logPolicy(LogPolicyOptions)

Parameter

Gibt zurück

operationOptionsToRequestOptionsBase<T>(T)

Parameter

Gibt zurück

parseXML(string, SerializerOptions)

Parameter

Gibt zurück

promiseToCallback(Promise<any>)

Parameter

Gibt zurück

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

redirectPolicy(number)