@azure/core-http package

Klasser

AccessTokenRefresher

Hjälper autentiseringsprinciperna för core-http-token att begära en ny token om vi för närvarande inte väntar på en ny token.

ApiKeyCredentials

Autentiserar till en tjänst med hjälp av en API-nyckel.

BaseRequestPolicy

Basklassen som alla begärandeprinciper härleds från.

BasicAuthenticationCredentials

En enkel <xref:ServiceClientCredential> som autentiserar med ett användarnamn och ett lösenord.

DefaultHttpClient

En HTTP-klient som använder node-fetch.

ExpiringAccessTokenCache

Tillhandahåller en AccessTokenCache-implementering som rensar cachelagrade AccessTokens när expiresOnTimestamp har passerat.

HttpHeaders

En samling nyckel-/värdepar för HTTP-huvud.

RequestPolicyOptions

Valfria egenskaper som kan användas när du skapar en RequestPolicy.

RestError

Ett fel som uppstår från en HTTP-begäran till en tjänstslutpunkt.

Serializer

Används för att mappa råa svarsobjekt till slutliga former. Hjälper till att packa upp och packa upp datum och andra kodade typer som inte är inbyggda i JSON. Du kan också hämta värden från rubriker, samt infoga standardvärden och konstanter.

ServiceClient

ServiceClient skickar tjänstbegäranden och tar emot svar.

TopicCredentials

Ett TopicCredentials-objekt som används för Azure Event Grid.

URLBuilder

En klass som hanterar skapande, ändring och parsning av URL:er.

URLQuery

En klass som hanterar frågedelen av en URLBuilder.

WebResource

Skapar ett nytt WebResource-objekt.

Den här klassen ger en abstraktion över ett REST-anrop genom att vara biblioteks-/implementeringsagnostisk och omsluta de nödvändiga egenskaperna för att initiera en begäran.

Gränssnitt

AbortSignalLike

Tillåter att begäran avbryts vid avfyrning av "abort"-händelsen. Kompatibel med webbläsarens inbyggda AbortSignal och vanliga polyfiller.

AccessToken

Representerar en åtkomsttoken med en förfallotid.

AccessTokenCache

Tillhandahåller en cache för en AccessToken som returnerades från en TokenCredential.

ApiKeyCredentialOptions

Beskriver de alternativ som ska anges när du skapar en instans av ApiKeyCredentials

BaseMapper

Basdefinitionen för en mappare. Kan användas för XML-objekt och vanliga JavaScript-objekt.

CompositeMapper

En mappare som består av andra mappare.

CompositeMapperType

Hjälper till att skapa en mappare som beskriver hur du mappar en uppsättning egenskaper för ett objekt baserat på andra mappare.

Endast en av följande egenskaper ska finnas: className, modelProperties och additionalProperties.

DeserializationContentTypes

De innehållstyper som anger att ett åtgärdssvar ska deserialiseras på ett visst sätt.

DeserializationOptions

Alternativ för att konfigurera API-svarsdeserialisering.

DictionaryMapper

En mappare som beskriver vanliga JavaScript-objekt som används som nyckel/värde-par.

DictionaryMapperType

Hjälper dig att skapa en mappning som beskriver hur du parsar en ordlista med mappade värden.

EnumMapper

En mappare som beskriver ett uppräkningsvärde.

EnumMapperType

Hjälper till att skapa en mappning som beskriver hur du parsar ett uppräkningsvärde.

GetTokenOptions

Definierar alternativ för TokenCredential.getToken.

HttpClient

Ett gränssnitt som kan skicka HttpRequests och ta emot utlovade HttpResponses.

HttpHeader

En enskild rubrik i en HttpHeaders-samling.

HttpHeadersLike

En samling nyckel-/värdepar för HTTP-huvud.

HttpOperationResponse

Omslutningsobjekt för http-begäran och -svar. Deserialiserat objekt lagras i parsedBody egenskapen när svarstexten tas emot i JSON eller XML.

HttpPipelineLogger

En loggare som kan läggas till i en HttpPipeline. Detta gör att varje RequestPolicy kan logga meddelanden som kan användas för felsökning.

HttpResponse

Egenskaperna för ett HTTP-svar som alltid kommer att finnas.

InternalPipelineOptions

Definierar alternativ som används för att konfigurera interna alternativ för HTTP-pipelinen för en SDK-klient.

