@azure/core-http package

Třídy

AccessTokenRefresher	Pomáhá zásadám ověřování tokenů core-http s žádostí o nový token, pokud aktuálně nečekáme na nový token.
ApiKeyCredentials	Ověřuje se ve službě pomocí klíče rozhraní API.
BaseRequestPolicy	Základní třída, ze které jsou odvozeny všechny zásady požadavků.
BasicAuthenticationCredentials	Jednoduchý <xref:ServiceClientCredential>, který se ověřuje pomocí uživatelského jména a hesla.
DefaultHttpClient	Klient HTTP, který používá `node-fetch`.
ExpiringAccessTokenCache	Poskytuje AccessTokenCache implementaci, která vymaže AccessTokenpo vypršení platnostiOnTimestamp.
HttpHeaders	Kolekce párů klíč/hodnota hlavičky HTTP.
RequestPolicyOptions	Volitelné vlastnosti, které lze použít při vytváření RequestPolicy.
RestError	Chyba vyplývající z požadavku HTTP na koncový bod služby.
Serializer	Slouží k mapování nezpracovaných objektů odpovědi na konečné obrazce. Pomáhá balit a rozbalovat kalendářní data a další kódované typy, které nejsou vnitřní pro JSON. Umožňuje také načítání hodnot ze záhlaví a vkládání výchozích hodnot a konstant.
ServiceClient	ServiceClient odesílá žádosti o služby a přijímá odpovědi.
TopicCredentials	Objekt TopicCredentials použitý pro Azure Event Grid.
URLBuilder	Třída, která zpracovává vytváření, úpravy a parsování adres URL.
URLQuery	Třída, která zpracovává část dotazu urlBuilder.
WebResource	Vytvoří nový objekt WebResource. Tato třída poskytuje abstrakci volání REST tím, že je knihovna / implementace nezávislá a zabalení nezbytných vlastností k zahájení požadavku.

Rozhraní

