@azure/core-http package

Třídy

AccessTokenRefresher	Pomáhá zásadám ověřování pomocí tokenu HTTP jádra vyžádat nový token, pokud v současné době 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 implementace, která vymaže accesstokeny uložené v mezipaměti po vypršení platnosti expiresOnTimestamp.
HttpHeaders	Kolekce párů klíč/hodnota hlavičky HTTP.
RequestPolicyOptions	Volitelné vlastnosti, které lze použít při vytváření Zásady požadavku.
RestError	Chyba vyplývající z požadavku HTTP na koncový bod služby.
Serializer	Slouží k mapování objektů nezpracovaných odpovědí na konečné obrazce. Pomáhá balit a rozbalovat data a další zakódované typy, které nejsou ve formátu JSON vnitřní. 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žbu a přijímá odpovědi.
TopicCredentials	Objekt TopicCredentials použitý pro Azure Event Grid.
URLBuilder	Třída, která se stará o 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 nezávislá na knihovně nebo implementaci a zabalení potřebných vlastností k zahájení požadavku.

Rozhraní

AbortSignalLike	Umožňuje přerušit požadavek při aktivaci události "přerušení". Kompatibilní s integrovaným prohlížečem AbortSignal a běžnými polyfills.
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í zadat při vytváření instance ApiKeyCredentials.
BaseMapper	Základní definice mapovače. Lze použít pro objekty XML a prosté javascriptové objekty.
CompositeMapper	Mapovač složený z jiných mapovačů
CompositeMapperType	Pomáhá vytvořit mapovač, který popisuje, jak mapovat sadu vlastností objektu na základě jiných mapovačů. Měly by existovat pouze některé z následujících vlastností: className, modelProperties a additionalProperties.
DeserializationContentTypes	Typy obsahu, které budou indikovat, že odpověď na operaci by měla být deserializována určitým způsobem.
DeserializationOptions	Možnosti konfigurace deserializace odpovědí rozhraní API
DictionaryMapper	Mapovač 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	Mapovač 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 rámci HttpHeaders kolekce.
HttpHeadersLike	Kolekce párů klíč/hodnota hlavičky HTTP.
HttpOperationResponse	Objekt Wrapper pro požadavek HTTP a odpověď. Deserializovaný objekt je uložen ve vlastnosti při parsedBody přijetí textu odpovědi ve formátu JSON nebo XML.
HttpPipelineLogger	Protokolovací nástroje, které lze přidat do HttpPipeline. To umožňuje každé službě RequestPolicy protokolovat zprávy, které lze použít pro účely ladění.
HttpResponse	Vlastnosti odpovědi HTTP, která bude vždy k dispozici.
InternalPipelineOptions	Definuje možnosti, které se používají ke konfiguraci interních možností kanálu HTTP pro klienta sady SDK.
KeepAliveOptions	Možnosti, jak by se měla udržovat připojení HTTP pro budoucí požadavky.
LogPolicyOptions	Možnosti, které se mají předat do logPolicy. Ve výchozím nastavení se protokoluje pouze seznam sad hlaviček, i když to lze nakonfigurovat. Těla požadavků a odpovědí se nikdy nezaprotokolují.
MapperConstraints	Popis různých omezení hodnot, jako jsou například celočíselné rozsahy a řetězec regex.
OperationArguments	Kolekce vlastností, které platí pro jedno vyvolání operace.
OperationOptions	Typ základních 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í konfigurovat zpracování požadavků HTTP provedených operací sady SDK.
OperationResponse	OperaceResponse, která může být vrácena z požadavku operace pro jeden stavový kód.
OperationSpec	Specifikace, která definuje, jak provést konkrétní operaci služby přes HTTP, včetně toho, jak správně serializovat informace o požadavcích do a deserializovat informace odpovědi do datové části objektu, kterou může vrátit ServiceClient.
OperationURLParameter	Parametr pro operaci, který bude nahrazen adresou URL požadavku operace.
ParameterValue	Hodnota parametru zadaná pro parametry cesty nebo dotazu v části 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 například odpověď může mít mnoho obrazců, ale obsahuje také pole typu (nebo podobné), lze toto pole použít k určení, jak deserializovat odpověď na správný typ.
ProxySettings	Možnosti konfigurace proxy pro odchozí požadavky (pouze Node.js)
RedirectOptions	Možnosti zpracování odpovědí přesměrování
RequestOptionsBase	Popisuje základní strukturu objektu options, který se použije v každé operaci.
RequestPolicy	Základní struktura zásad požadavků.
RequestPolicyOptionsLike	Volitelné vlastnosti, které lze použít při vytváření Zásady požadavku.
RequestPrepareOptions	Možnosti přípravy odchozího požadavku HTTP
RestResponse	Zploštělé odpovědi na volání REST. Obsahuje základní httpOperationResponse a sloučené parsedBodyvlastnosti , parsedHeadersatd.
RetryOptions	Možnosti, které určují, jak opakovat neúspěšné žádosti.
SequenceMapper	Mapovač popisující pole
SequenceMapperType	Pomáhá vytvořit mapovač, který popisuje, jak parsovat posloupnost mapovaných hodnot.
SerializerOptions	Možnosti pro řízení chování analyzátoru xml a tvůrce
ServiceCallback
ServiceClientCredentials	Představuje objekt nebo třídu pomocí signRequest metody, 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 pro přidání podrobností o uživatelském agentu k odchozím požadavkům
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	Adresy URL řetězců používané při volání metody 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če jsou definice datových modelů používaných v knihovně. Tyto datové modely jsou součástí definic operace nebo klienta v odpovědích nebo parametrech.
MapperType	Typ mapovače. Zahrnuje známé mapovače.
ParameterPath	Cesta, která popisuje, jak získat přístup ke konkrétní vlastnosti v daném zdroji dat objektu. Může to být jeden název vlastnosti, pole, které označuje názvy vnořených vlastností nebo sadu více pojmenovaných vlastností s cestami v případě komplexních hodnot objektů.
ProxyOptions	Alias ProxySettings pro budoucí použití.
RawHttpHeaders	Kolekce HttpHeaders reprezentovaná jako jednoduchý objekt JSON.
RequestPolicyFactory	Vytvoří novou zásadu RequestPolicy pro každou žádost, která používá zadanou zásadu nextPolicy.
TelemetryInfo	Informace o telemetrii. Páry klíč/hodnota, které se mají zahrnout do řetězce User-Agent.
TransferProgressEvent	Aktivované 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í. V současné době 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 požadavků Authorization .
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 milisekundách.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	Vytvořte novou serializaci RequestPolicyCreator, která bude serializovat těla požadavků HTTP, jak procházejí 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í objektu výsledku definovaného operationSpec požadavku.
disableResponseDecompressionPolicy()	Vrátí objekt pro vytváření zásad požadavků, který lze použít k vytvoření instance objektu <xref:DisableResponseDecompressionPolicy>.
encodeUri(string)	Kóduje identifikátor URI.
executePromisesSequentially(any[], unknown)	Provede postupně pole slibů. Inspirace touto metodou 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á, a to tak dlouho, dokud je zadaný maximální časový interval opakování, přičemž každé opakování bude čekat déle, než začne naposledy.
flattenResponse(HttpOperationResponse, undefined | OperationResponse)	Analyzuje httpOperationResponse do normalizovaného objektu odpovědi HTTP (RestResponse).
generateClientRequestIdPolicy(string)	Vytvoří zásadu, která odchozím požadavkům přiřadí jedinečné ID požadavku.
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ána.
getDefaultUserAgentValue()	Výchozí přístup ke generování uživatelských agentů. Používá statické informace z tohoto balíčku a systémové informace dostupné z modulu runtime.
isDuration(string)	Určuje, jestli je daný řetězec ve formátu ISO 8601.
isTokenCredential(unknown)	Testuje objekt k určení, zda implementuje TokenCredential.
isValidUuid(string)	Ověří zadaný uuid jako řetězec.
keepAlivePolicy(KeepAliveOptions)	Vytvoří zásadu, která řídí, jestli se u budoucích požadavků budou udržovat připojení HTTP.
logPolicy(LogPolicyOptions)	Vytvoří zásadu, která protokoluje informace o odchozím požadavku a příchozích odpovědích.
operationOptionsToRequestOptionsBase<T>(T)	Převede operaciOptions na RequestOptionsBase.
parseXML(string, SerializerOptions)	Převede zadaný ř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 do nového cíle, pokud odpověď dorazí s hlavičkou "location" a stavovým kódem mezi 300 a 307.
serializeObject(unknown)	Funkce nástroje, která serializuje objekt, který může obsahovat binární informace, do prostého objektu, pole nebo řetězce.
signingPolicy(ServiceClientCredentials)	Vytvoří zásadu, která podepíše odchozí požadavky voláním zadané authenticationProvidersignRequest metody .
stringifyXML(unknown, SerializerOptions)	Převede daný objekt JSON na řetězec XML.
stripRequest(WebResourceLike)	Vrátí odstraněnou verzi požadavku HTTP, která neobsahuje autorizační hlavičku.
stripResponse(HttpOperationResponse)	Vrátí odstraněnou verzi odpovědi HTTP, která obsahuje pouze tělo, hlavičky a stav.
systemErrorRetryPolicy(number, number, number, number)	Zásada, která se 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ůvodů omezování. Pokud například odpověď obsahuje hlavičku Retry-After , zkusí odeslat požadavek 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-limitsa https://docs.microsoft.com/en-us/azure/azure-subscription-service-limitshttps://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é telemetrieInfo.

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ých objektů, ze kterých je třeba převést vlastnosti.

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

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

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