KeepAliveOptions

Alternativ för hur HTTP-anslutningar ska underhållas för framtida begäranden.

LogPolicyOptions

Alternativ för att skicka till logPolicy. Som standard loggas endast en uppsättning rubriker, men detta kan konfigureras. Begärande- och svarskroppar loggas aldrig.

MapperConstraints

Beskrivning av olika värdebegränsningar, till exempel heltalsintervall och regex för strängar.

OperationArguments

En samling egenskaper som gäller för ett enda anrop av en åtgärd.

OperationOptions

Basalternativtypen för alla åtgärder.

OperationParameter

Ett gemensamt gränssnitt som alla åtgärdsparametrar utökar.

OperationQueryParameter

En parameter för en åtgärd som läggs till som en frågeparameter i åtgärdens HTTP-begäran.

OperationRequestOptions

Alternativ som gör det möjligt att konfigurera hanteringen av HTTP-begäranden som görs av en SDK-åtgärd.

OperationResponse

Ett OperationResponse som kan returneras från en åtgärdsbegäran för en enda statuskod.

OperationSpec

En specifikation som definierar hur du utför en viss tjänståtgärd via HTTP, inklusive hur du korrekt serialiserar information om begäran till och deserialiserar svarsinformation till en objektnyttolast som returneras av ServiceClient.

OperationURLParameter

En parameter för en åtgärd som ska ersättas med åtgärdens begärande-URL.

ParameterValue

Parametervärdet som anges för sökväg eller frågeparametrar i RequestPrepareOptions

PipelineOptions

Definierar alternativ som används för att konfigurera HTTP-pipelinen för en SDK-klient.

PolymorphicDiscriminator

Används för att skingra diskriminerade typföreningar. Om svaret till exempel kan ha många former men även innehåller ett "typfält" (eller liknande), kan det fältet användas för att avgöra hur svaret ska deserialiseras till rätt typ.

ProxySettings

Alternativ för att konfigurera en proxy för utgående begäranden (endast Node.js).

RedirectOptions

Alternativ för hur omdirigeringssvar hanteras.

RequestOptionsBase

Beskriver basstrukturen för alternativobjektet som ska användas i varje åtgärd.

RequestPolicy

Den underliggande strukturen för en begärandeprincip.

RequestPolicyOptionsLike

Valfria egenskaper som kan användas när du skapar en RequestPolicy.

RequestPrepareOptions

Alternativ för att förbereda en utgående HTTP-begäran.

RestResponse

Det utplattade svaret på ett REST-anrop. Innehåller den underliggande HttpOperationResponse samt de sammanslagna egenskaperna för parsedBody, parsedHeadersosv.

RetryOptions

Alternativ som styr hur du försöker utföra misslyckade begäranden igen.

SequenceMapper

En mappare som beskriver matriser.

SequenceMapperType

Hjälper till att skapa en mappning som beskriver hur du parsar en sekvens med mappade värden.

SerializerOptions

Alternativ för att styra beteendet för XML-parser och byggare.

ServiceCallback
ServiceClientCredentials

Representerar ett objekt eller en klass med en signRequest metod som signerar utgående begäranden (till exempel genom att ange Authorization rubriken).

ServiceClientOptions

Alternativ som ska anges när klienten skapas.

SimpleMapperType

Typen av enkel mappning.

TokenCredential

Representerar en autentiseringsuppgift som kan tillhandahålla en autentiseringstoken.

TracingPolicyOptions

Alternativ för att anpassa spårningsprincipen.

UrlParameterValue

Ett gränssnitt som representerar ett URL-parametervärde.

UserAgentOptions

Alternativ för att lägga till användaragentinformation i utgående begäranden.

WebResourceLike

En beskrivning av en HTTP-begäran som ska göras till en fjärrserver.

Typalias

Authenticator

En funktion som tar emot en utmaning och löser ett löfte med en strängtoken.

CommonRequestInfo

Sträng-URL:er som används vid anrop till fetch().

CommonRequestInit

Ett objekt som innehåller information om den utgående HTTP-begäran.

CommonResponse

Ett objekt som innehåller information om det inkommande HTTP-svaret.

HttpMethods

Lista över HTTP-metoder som stöds.

HttpRequestBody

Möjliga typer av HTTP-begärandetext