AbortSignalLike	Umožňuje přerušení požadavku při aktivaci události "přerušení". Kompatibilní s integrovaným prohlížečem AbortSignal a běžnými polyfilly.
AccessToken	Představuje přístupový token s časem vypršení platnosti.
AccessTokenCache	Poskytuje mezipaměť pro AccessToken, který byl vrácen z TokenCredential.
ApiKeyCredentialOptions	Popisuje možnosti, které se mají poskytnout při vytváření instance ApiKeyCredentials.
BaseMapper	Základní definice mapperu. Lze použít pro xml a prosté javascriptové objekty.
CompositeMapper	Mapovač složený z jiných mapperů.
CompositeMapperType	Pomáhá vytvořit mapovač, který popisuje, jak mapovat sadu vlastností objektu na základě jiných mapperů. Měla by existovat pouze jedna z následujících vlastností: `className`, `modelProperties` a `additionalProperties`.
DeserializationContentTypes	Typy obsahu, které budou indikovat, že odpověď operace by měla být deserializována určitým způsobem.
DeserializationOptions	Možnosti konfigurace deserializace odpovědí rozhraní API
DictionaryMapper	Mapper popisující prosté javascriptové objekty používané jako páry klíč/hodnota.
DictionaryMapperType	Pomáhá vytvořit mapovač, který popisuje, jak analyzovat slovník mapovaných hodnot.
EnumMapper	Mapper popisující hodnotu výčtu
EnumMapperType	Pomáhá vytvořit mapovač, který popisuje, jak parsovat hodnotu výčtu.
GetTokenOptions	Definuje možnosti pro TokenCredential.getToken.
HttpClient	Rozhraní, které může odesílat HttpRequests a přijímat slibované HttpResponses.
HttpHeader	Jednotlivá hlavička v kolekci HttpHeaders.
HttpHeadersLike	Kolekce párů klíč/hodnota hlavičky HTTP.
HttpOperationResponse	Objekt obálky pro požadavek HTTP a odpověď. Deserializovaný objekt je uložen v `parsedBody` vlastnost při přijetí textu odpovědi ve formátu JSON nebo XML.
HttpPipelineLogger	Logger, který lze přidat do httpPipeline. To umožňuje každé RequestPolicy protokolovat zprávy, které lze použít pro účely ladění.
HttpResponse	Vlastnosti odpovědi HTTP, která bude vždy přítomna.
InternalPipelineOptions	Definuje možnosti, které se používají ke konfiguraci interních možností kanálu HTTP pro klienta sady SDK.
KeepAliveOptions	Možnosti zachování připojení HTTP pro budoucí požadavky
LogPolicyOptions	Možnosti předání logPolicy . Ve výchozím nastavení se protokolují pouze sady hlaviček, i když je možné je nakonfigurovat. Požadavky a odpovědi se nikdy nezaprotokolují.
MapperConstraints	Popis různých omezení hodnot, jako jsou rozsahy celých čísel a řetězcové regulární výrazy.
OperationArguments	Kolekce vlastností, které se vztahují na jedno vyvolání operace.
OperationOptions	Základní typ možností pro všechny operace.
OperationParameter	Společné rozhraní, které rozšiřuje všechny parametry operace.
OperationQueryParameter	Parametr pro operaci, která se přidá jako parametr dotazu do požadavku HTTP operace.
OperationRequestOptions	Možnosti, které umožňují konfiguraci zpracování požadavků HTTP provedených operací sady SDK.
OperationResponse	OperationResponse, která se dá vrátit z žádosti o operaci pro jeden stavový kód.
OperationSpec	Specifikace, která definuje, jak provést konkrétní operaci služby přes PROTOKOL HTTP, včetně toho, jak správně serializovat informace o požadavku do a deserializovat informace o odpovědi do datové části objektu vrátitelné ServiceClient.
OperationURLParameter	Parametr operace, která bude nahrazena adresou URL požadavku operace.
ParameterValue	Hodnota parametru zadaná pro parametry cesty nebo dotazu v RequestPrepareOptions
PipelineOptions	Definuje možnosti, které se používají ke konfiguraci kanálu HTTP pro klienta sady SDK.
PolymorphicDiscriminator	Používá se k nejednoznačnosti diskriminovaných sjednocení typů. Pokud odpověď může mít například mnoho obrazců, ale obsahuje také pole typu (nebo podobné), lze toto pole použít k určení způsobu deserializace odpovědi na správný typ.
ProxySettings	Možnosti konfigurace proxy serveru pro odchozí požadavky (pouzeNode.js).
RedirectOptions	Možnosti zpracování odpovědí na přesměrování
RequestOptionsBase	Popisuje základní strukturu objektu options, který se použije v každé operaci.
RequestPolicy	Základní struktura zásady žádosti.
RequestPolicyOptionsLike	Volitelné vlastnosti, které lze použít při vytváření RequestPolicy.
RequestPrepareOptions	Možnosti přípravy odchozího požadavku HTTP
RestResponse	Zploštěná odpověď na volání REST. Obsahuje základní HttpOperationResponse a také sloučené vlastnosti `parsedBody`, `parsedHeaders`atd.
RetryOptions	Možnosti, které řídí, jak opakovat neúspěšné požadavky.
SequenceMapper	Mapovač popisující pole
SequenceMapperType	Pomáhá vytvořit mapovač, který popisuje, jak parsovat posloupnost mapovaných hodnot.
SerializerOptions	Možnosti řízení chování analyzátoru XML a tvůrce
ServiceCallback
ServiceClientCredentials	Představuje objekt nebo třídu s metodou `signRequest`, která podepíše odchozí požadavky (například nastavením hlavičky `Authorization`).
ServiceClientOptions	Možnosti, které se mají poskytnout při vytváření klienta.
SimpleMapperType	Typ jednoduchého mapovače.
TokenCredential	Představuje přihlašovací údaje schopné poskytnout ověřovací token.
TracingPolicyOptions	Možnosti přizpůsobení zásad trasování
UrlParameterValue	Rozhraní představující hodnotu parametru adresy URL.
UserAgentOptions	Možnosti přidání podrobností o uživatelském agentu do odchozích požadavků
WebResourceLike	Popis požadavku HTTP, který se má provést na vzdálený server.

