@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 bei einem Dienst mithilfe eines API-Schlüssels.
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 verwendet `node-fetch`.
ExpiringAccessTokenCache	Stellt eine AccessTokenCache-Implementierung bereit, die die zwischengespeicherten AccessTokens löscht, nachdem der ExpiresOnTimestamp bestanden wurde.
HttpHeaders	Eine Auflistung von Schlüssel-Wert-Paaren im HTTP-Header.
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 rohe Antwortobjekte endgültigen Shapes zuzuordnen. Hilft beim Packen und Entpacken von Datumsangaben und anderen codierten Typen, die nicht in JSON enthalten sind. Ermöglicht auch das Pullen von Werten aus Headern 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 verarbeitet.
URLQuery	Eine Klasse, die den Abfrageteil eines URLBuilders verarbeitet.
WebResource	Erstellt ein neues WebResource-Objekt. Diese Klasse bietet eine Abstraktion für einen REST-Aufruf, indem sie bibliotheksunabhängig ist und die erforderlichen Eigenschaften umgibt, um eine Anforderung zu initiieren.

Schnittstellen

AbortSignalLike	Ermöglicht das Abbrechen der Anforderung beim Auslösen des "abort"-Ereignisses. Kompatibel mit dem im 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 ein Satz 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 zugesagte HttpResponses empfangen kann.
HttpHeader	Ein einzelner Header innerhalb einer HttpHeaders-Auflistung.
HttpHeadersLike	Eine Auflistung von Schlüssel-Wert-Paaren im HTTP-Header.
HttpOperationResponse	Wrapperobjekt für HTTP-Anforderung und -Antwort. Das deserialisierte Objekt wird in der `parsedBody` -Eigenschaft gespeichert, wenn der Antworttext in JSON oder XML empfangen wird.
HttpPipelineLogger	Eine Protokollierung, die einer HttpPipeline hinzugefügt werden kann. Dadurch kann jede RequestPolicy Meldungen protokollieren, die zu Debugzwecken verwendet werden können.
HttpResponse	Die Eigenschaften einer 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, wie HTTP-Verbindungen für zukünftige Anforderungen beibehalten werden sollen.
LogPolicyOptions	Optionen, die an die logPolicy übergeben werden sollen. Standardmäßig wird nur eine Setliste von Headern protokolliert, dies kann jedoch konfiguriert werden. Anforderungs- und Antworttexte werden nie protokolliert.
MapperConstraints	Beschreibung verschiedener Werteinschränkungen wie Ganzzahlbereiche und Zeichenfolgenregex.
OperationArguments	Eine Auflistung von Eigenschaften, die auf einen einzelnen Aufruf eines Vorgangs angewendet werden.
OperationOptions	Der Basisoptionentyp für alle Vorgänge.
OperationParameter	Eine gemeinsame Schnittstelle, die von allen Operation-Parametern erweitert wird.
OperationQueryParameter	Ein Parameter für einen Vorgang, der der HTTP-Anforderung des Vorgangs als Abfrageparameter hinzugefügt wird.
OperationRequestOptions	Optionen, die das Konfigurieren der Verarbeitung von HTTP-Anforderungen ermöglichen, die von einem SDK-Vorgang ausgeführt werden.
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 durch 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 diskriminierte Typverflechtung zu disambiguieren. Wenn die Antwort beispielsweise viele Shapes enthalten kann, aber auch ein "Kind"-Feld (oder ähnliches) enthält, kann dieses Feld verwendet werden, um zu bestimmen, wie die Antwort auf den richtigen Typ deserialisiert werden soll.
ProxySettings	Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen (nur Node.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 abgeflachte Antwort auf einen REST-Aufruf. Enthält die zugrunde liegende HttpOperationResponse sowie die zusammengeführten Eigenschaften von `parsedBody`, `parsedHeaders`usw.
RetryOptions	Optionen, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden.
SequenceMapper	Ein Mapper, der Arrays beschreibt.
SequenceMapperType	Hilft beim Erstellen eines Mappers, der beschreibt, wie eine Sequenz zugeordneter Werte analysiert wird.
SerializerOptions	Optionen zum Steuern des Verhaltens von XML-Parser und -Generatoren.
ServiceCallback
ServiceClientCredentials	Stellt ein Objekt oder eine Klasse mit einer `signRequest` Methode dar, die ausgehende Anforderungen signiert (z. B. durch Festlegen des Headers `Authorization` ).
ServiceClientOptions	Optionen, die beim Erstellen des Clients bereitgestellt werden sollen.
SimpleMapperType	Der Typ eines einfachen Zuordnungsvorgangs.
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 einen Remoteserver gestellt werden soll.

Typaliase

Authenticator	Eine Funktion, die eine Anforderung empfängt und eine Zusage mit einem Zeichenfolgentoken auflö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 über die eingehende 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 Eigenschaftennamen angibt, oder ein Satz von mehreren benannten Eigenschaften mit Pfaden bei komplexen Objektwerten 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	Ausgelöst als Reaktion auf den Upload- oder Downloadstatus.

Enumerationen

HttpPipelineLogLevel	Die verschiedenen Protokollebenen, die mit httpPipelineLogger verwendet werden können.
QueryCollectionFormat	Das Format, das zum Verknüpfen eines Arrays von Werten für einen Abfrageparameterwert verwendet wird.
RetryMode	Beschreibt den Wiederholungsmodustyp. Derzeit wird nur Exponential unterstützt.

Functions

applyMixins(unknown, any[])	Wendet die Eigenschaften auf dem 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 Header der Anforderungen `Authorization` 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 auflöst.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	Erstellen Sie eine neue Serialisierung RequestPolicyCreator, die HTTP-Anforderungstexte serialisiert, während sie die HTTP-Pipeline durchlaufen.
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	Bei einem bestimmten Satz von Inhaltstypen, die entweder als JSON oder XML analysiert werden sollen, verwendet die HTTP-Antwort, 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 für diese Methode ist hier: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Ein großartiger Blog über Zusagen!
exponentialRetryPolicy(number, number, number)	Richtlinie, die die Anforderung so oft wie konfiguriert wiederholt, solange das maximale Wiederholungszeitintervall angegeben ist, wobei jeder Wiederholungsversuch länger auf den Anfang wartet als das letzte Mal.
flattenResponse(HttpOperationResponse, undefined \| OperationResponse)	Analysiert ein HttpOperationResponse-Objekt 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 angegebene URL eines Proxyservers in `ProxySettings` oder versucht, aus der aktuellen Umgebung abzurufen `ProxySettings` , wenn keine übergeben wird.
getDefaultUserAgentValue()	Der Standardansatz zum Generieren von Benutzer-Agents. Verwendet statische Informationen aus diesem Paket sowie Systeminformationen, die in der Runtime verfügbar sind.
isDuration(string)	Gibt an, ob die angegebene Zeichenfolge im ISO 8601-Format vorliegt.
isTokenCredential(unknown)	Testet ein -Objekt, um zu bestimmen, ob TokenCredential implementiert wird.
isValidUuid(string)	Überprüft die angegebene uuid als Zeichenfolge.
keepAlivePolicy(KeepAliveOptions)	Erstellt eine Richtlinie, die steuert, ob HTTP-Verbindungen bei zukünftigen Anforderungen beibehalten 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 Proxyeinstellungen auf alle Anforderungen angewendet werden können. Wenn statische Einstellungen nicht übergeben werden, werden sie aus den umgebungsvariablen HTTPS_PROXY oder HTTP_PROXY abgerufen.
redirectPolicy(number)	Erstellt eine Umleitungsrichtlinie, die die Anforderung wiederholt an ein neues Ziel sendet, wenn eine Antwort mit einem "location"-Header und einem Statuscode zwischen 300 und 307 eingeht.
serializeObject(unknown)	Hilfsprogrammfunktion, die ein Objekt, das binäre Informationen enthalten kann, in ein einfaches Objekt, array oder eine Zeichenfolge serialisiert.
signingPolicy(ServiceClientCredentials)	Erstellt eine Richtlinie, die ausgehende Anforderungen durch Aufrufen der angegebenen `authenticationProvider`- `signRequest` Methode signiert.
stringifyXML(unknown, SerializerOptions)	Konvertiert das angegebene JSON-Objekt in eine XML-Zeichenfolge.
stripRequest(WebResourceLike)	Gibt eine entfernte Version der HTTP-Anforderung zurück, die nicht den Autorisierungsheader enthält.
stripResponse(HttpOperationResponse)	Gibt eine entfernte Version der HTTP-Antwort zurück, die nur Text, Header und den Status enthält.
systemErrorRetryPolicy(number, number, number, number)	Eine Richtlinie, die wiederholt wird, 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 darauf hinweist, dass die Anforderung aus Drosselungsgründen fehlgeschlagen ist. Wenn die Antwort beispielsweise einen `Retry-After` Header enthält, wird die Anforderung basierend auf dem Wert dieses Headers erneut gesendet. 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-limits . 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 ausgehenden Anforderungen basierend auf der angegebenen TelemetryInfo den Benutzer-Agent-Header hinzufügt.

Details zur Funktion

applyMixins(unknown, any[])

Wendet die Eigenschaften auf dem 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 dem die Eigenschaften übernommen werden müssen.

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Erstellt eine neue Factory für eine RequestPolicy, die ein Bearertoken auf die Header der Anforderungen Authorization 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 einen neuen ServiceClient zu erstellen.

delay(number, DelayOptions)

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

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

Parameter

timeInMs: number

Die Anzahl der Millisekunden, die verzögert werden sollen.

options: DelayOptions

Die Optionen für Verzögerung – derzeit Abbruchoptionen

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 die HTTP-Pipeline durchlaufen.

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

Parameter

deserializationContentTypes: DeserializationContentTypes

parsingOptions: SerializerOptions

Gibt zurück

RequestPolicyFactory

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

Bei einem bestimmten Satz von Inhaltstypen, die entweder als JSON oder XML analysiert werden sollen, verwendet die HTTP-Antwort, 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 Text als JSON zu analysieren.

xmlContentTypes: string[]

Antwortinhaltstypen, um den Text als XML zu analysieren.

response: HttpOperationResponse

HTTP-Antwort von der Pipeline.

options: SerializerOptions

Optionen für das Serialisierungsprogramm, 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 codierende URI.

Gibt zurück

string

Der codierte URI.

executePromisesSequentially(any[], unknown)

Führt ein Array von Zusagen sequenziell aus. Inspiration für diese Methode ist hier: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Ein großartiger Blog über 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

Geben Sie die erste Zusage ein, die verwendet wird, um die Zusagekette zu starten. Wenn nicht angegeben, beginnt die Zusagekette mit undefiniert.

Gibt zurück

Promise<any>

Eine Kette von aufgelösten oder abgelehnten Zusagen

exponentialRetryPolicy(number, number, number)

Richtlinie, die die Anforderung so oft wie konfiguriert wiederholt, solange das maximale Wiederholungszeitintervall angegeben ist, wobei jeder Wiederholungsversuch länger auf den Anfang wartet als das letzte Mal.

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

Parameter

retryCount: number

Maximale Anzahl von Wiederholungen.

retryInterval: number

Basiszeit zwischen Wiederholungsversuchen.

maxRetryInterval: number

Maximale Wartezeit zwischen Wiederholungsversuchen.

Gibt zurück

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Analysiert ein HttpOperationResponse-Objekt 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 für die Analyse 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 verwendet werden soll, wenn die eindeutige ID der Anforderung zugewiesen wird.

Gibt zurück

RequestPolicyFactory

generateUuid()

Generierte UUID

function generateUuid(): string

Gibt zurück

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

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

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

Parameter

proxyUrl: string

URL des Proxys

Gibt zurück

ProxySettings | undefined

Die Standardproxyeinstellungen oder undefiniert.

getDefaultUserAgentValue()

Der Standardansatz zum Generieren von Benutzer-Agents. Verwendet statische Informationen aus diesem Paket sowie Systeminformationen, die in der Runtime 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

true , wenn gültig, andernfalls false .

isTokenCredential(unknown)

Testet ein -Objekt, um zu bestimmen, ob TokenCredential implementiert wird.

function isTokenCredential(credential: unknown): credential

Parameter

credential: unknown

Die angenommenen TokenCredential, 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 bei zukünftigen Anforderungen beibehalten werden.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Parameter

keepAliveOptions: KeepAliveOptions

Bleiben Sie aktiv. Standardmäßig werden HTTP-Verbindungen für zukünftige Anforderungen beibehalten.

Gibt zurück

RequestPolicyFactory

Eine Instanz der <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 der <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

Konvertiert eine OperationOptions in eine RequestOptionsBase

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

Parameter

opts: T

OperationOptions-Objekt, das in RequestOptionsBase konvertiert werden soll

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 mit dem XML-Inhalt, 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 Zusage, die in einen Rückruf konvertiert werden soll

Gibt zurück

(cb: Function) => void

Eine Funktion, die den Rückruf entgegennimmt (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 entgegennimmt (cb: ServiceCallback): void

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

Eine Richtlinie, mit der Proxyeinstellungen auf alle Anforderungen angewendet werden können. Wenn statische Einstellungen nicht übergeben werden, werden sie aus den umgebungsvariablen HTTPS_PROXY oder HTTP_PROXY 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 die Anforderung wiederholt an ein neues Ziel sendet, wenn eine Antwort mit einem "location"-Header und einem Statuscode zwischen 300 und 307 eingeht.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parameter

maximumRetries: number

Maximale Anzahl der zu befolgenden Umleitungen.

Gibt zurück

RequestPolicyFactory

Eine Instanz der <xref:RedirectPolicy>

serializeObject(unknown)

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

function serializeObject(toSerialize: unknown): any

Parameter

toSerialize: unknown

Gibt zurück

any

signingPolicy(ServiceClientCredentials)

Erstellt eine Richtlinie, die ausgehende Anforderungen durch Aufrufen der angegebenen authenticationProvider- signRequest Methode signiert.

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parameter

authenticationProvider: ServiceClientCredentials

Der Authentifizierungsanbieter.

Gibt zurück

RequestPolicyFactory

Eine Instanz von <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 entfernte 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 entfernte Version der HTTP-Antwort zurück, die nur Text, Header und den Status enthält.

function stripResponse(response: HttpOperationResponse): any

Parameter

response: HttpOperationResponse

Die HTTP-Antwort

Gibt zurück

any

Die entfernte Version von HTTP-Antwort.

systemErrorRetryPolicy(number, number, number, number)

Eine Richtlinie, die wiederholt wird, 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 Wiederholungen.

retryInterval: number

Das Wiederholungsintervall des Clients in Millisekunden.

minRetryInterval: number

Das minimale Wiederholungsintervall in Millisekunden.

maxRetryInterval: number

Das maximale Wiederholungsintervall in Millisekunden.

Gibt zurück

RequestPolicyFactory

Eine Instanz der <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

Erstellt eine Richtlinie, die die Anforderung erneut sendet, wenn die Antwort darauf hinweist, dass die Anforderung aus Drosselungsgründen fehlgeschlagen ist. Wenn die Antwort beispielsweise einen Retry-After Header enthält, wird die Anforderung basierend auf dem Wert dieses Headers erneut gesendet.

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-limits . 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 ausgehenden Anforderungen basierend auf der angegebenen TelemetryInfo den Benutzer-Agent-Header hinzufügt.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parameter

userAgentData: TelemetryInfo

Telemetrieinformationen.

Gibt zurück

RequestPolicyFactory

Ein neuer <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)