Mapper

Mappare är definitioner av de datamodeller som används i biblioteket. Dessa datamodeller är en del av åtgärds- eller klientdefinitionerna i svaren eller parametrarna.

MapperType

Typ av mappning. Innehåller kända mappningsmappare.

ParameterPath

En sökväg som beskriver hur du kommer åt en viss egenskap i en viss objektdatakälla. Kan vara ett enda egenskapsnamn, en matris som anger kapslade egenskapsnamn eller en uppsättning med flera namngivna egenskaper med sökvägar när det gäller komplexa objektvärden.

ProxyOptions

Ett alias för ProxyInställningar för framtida användning.

RawHttpHeaders

En HttpHeaders-samling som representeras som ett enkelt JSON-objekt.

RequestPolicyFactory

Skapar en ny RequestPolicy per begäran som använder den angivna nextPolicy.

TelemetryInfo

Telemetriinformation. Nyckel/värde-par som ska ingå i User-Agent strängen.

TransferProgressEvent

Utlöstes som svar på förloppet för uppladdning eller nedladdning.

Uppräkningar

HttpPipelineLogLevel

De olika nivåerna av loggar som kan användas med HttpPipelineLogger.

QueryCollectionFormat

Det format som ska användas för att koppla samman en matris med värden för ett frågeparametervärde.

RetryMode

Beskriver typ av återförsöksläge. Stöder för närvarande endast exponentiell.

Funktioner

applyMixins(unknown, any[])

Tillämpar egenskaperna på prototypen av sourceCtors på prototypen av targetCtor

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Skapar en ny fabrik för en RequestPolicy som tillämpar en ägartoken på begärandehuvudena Authorization .

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Skapar en HTTP-pipeline baserat på de angivna alternativen.

delay(number, DelayOptions)

En adapter för setTimeout som löser ett löfte efter timeInMs millisekunder.

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Skapa en ny serialisering av RequestPolicyCreator som serialiserade HTTP-begärandeorgan när de passerar genom HTTP-pipelinen.

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

Givet en viss uppsättning innehållstyper som ska parsas som antingen JSON eller XML, används HTTP-svaret för att skapa resultatobjektet som definieras av begärans OperationSpec.

disableResponseDecompressionPolicy()

Returnerar en begärandeprincipfabrik som kan användas för att skapa en instans av <xref:DisableResponseDecompressionPolicy>.

encodeUri(string)

Kodar en URI.

executePromisesSequentially(any[], unknown)

Kör en matris med löften sekventiellt. Inspirationen till den här metoden finns här: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. En fantastisk blogg om löften!

exponentialRetryPolicy(number, number, number)

Princip som försöker skicka begäran så många gånger som konfigurerats så länge som det maximala tidsintervallet för återförsök har angetts. Varje nytt försök väntar längre än den senaste gången.

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Parsar ett HttpOperationResponse till ett normaliserat HTTP-svarsobjekt (RestResponse).

generateClientRequestIdPolicy(string)

Skapar en princip som tilldelar ett unikt begärande-ID till utgående begäranden.

generateUuid()

Genererad UUID

getDefaultProxySettings(string)

Konverterar en viss URL för en proxyserver till ProxySettings eller försöker hämta ProxySettings från den aktuella miljön om en inte skickas.

getDefaultUserAgentValue()

Standardmetoden för att generera användaragenter. Använder statisk information från det här paketet, plus systeminformation som är tillgänglig från körningen.

isDuration(string)

Anger om den angivna strängen är i ISO 8601-format.

isTokenCredential(unknown)

Testar ett objekt för att avgöra om det implementerar TokenCredential.

isValidUuid(string)

Verifierar angivet uuid som en sträng

keepAlivePolicy(KeepAliveOptions)

Skapar en princip som styr om HTTP-anslutningar underhålls på framtida begäranden.

logPolicy(LogPolicyOptions)

Skapar en princip som loggar information om den utgående begäran och inkommande svar.

operationOptionsToRequestOptionsBase<T>(T)

Konverterar en OperationOptions till en RequestOptionsBase

parseXML(string, SerializerOptions)

Konverterar angiven XML-sträng till JSON

promiseToCallback(Promise<any>)

Konverterar ett löfte till ett återanrop.

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Konverterar ett löfte till ett tjänståteranrop.

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