Aliasy typu

Authenticator	Funkce, která obdrží výzvu a vyřeší příslib pomocí tokenu řetězce.
CommonRequestInfo	Řetězcové adresy URL používané při volání na `fetch()`.
CommonRequestInit	Objekt obsahující informace o odchozím požadavku HTTP.
CommonResponse	Objekt obsahující informace o příchozí odpovědi HTTP.
HttpMethods	Seznam podporovaných metod HTTP
HttpRequestBody	Možné typy textu požadavku HTTP
Mapper	Mapovači jsou definice datových modelů používaných v knihovně. Tyto datové modely jsou součástí definice operace nebo klienta v odpovědích nebo parametrech.
MapperType	Typ mapperu Obsahuje známé mapovače.
ParameterPath	Cesta, která popisuje přístup ke konkrétní vlastnosti v daném zdroji dat objektu. Může to být název jedné vlastnosti, pole, které označuje vnořené názvy vlastností, nebo sadu více pojmenovaných vlastností s cestami v případě složitých hodnot objektu.
ProxyOptions	Alias ProxySettings pro budoucí použití.
RawHttpHeaders	Kolekce HttpHeaders reprezentovaná jako jednoduchý objekt JSON.
RequestPolicyFactory	Vytvoří novou hodnotu RequestPolicy pro požadavek, který používá zadanou zásadu nextPolicy.
TelemetryInfo	Telemetrické informace. Páry klíč/hodnota, které se zahrnou do řetězce User-Agent.
TransferProgressEvent	Aktivovalo se v reakci na průběh nahrávání nebo stahování.

Výčty

HttpPipelineLogLevel	Různé úrovně protokolů, které lze použít s HttpPipelineLogger.
QueryCollectionFormat	Formát, který se použije ke spojení pole hodnot pro hodnotu parametru dotazu.
RetryMode	Popisuje typ režimu opakování. Aktuálně podporuje pouze exponenciální.

Funkce