Parametry

credential

TokenCredential

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

scopes

string | string[]

Obory, pro které platí 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 pro zásady ověřování, která se má použít pro podepisování žádostí.

Návraty

ServiceClientOptions

Sada možností, které lze předat k vytvoření nového Klienta služby.

delay(number, DelayOptions)

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

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

Parametry

timeInMs

number

Počet milisekund, které se mají zpozdit.

options

DelayOptions

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

Návraty

Promise<void>

Příslib, který se vyřeší po uplynutí časového limitu

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Vytvořte novou serializaci RequestPolicyCreator, která bude serializovat těla požadavků HTTP, jak procházejí 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í objektu výsledku definovaného operationSpec požadavku.

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

Parametry

jsonContentTypes

string[]

Typy obsahu odpovědi parsují tělo jako JSON.

xmlContentTypes

string[]

Typy obsahu odpovědi parsují 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 být vrácen ServiceClient.

disableResponseDecompressionPolicy()

Vrátí objekt pro vytváření zásad požadavků, který lze použít k vytvoření instance objektu <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 postupně pole slibů. Inspirace touto metodou 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 objektů pro vytváření slibů (funkce, která vrací příslib)

kickstart

unknown

Vstup do prvního slibu, který slouží k nastartu řetězu příslibů. Pokud není zadaný, řetězec příslibů začíná nedefinovaným.