En princip som gör att en kan tillämpa proxyinställningar på alla begäranden. Om de inte skickas med statiska inställningar hämtas de från HTTPS_PROXY- eller HTTP_PROXY miljövariablerna.

redirectPolicy(number)

Skapar en omdirigeringsprincip som skickar en upprepar begäran till ett nytt mål om ett svar kommer med ett "plats"-huvud och en statuskod mellan 300 och 307.

serializeObject(unknown)

Verktygsfunktion som serialiserar ett objekt som kan innehålla binär information i ett vanligt objekt, en matris eller en sträng.

signingPolicy(ServiceClientCredentials)

Skapar en princip som signerar utgående begäranden genom att anropa till den angivna authenticationProvidersignRequest metoden .

stringifyXML(unknown, SerializerOptions)

Konverterar angivet JSON-objekt till XML-sträng

stripRequest(WebResourceLike)

Returnerar en borttagen version av HTTP-begäran som inte innehåller auktoriseringshuvudet.

stripResponse(HttpOperationResponse)

Returnerar en borttagen version av Http-svaret som endast innehåller brödtext, rubriker och status.

systemErrorRetryPolicy(number, number, number, number)

En princip som försöker igen när det finns ett systemfel som identifieras av koderna "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" eller "ENOENT".

throttlingRetryPolicy()

Skapar en princip som skickar begäran igen om svaret anger att begäran misslyckades på grund av begränsningsskäl. Om svaret till exempel innehåller ett Retry-After huvud försöker det skicka begäran igen baserat på värdet för det huvudet.

Mer information finns i 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 och https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

tracingPolicy(TracingPolicyOptions)

Skapar en princip som omsluter utgående begäranden med ett spårningsintervall.

userAgentPolicy(TelemetryInfo)

Returnerar en princip som lägger till användaragenthuvudet i utgående begäranden baserat på angiven TelemetryInfo.

Funktionsinformation

applyMixins(unknown, any[])

Tillämpar egenskaperna på prototypen av sourceCtors på prototypen av targetCtor

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

Parametrar

targetCtorParam

unknown

sourceCtors

any[]

En matris med källobjekt som egenskaperna måste hämtas från.

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Skapar en ny fabrik för en RequestPolicy som tillämpar en ägartoken på begärandehuvudena Authorization .

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

Parametrar

credential
TokenCredential

Den TokenCredential-implementering som kan ange ägartoken.

scopes

string | string[]

De omfång som ägartoken gäller för.

Returer

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Skapar en HTTP-pipeline baserat på de angivna alternativen.

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

Parametrar

pipelineOptions
InternalPipelineOptions

Definierar alternativ som används för att konfigurera principer i HTTP-pipelinen för en SDK-klient.

authPolicyFactory
RequestPolicyFactory

En valfri autentiseringsprincipfabrik som ska användas för signeringsbegäranden.

Returer

En uppsättning alternativ som kan skickas för att skapa en ny ServiceClient.

delay(number, DelayOptions)

En adapter för setTimeout som löser ett löfte efter timeInMs millisekunder.

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

Parametrar

timeInMs

number

Antalet millisekunder som ska fördröjas.

options
DelayOptions

Alternativen för fördröjning – alternativ för närvarande avbrutna

Returer

Promise<void>

Promise som löses efter timeInMs

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Skapa en ny serialisering av RequestPolicyCreator som serialiserade HTTP-begärandeorgan när de passerar genom HTTP-pipelinen.

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

Parametrar

deserializationContentTypes
DeserializationContentTypes
parsingOptions
SerializerOptions

Returer

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

Givet en viss uppsättning innehållstyper som ska parsas som antingen JSON eller XML, används HTTP-svaret för att skapa resultatobjektet som definieras av begärans OperationSpec.

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

Parametrar

jsonContentTypes

string[]

Svarsinnehållstyper för att parsa brödtexten som JSON.

xmlContentTypes

string[]

Svarsinnehållstyper för att parsa brödtexten som XML.

response
HttpOperationResponse

HTTP-svar från pipelinen.

options
SerializerOptions

Alternativ för serialiseraren, främst för att konfigurera XML-parsern om det behövs.

Returer

Ett parsat HttpOperationResponse-objekt som kan returneras av ServiceClient.

disableResponseDecompressionPolicy()