applyMixins(unknown, any[])	Použije vlastnosti prototypu sourceCtors na prototyp targetCtoru.
bearerTokenAuthenticationPolicy(TokenCredential, string \| string[])	Vytvoří novou továrnu pro RequestPolicy, která použije nosný token na hlavičky `Authorization` požadavků.
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	Vytvoří kanál HTTP na základě daných možností.
delay(number, DelayOptions)	Obálka pro setTimeout, která vyřeší příslib po timeInMs milisekundy.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	Vytvořte novou serializaci RequestPolicyCreator, která bude serializovat těla požadavků HTTP při průchodu kanálem HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	Vzhledem k určité sadě typů obsahu, které se mají analyzovat jako JSON nebo XML, využívá odpověď HTTP k vytvoření výsledného objektu definovaného OperationSpec požadavku.
disableResponseDecompressionPolicy()	Vrátí objekt pro vytváření zásad požadavku, který lze použít k vytvoření instance <xref:DisableResponseDecompressionPolicy>.
encodeUri(string)	Kóduje identifikátor URI.
executePromisesSequentially(any[], unknown)	Provede pole příslibů postupně. Inspiraci této metody je zde: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Úžasný blog o slibech!
exponentialRetryPolicy(number, number, number)	Zásada, která požadavek opakuje tolikrát, kolikrát je nakonfigurovaný po dobu, po kterou je zadaný maximální časový interval opakování, každý opakovaný pokus čeká déle, než je čas posledního.
flattenResponse(HttpOperationResponse, undefined \| OperationResponse)	Parsuje HttpOperationResponse do normalizovaného objektu odpovědi HTTP (RestResponse).
generateClientRequestIdPolicy(string)	Vytvoří zásadu, která přiřadí jedinečné ID požadavku odchozím požadavkům.
generateUuid()	Vygenerované UUID
getDefaultProxySettings(string)	Převede danou adresu URL proxy serveru na `ProxySettings` nebo se pokusí načíst `ProxySettings` z aktuálního prostředí, pokud není předán.
getDefaultUserAgentValue()	Výchozí přístup k vygenerování uživatelských agentů. Používá statické informace z tohoto balíčku a systémové informace dostupné v modulu runtime.
isDuration(string)	Určuje, zda je daný řetězec ve formátu ISO 8601.
isTokenCredential(unknown)	Testuje objekt, aby určil, zda implementuje TokenCredential.
isValidUuid(string)	Ověří zadaný uuid jako řetězec.
keepAlivePolicy(KeepAliveOptions)	Vytvoří zásadu, která řídí, jestli se při budoucích požadavcích udržují připojení HTTP.
logPolicy(LogPolicyOptions)	Vytvoří zásadu, která protokoluje informace o odchozí žádosti a příchozích odpovědích.
operationOptionsToRequestOptionsBase<T>(T)	Převede OperationOptions na RequestOptionsBase.
parseXML(string, SerializerOptions)	Převede daný řetězec XML na JSON.
promiseToCallback(Promise<any>)	Převede příslib na zpětné volání.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Převede příslib na zpětné volání služby.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Zásada, která umožňuje použít nastavení proxy serveru pro všechny požadavky. Pokud se nepředá statické nastavení, načtou se z HTTPS_PROXY nebo HTTP_PROXY proměnných prostředí.
redirectPolicy(number)	Vytvoří zásadu přesměrování, která odešle požadavek zopakováním požadavku do nového cíle, pokud odpověď přijde s hlavičkou umístění a stavovým kódem mezi 300 a 307.
serializeObject(unknown)	Utility funkce, která serializuje objekt, který může obsahovat binární informace do prostého objektu, pole nebo řetězce.
signingPolicy(ServiceClientCredentials)	Vytvoří zásadu, která podepisuje odchozí požadavky voláním metody `authenticationProvider` zadaného `signRequest`.
stringifyXML(unknown, SerializerOptions)	Převede daný objekt JSON na řetězec XML.
stripRequest(WebResourceLike)	Vrátí proříznutou verzi požadavku HTTP, která neobsahuje autorizační hlavičku.
stripResponse(HttpOperationResponse)	Vrátí proříznutou verzi odpovědi HTTP, která obsahuje pouze tělo, hlavičky a stav.
systemErrorRetryPolicy(number, number, number, number)	Zásada, která opakuje, když dojde k systémové chybě identifikované kódy "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" nebo "ENOENT".
throttlingRetryPolicy()	Vytvoří zásadu, která požadavek znovu odešle, pokud odpověď značí, že požadavek selhal z důvodu omezování. Pokud například odpověď obsahuje hlavičku `Retry-After`, zkusí požadavek odeslat znovu na základě hodnoty této hlavičky. Další informace najdete v tématu 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 a https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tracingPolicy(TracingPolicyOptions)	Vytvoří zásadu, která zabalí odchozí požadavky s rozsahem trasování.
userAgentPolicy(TelemetryInfo)	Vrátí zásadu, která přidá hlavičku uživatelského agenta do odchozích požadavků na základě dané TelemetryInfo.

Podrobnosti funkce

applyMixins(unknown, any[])

Použije vlastnosti prototypu sourceCtors na prototyp targetCtoru.

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

Parametry

targetCtorParam: unknown

sourceCtors: any[]

Pole zdrojovýchobjektůch

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Vytvoří novou továrnu pro RequestPolicy, která použije nosný token na hlavičky Authorization požadavků.

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

Parametry

credential: TokenCredential

Implementace TokenCredential, která může poskytnout nosný token.

scopes: string | string[]

Obory, pro které se vztahuje nosný token.

Návraty

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Vytvoří kanál HTTP na základě daných možností.

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

Parametry

pipelineOptions: InternalPipelineOptions

Definuje možnosti, které se používají ke konfiguraci zásad v kanálu HTTP pro klienta sady SDK.

authPolicyFactory: RequestPolicyFactory

Volitelná továrna zásad ověřování, která se má použít k podepisování požadavků.

Návraty

ServiceClientOptions

Sada možností, které lze předat k vytvoření nové ServiceClient.

delay(number, DelayOptions)