Návraty

Promise<any>

Řetěz 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á, a to tak dlouho, dokud je zadaný maximální časový interval opakování, přičemž každé opakování bude čekat déle, než začne naposledy.

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

Parametry

retryCount

number

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

retryInterval

number

Základní čas mezi opakováními.

maxRetryInterval

number

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

Návraty

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Analyzuje httpOperationResponse do normalizovaného objektu odpovědi HTTP (RestResponse).

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

Parametry

_response

HttpOperationResponse

Objekt Wrapper pro odpověď HTTP.

responseSpec

undefined | OperationResponse

Mapovači pro analýzu vlastností odpovědi.

Návraty

RestResponse

• Normalizovaný objekt odpovědi.

generateClientRequestIdPolicy(string)

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

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 v4 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ána.

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

Parametry

proxyUrl

string

Adresa URL proxy serveru

Návraty

ProxySettings | undefined

Výchozí nastavení proxy serveru nebo nedefinováno.

getDefaultUserAgentValue()

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

function getDefaultUserAgentValue(): string

Návraty

string

isDuration(string)

Určuje, jestli 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 je platný, false v opačném případě.

isTokenCredential(unknown)

Testuje objekt k určení, zda implementuje TokenCredential.

function isTokenCredential(credential: unknown): credential

Parametry

credential

unknown

Předpokládá se, že tokenCredential bude testován.

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ý; v opačném případě false.

keepAlivePolicy(KeepAliveOptions)

Vytvoří zásadu, která řídí, jestli se u budoucích požadavků budou udržovat připojení HTTP.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Parametry

keepAliveOptions

KeepAliveOptions

Zachovat možnosti. Ve výchozím nastavení se připojení HTTP uchovávají pro budoucí požadavky.

Návraty

RequestPolicyFactory

Instance <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

Vytvoří zásadu, která protokoluje informace o odchozím požadavku 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 operaciOptions na RequestOptionsBase.

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

Parametry

opts

T

Objekt OperationOptions pro převod na RequestOptionsBase

Návraty

RequestOptionsBase

parseXML(string, SerializerOptions)

Převede zadaný ř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í parsování 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>

The Promise of HttpOperationResponse to be converted to a service callback

Návraty

(cb: ServiceCallback<T>) => void

Funkce, která přebírá zpětné volání služby (cb: ServiceCallback): 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 u každého požadavku.

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 do nového cíle, pokud odpověď dorazí s hlavičkou "location" 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)

Funkce nástroje, 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á podepíše odchozí požadavky voláním zadané authenticationProvidersignRequest metody .

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parametry

authenticationProvider

ServiceClientCredentials

Zprostředkovatel ověřování.

Návraty

RequestPolicyFactory

Instance typu <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í parsování daného objektu JSON

Návraty

string

stripRequest(WebResourceLike)

Vrátí odstraněnou 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

Odstraněná verze požadavku HTTP.

stripResponse(HttpOperationResponse)

Vrátí odstraněnou 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

Odstraněná verze odpovědi HTTP.

systemErrorRetryPolicy(number, number, number, number)

Zásada, která se 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ůvodů omezování. Pokud například odpověď obsahuje hlavičku Retry-After , zkusí odeslat požadavek 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-limitsa https://docs.microsoft.com/en-us/azure/azure-subscription-service-limitshttps://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é telemetrieInfo.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parametry

userAgentData

TelemetryInfo

Informace o telemetrii.

Návraty

RequestPolicyFactory

Nový <xref:UserAgentPolicy>.