Returnerar en begärandeprincipfabrik som kan användas för att skapa en instans av <xref:DisableResponseDecompressionPolicy>.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

Returer

encodeUri(string)

Kodar en URI.

function encodeUri(uri: string): string

Parametrar

uri

string

Den URI som ska kodas.

Returer

string

Den kodade URI:n.

executePromisesSequentially(any[], unknown)

Kör en matris med löften sekventiellt. Inspirationen till den här metoden finns här: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. En fantastisk blogg om löften!

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

Parametrar

promiseFactories

any[]

En matris med promise-fabriker (en funktion som returnerar ett löfte)

kickstart

unknown

Indata till det första löftet som används för att kickstarta löfteskedjan. Om det inte anges börjar löfteskedjan med odefinierad.

Returer

Promise<any>

En kedja av lösta eller avvisade löften

exponentialRetryPolicy(number, number, number)

Princip som försöker skicka begäran så många gånger som konfigurerats så länge som det maximala tidsintervallet för återförsök har angetts. Varje nytt försök väntar längre än den senaste gången.

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

Parametrar

retryCount

number

Maximalt antal återförsök.

retryInterval

number

Bastid mellan återförsök.

maxRetryInterval

number

Maximal väntetid mellan återförsök.

Returer

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Parsar ett HttpOperationResponse till ett normaliserat HTTP-svarsobjekt (RestResponse).

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

Parametrar

_response
HttpOperationResponse

Omslutningsobjekt för http-svar.

responseSpec

undefined | OperationResponse

Mappare för hur du parsar svarsegenskaperna.

Returer

  • Ett normaliserat svarsobjekt.

generateClientRequestIdPolicy(string)

Skapar en princip som tilldelar ett unikt begärande-ID till utgående begäranden.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parametrar

requestIdHeaderName

string

Namnet på rubriken som ska användas när du tilldelar det unika ID:t till begäran.

Returer

generateUuid()

Genererad UUID

function generateUuid(): string

Returer

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

Konverterar en viss URL för en proxyserver till ProxySettings eller försöker hämta ProxySettings från den aktuella miljön om en inte skickas.

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

Parametrar

proxyUrl

string

URL för proxyn

Returer

ProxySettings | undefined

Standardproxyinställningarna eller odefinierade.

getDefaultUserAgentValue()

Standardmetoden för att generera användaragenter. Använder statisk information från det här paketet, plus systeminformation som är tillgänglig från körningen.

function getDefaultUserAgentValue(): string

Returer

string

isDuration(string)

Anger om den angivna strängen är i ISO 8601-format.

function isDuration(value: string): boolean

Parametrar

value

string

Värdet som ska valideras för ISO 8601-varaktighetsformat.

Returer

boolean

true om det är giltigt, false annars.

isTokenCredential(unknown)

Testar ett objekt för att avgöra om det implementerar TokenCredential.

function isTokenCredential(credential: unknown): credential

Parametrar

credential

unknown

Den antagna TokenCredential som ska testas.

Returer

credential

isValidUuid(string)

Verifierar angivet uuid som en sträng

function isValidUuid(uuid: string): boolean

Parametrar

uuid

string

Uuid som en sträng som måste verifieras

Returer

boolean

Sant om uuid är giltigt; annars falskt.

keepAlivePolicy(KeepAliveOptions)

Skapar en princip som styr om HTTP-anslutningar underhålls på framtida begäranden.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Parametrar

keepAliveOptions
KeepAliveOptions

Håll liv i alternativ. SOM standard underhålls HTTP-anslutningar för framtida begäranden.

Returer

En instans av <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

Skapar en princip som loggar information om den utgående begäran och inkommande svar.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

Parametrar

loggingOptions
LogPolicyOptions

Loggningsalternativ.

Returer

En instans av <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

Konverterar en OperationOptions till en RequestOptionsBase

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

Parametrar

opts

T

OperationOptions-objekt som ska konverteras till RequestOptionsBase

Returer

parseXML(string, SerializerOptions)

Konverterar angiven XML-sträng till JSON

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

Parametrar

str

string

Sträng som innehåller XML-innehållet som ska parsas i JSON

opts
SerializerOptions

Alternativ som styr parsningen av angiven XML-sträng

Returer

Promise<any>

promiseToCallback(Promise<any>)

Varning

Det här API:et är nu inaktuellt.