Obálka pro setTimeout, která vyřeší příslib po timeInMs milisekundy.

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

Parametry

timeInMs: number

Počet milisekund, které mají být zpožděny.

options: DelayOptions

Možnosti zpoždění – aktuálně přerušené možnosti

Návraty

Promise<void>

Příslib, který se vyřeší po vypršení časových intervalů

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Vytvořte novou serializaci RequestPolicyCreator, která bude serializovat těla požadavků HTTP při průchodu kanálem HTTP.

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

Parametry

deserializationContentTypes: DeserializationContentTypes

parsingOptions: SerializerOptions

Návraty

RequestPolicyFactory

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

Vzhledem k určité sadě typů obsahu, které se mají analyzovat jako JSON nebo XML, využívá odpověď HTTP k vytvoření výsledného objektu definovaného OperationSpec požadavku.

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

Parametry

jsonContentTypes: string[]

Typy obsahu odpovědi pro parsování textu ve formátu JSON

xmlContentTypes: string[]

Typy obsahu odpovědi, které analyzují tělo jako XML.

response: HttpOperationResponse

Odpověď HTTP z kanálu.

options: SerializerOptions

Možnosti serializátoru, většinou pro konfiguraci analyzátoru XML v případě potřeby.

Návraty

Promise<HttpOperationResponse>

Parsovaný HttpOperationResponse objekt, který může vrátit ServiceClient.

disableResponseDecompressionPolicy()

Vrátí objekt pro vytváření zásad požadavku, který lze použít k vytvoření instance <xref:DisableResponseDecompressionPolicy>.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

Návraty

RequestPolicyFactory

encodeUri(string)

Kóduje identifikátor URI.

function encodeUri(uri: string): string

Parametry

uri: string

Identifikátor URI, který se má zakódovat.

Návraty

string

Kódovaný identifikátor URI.

executePromisesSequentially(any[], unknown)

Provede pole příslibů postupně. Inspiraci této metody je zde: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Úžasný blog o slibech!

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

Parametry

promiseFactories: any[]

Pole slíbených továren(funkce A, která vrací příslib)

kickstart: unknown

Vstup do prvního příslibu, který se používá k zahájení řetězce příslibů. Pokud není k dispozici, řetězec příslibu začíná nedefinovaným.

Návraty

Promise<any>

Řetězec vyřešených nebo odmítnutých slibů

exponentialRetryPolicy(number, number, number)

Zásada, která požadavek opakuje tolikrát, kolikrát je nakonfigurovaný po dobu, po kterou je zadaný maximální časový interval opakování, každý opakovaný pokus čeká déle, než je čas posledního.

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

Parametry

retryCount: number

Maximální počet opakování.

retryInterval: number

Základní čas mezi opakovanými pokusy.

maxRetryInterval: number

Maximální doba čekání mezi opakovanými pokusy

Návraty

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Parsuje HttpOperationResponse do normalizovaného objektu odpovědi HTTP (RestResponse).

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

Parametry

_response: HttpOperationResponse

Objekt obálky pro odpověď HTTP.

responseSpec: undefined | OperationResponse

Mapovače pro parsování vlastností odpovědi

Návraty

RestResponse

Normalizovaný objekt odpovědi.

generateClientRequestIdPolicy(string)

Vytvoří zásadu, která přiřadí jedinečné ID požadavku odchozím požadavkům.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parametry

requestIdHeaderName: string

Název hlavičky, která se má použít při přiřazování jedinečného ID požadavku.

Návraty

RequestPolicyFactory

generateUuid()

Vygenerované UUID

function generateUuid(): string

Návraty

string

RFC4122 UUID v4.

getDefaultProxySettings(string)

Převede danou adresu URL proxy serveru na ProxySettings nebo se pokusí načíst ProxySettings z aktuálního prostředí, pokud není předán.

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

Parametry

proxyUrl: string

Adresa URL proxy serveru

Návraty

ProxySettings | undefined

Výchozí nastavení proxy serveru nebo nedefinované.

getDefaultUserAgentValue()