generated code should instead depend on responseToBody

Konverterar ett löfte till ett återanrop.

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

Parametrar

promise

Promise<any>

Löftet som ska konverteras till ett återanrop

Returer

(cb: Function) => void

En funktion som tar motringningen (cb: Function) => void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Konverterar ett löfte till ett tjänståteranrop.

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

Parametrar

promise

Promise<HttpOperationResponse>

Löftet om att HttpOperationResponse ska konverteras till ett återanrop till tjänsten

Returer

(cb: ServiceCallback<T>) => void

En funktion som tar tjänståteranropet (cb: ServiceCallback): void

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

En princip som gör att en kan tillämpa proxyinställningar på alla begäranden. Om de inte skickas med statiska inställningar hämtas de från HTTPS_PROXY- eller HTTP_PROXY miljövariablerna.

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

Parametrar

proxySettings
ProxySettings

ProxyInställningar som ska användas för varje begäran.

options

{ customNoProxyList?: string[] }

ytterligare inställningar, till exempel anpassade NO_PROXY mönster

Returer

redirectPolicy(number)

Skapar en omdirigeringsprincip som skickar en upprepar begäran till ett nytt mål om ett svar kommer med ett "plats"-huvud och en statuskod mellan 300 och 307.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parametrar

maximumRetries

number

Maximalt antal omdirigeringar att följa.

Returer

En instans av <xref:RedirectPolicy>

serializeObject(unknown)

Verktygsfunktion som serialiserar ett objekt som kan innehålla binär information i ett vanligt objekt, en matris eller en sträng.

function serializeObject(toSerialize: unknown): any

Parametrar

toSerialize

unknown

Returer

any

signingPolicy(ServiceClientCredentials)

Skapar en princip som signerar utgående begäranden genom att anropa till den angivna authenticationProvidersignRequest metoden .

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parametrar

authenticationProvider
ServiceClientCredentials

Autentiseringsprovidern.

Returer

En instans av <xref:SigningPolicy>.

stringifyXML(unknown, SerializerOptions)

Konverterar angivet JSON-objekt till XML-sträng

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

Parametrar

obj

unknown

JSON-objekt som ska konverteras till XML-sträng

opts
SerializerOptions

Alternativ som styr parsningen av ett givet JSON-objekt

Returer

string

stripRequest(WebResourceLike)

Returnerar en borttagen version av HTTP-begäran som inte innehåller auktoriseringshuvudet.

function stripRequest(request: WebResourceLike): WebResourceLike

Parametrar

request
WebResourceLike

Http-begärandeobjektet

Returer

Den borttagna versionen av HTTP-begäran.

stripResponse(HttpOperationResponse)

Returnerar en borttagen version av Http-svaret som endast innehåller brödtext, rubriker och status.

function stripResponse(response: HttpOperationResponse): any

Parametrar

response
HttpOperationResponse

Http-svaret

Returer

any

Den borttagna versionen av HTTP-svar.

systemErrorRetryPolicy(number, number, number, number)

En princip som försöker igen när det finns ett systemfel som identifieras av koderna "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" eller "ENOENT".

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

Parametrar

retryCount

number

Maximalt antal återförsök.

retryInterval

number

Klientens återförsöksintervall i millisekunder.

minRetryInterval

number

Minsta återförsöksintervall i millisekunder.

maxRetryInterval

number

Det maximala återförsöksintervallet i millisekunder.

Returer

En instans av <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

Skapar en princip som skickar begäran igen om svaret anger att begäran misslyckades på grund av begränsningsskäl. Om svaret till exempel innehåller ett Retry-After huvud försöker det skicka begäran igen baserat på värdet för det huvudet.

Mer information finns i 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 och https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): RequestPolicyFactory

Returer

tracingPolicy(TracingPolicyOptions)

Skapar en princip som omsluter utgående begäranden med ett spårningsintervall.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

Parametrar

tracingOptions
TracingPolicyOptions

Spårningsalternativ.

Returer

En instans av <xref:TracingPolicy> klassen .

userAgentPolicy(TelemetryInfo)

Returnerar en princip som lägger till användaragenthuvudet i utgående begäranden baserat på angiven TelemetryInfo.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parametrar

userAgentData
TelemetryInfo

Telemetriinformation.

Returer

En ny <xref:UserAgentPolicy>.