Výchozí přístup k vygenerování uživatelských agentů. Používá statické informace z tohoto balíčku a systémové informace dostupné v modulu runtime.

function getDefaultUserAgentValue(): string

Návraty

string

isDuration(string)

Určuje, zda je daný řetězec ve formátu ISO 8601.

function isDuration(value: string): boolean

Parametry

value: string

Hodnota, která má být ověřena pro formát doby trvání ISO 8601.

Návraty

boolean

true, pokud jsou platné, false jinak.

isTokenCredential(unknown)

Testuje objekt, aby určil, zda implementuje TokenCredential.

function isTokenCredential(credential: unknown): credential

Parametry

credential: unknown

Předpokládá se, že tokenCredential se má testovat.

Návraty

credential

isValidUuid(string)

Ověří zadaný uuid jako řetězec.

function isValidUuid(uuid: string): boolean

Parametry

uuid: string

Uuid jako řetězec, který je potřeba ověřit

Návraty

boolean

True, pokud je uuid platný; jinak nepravda.

keepAlivePolicy(KeepAliveOptions)

Vytvoří zásadu, která řídí, jestli se při budoucích požadavcích udržují připojení HTTP.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Parametry

keepAliveOptions: KeepAliveOptions

Udržujte možnosti naživu. Ve výchozím nastavení se připojení HTTP udržují pro budoucí požadavky.

Návraty

RequestPolicyFactory

Instance <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

Vytvoří zásadu, která protokoluje informace o odchozí žádosti a příchozích odpovědích.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

Parametry

loggingOptions: LogPolicyOptions

Možnosti protokolování

Návraty

RequestPolicyFactory

Instance <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

Převede OperationOptions na RequestOptionsBase.

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

Parametry

opts: T

OperationOptions – objekt pro převod na RequestOptionsBase

Návraty

RequestOptionsBase

parseXML(string, SerializerOptions)

Převede daný řetězec XML na JSON.

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

Parametry

str: string

Řetězec obsahující obsah XML, který se má analyzovat do formátu JSON

opts: SerializerOptions

Možnosti, které řídí analýzu daného řetězce XML

Návraty

Promise<any>

promiseToCallback(Promise<any>)

Upozornění

Toto rozhraní API je teď zastaralé.

generated code should instead depend on responseToBody

Převede příslib na zpětné volání.

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

Parametry

promise: Promise<any>

Příslib, který se má převést na zpětné volání

Návraty

(cb: Function) => void

Funkce, která přebírá zpětné volání (cb: Function) => void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Převede příslib na zpětné volání služby.

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

Parametry

promise: Promise<HttpOperationResponse>

Příslib HttpOperationResponse, který se má převést na zpětné volání služby

Návraty

(cb: ServiceCallback<T>) => void

Funkce, která přebírá zpětné volání služby (cb: ServiceCallback<T>): void

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

Zásada, která umožňuje použít nastavení proxy serveru pro všechny požadavky. Pokud se nepředá statické nastavení, načtou se z HTTPS_PROXY nebo HTTP_PROXY proměnných prostředí.

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

Parametry

proxySettings: ProxySettings

ProxySettings, které se mají použít pro každý požadavek.

options: { customNoProxyList?: string[] }

další nastavení, například vlastní vzory NO_PROXY

Návraty

RequestPolicyFactory

redirectPolicy(number)

Vytvoří zásadu přesměrování, která odešle požadavek zopakováním požadavku do nového cíle, pokud odpověď přijde s hlavičkou umístění a stavovým kódem mezi 300 a 307.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parametry

maximumRetries: number

Maximální počet přesměrování, které se mají sledovat.

Návraty

RequestPolicyFactory

Instance <xref:RedirectPolicy>

serializeObject(unknown)

Utility funkce, která serializuje objekt, který může obsahovat binární informace do prostého objektu, pole nebo řetězce.

function serializeObject(toSerialize: unknown): any

Parametry

toSerialize: unknown

Návraty

any

signingPolicy(ServiceClientCredentials)

Vytvoří zásadu, která podepisuje odchozí požadavky voláním metody authenticationProvider zadaného signRequest.

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parametry

authenticationProvider: ServiceClientCredentials

Zprostředkovatel ověřování.

Návraty

RequestPolicyFactory

Instance <xref:SigningPolicy>.

stringifyXML(unknown, SerializerOptions)

Převede daný objekt JSON na řetězec XML.

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

Parametry

obj: unknown

Objekt JSON, který se má převést na řetězec XML

opts: SerializerOptions

Možnosti, které řídí analýzu daného objektu JSON

Návraty

string

stripRequest(WebResourceLike)

Vrátí proříznutou verzi požadavku HTTP, která neobsahuje autorizační hlavičku.

function stripRequest(request: WebResourceLike): WebResourceLike

Parametry

request: WebResourceLike

Objekt Požadavku HTTP

Návraty

WebResourceLike

Proříznutá verze požadavku HTTP.

stripResponse(HttpOperationResponse)

Vrátí proříznutou verzi odpovědi HTTP, která obsahuje pouze tělo, hlavičky a stav.

function stripResponse(response: HttpOperationResponse): any

Parametry

response: HttpOperationResponse

Odpověď HTTP

Návraty

any

Oříznutá verze odpovědi HTTP.

systemErrorRetryPolicy(number, number, number, number)

Zásada, která opakuje, když dojde k systémové chybě identifikované kódy "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" nebo "ENOENT".

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

Parametry

retryCount: number

Maximální počet opakování.

retryInterval: number

Interval opakování klienta v milisekundách.

minRetryInterval: number

Minimální interval opakování v milisekundách.

maxRetryInterval: number

Maximální interval opakování v milisekundách.

Návraty

RequestPolicyFactory

Instance <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

Vytvoří zásadu, která požadavek znovu odešle, pokud odpověď značí, že požadavek selhal z důvodu omezování. Pokud například odpověď obsahuje hlavičku Retry-After, zkusí požadavek odeslat znovu na základě hodnoty této hlavičky.

Další informace najdete v tématu 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 a https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): RequestPolicyFactory

Návraty

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

Vytvoří zásadu, která zabalí odchozí požadavky s rozsahem trasování.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

Parametry

tracingOptions: TracingPolicyOptions

Možnosti trasování

Návraty

RequestPolicyFactory

Instance třídy <xref:TracingPolicy>.

userAgentPolicy(TelemetryInfo)

Vrátí zásadu, která přidá hlavičku uživatelského agenta do odchozích požadavků na základě dané TelemetryInfo.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parametry

userAgentData: TelemetryInfo

Telemetrické informace.

Návraty

RequestPolicyFactory

Nový <xref:UserAgentPolicy>.

Sdílet prostřednictvím

@azure/core-http package

Třídy

Rozhraní

Aliasy typu

Výčty

Funkce

Podrobnosti funkce

applyMixins(unknown, any[])

Parametry

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Parametry

Návraty

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Parametry

Návraty

delay(number, DelayOptions)

Parametry

Návraty

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Parametry

Návraty

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

Parametry

Návraty

disableResponseDecompressionPolicy()

Návraty

encodeUri(string)

Parametry

Návraty

executePromisesSequentially(any[], unknown)

Parametry

Návraty

exponentialRetryPolicy(number, number, number)

Parametry

Návraty

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Parametry

Návraty

generateClientRequestIdPolicy(string)

Parametry

Návraty

generateUuid()

Návraty

getDefaultProxySettings(string)

Parametry

Návraty

getDefaultUserAgentValue()

Návraty

isDuration(string)

Parametry

Návraty

isTokenCredential(unknown)

Parametry

Návraty

isValidUuid(string)

Parametry

Návraty

keepAlivePolicy(KeepAliveOptions)

Parametry

Návraty

logPolicy(LogPolicyOptions)

Parametry

Návraty

operationOptionsToRequestOptionsBase<T>(T)

Parametry

Návraty

parseXML(string, SerializerOptions)

Parametry

Návraty

promiseToCallback(Promise<any>)

Parametry

Návraty

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Parametry

Návraty

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

Parametry

Návraty

redirectPolicy(number)