@azure/core-http package

Előkelő társaság

AccessTokenRefresher	Segít az alapvető HTTP-jogkivonat-hitelesítési szabályzatoknak új jogkivonat kérésében, ha jelenleg nem várunk új jogkivonatra.
ApiKeyCredentials	API-kulccsal hitelesít egy szolgáltatásban.
BaseRequestPolicy	Az az alaposztály, amelyből az összes kérelemszabályzat származik.
BasicAuthenticationCredentials	Egyszerű <xref:ServiceClientCredential>, amely felhasználónévvel és jelszóval hitelesít.
DefaultHttpClient	`node-fetch`használó HTTP-ügyfél.
ExpiringAccessTokenCache	AccessTokenCache implementációt biztosít, amely törli a gyorsítótárazott AccessTokena lejárat után.
HttpHeaders	HTTP-fejléckulcs/érték párok gyűjteménye.
RequestPolicyOptions	Nem kötelező tulajdonságok, amelyek a RequestPolicy létrehozásakor használhatók.
RestError	Egy szolgáltatásvégpontra irányuló HTTP-kérésből eredő hiba.
Serializer	Nyers válaszobjektumok végleges alakzatokra való leképezésére szolgál. Segít a dátumok és más kódolt típusok csomagolásában és kicsomagolásában, amelyek nem kapcsolódnak a JSON-hoz. Emellett lehetővé teszi az értékek lekérését a fejlécekből, valamint az alapértelmezett értékek és állandók beszúrását.
ServiceClient	A ServiceClient szolgáltatáskéréseket küld, és válaszokat fogad.
TopicCredentials	Az Azure Event Gridhez használt TopicCredentials objektum.
URLBuilder	Az URL-címek létrehozását, módosítását és elemzését kezelő osztály.
URLQuery	Egy URLBuilder lekérdezési részét kezelő osztály.
WebResource	Létrehoz egy új WebResource-objektumot. Ez az osztály absztrakciót biztosít egy REST-híváshoz, mivel kódtár/implementáció agnosztikus, és a kérés indításához szükséges tulajdonságokat burkolja.

Felületek

AbortSignalLike	Lehetővé teszi a kérés megszakítását az "abort" esemény aktiválásakor. Kompatibilis a böngésző beépített AbortSignal és a gyakori polifillek.
AccessToken	Lejárati idővel rendelkező hozzáférési jogkivonatot jelöl.
AccessTokenCache	Gyorsítótárat biztosít egy Olyan AccessTokenhez, amelyet tokenCredentialból ad vissza.
ApiKeyCredentialOptions	Az ApiKeyCredentials-példány létrehozásakor nyújtandó beállítások ismertetése
BaseMapper	A leképező alapdefiníciója. XML- és egyszerű JavaScript-objektumokhoz használható.
CompositeMapper	Más térképezőkből álló térképelő.
CompositeMapperType	Segít létrehozni egy leképezőt, amely leírja, hogyan képezhet le egy objektum tulajdonságainak készletét más leképezők alapján. Csak az alábbi tulajdonságok egyikének kell szerepelnie: `className`, `modelProperties` és `additionalProperties`.
DeserializationContentTypes	Azok a tartalomtípusok, amelyek azt jelzik, hogy a műveleti válaszokat bizonyos módon deszerializálni kell.
DeserializationOptions	Az API-válasz deszerializálásának konfigurálásának lehetőségei.
DictionaryMapper	Kulcs/érték párként használt egyszerű JavaScript-objektumokat leíró leképező.
DictionaryMapperType	Segít létrehozni egy térképelőt, amely leírja, hogyan elemezhet egy megfeleltetett értékeket tartalmazó szótárat.
EnumMapper	Egy enumerálási értéket leíró leképező.
EnumMapperType	Segít összeállítani egy olyan leképezőt, amely leírja, hogyan elemezhet egy enumerálási értéket.
GetTokenOptions	Meghatározza a TokenCredential.getToken beállításait.
HttpClient	Egy felület, amely httpRequests-t küldhet, és fogadhatja az ígért HttpResponses-t.
HttpHeader	Egyéni fejléc egy HttpHeaders-gyűjteményben.
HttpHeadersLike	HTTP-fejléckulcs/érték párok gyűjteménye.
HttpOperationResponse	Burkolóobjektum http-kéréshez és válaszhoz. A deszerializált objektum a `parsedBody` tulajdonságban lesz tárolva, amikor a válasz törzse JSON-ban vagy XML-ben érkezik.
HttpPipelineLogger	HttpPipeline-hoz hozzáadható naplózó. Ez lehetővé teszi, hogy minden RequestPolicy naplózza azokat az üzeneteket, amelyek hibakeresési célokra használhatók.
HttpResponse	A HTTP-válasz tulajdonságai, amelyek mindig jelen lesznek.
InternalPipelineOptions	Az SDK-ügyfél HTTP-folyamatának belső beállításainak konfigurálásához használt beállításokat határozza meg.
KeepAliveOptions	A HTTP-kapcsolatok későbbi kérésekhez való fenntartásának lehetőségei.
LogPolicyOptions	A logPolicy továbbítandó beállítások. Alapértelmezés szerint csak a fejlécek készletlistája van naplózva, de ez konfigurálható. A kérés- és választestek soha nem lesznek naplózva.
MapperConstraints	A különböző értékkorlátozások, például az egész számtartományok és a sztringregex leírása.
OperationArguments	Olyan tulajdonságok gyűjteménye, amelyek egy művelet egyetlen meghívására vonatkoznak.
OperationOptions	Az alapbeállítások típusa az összes művelethez.
OperationParameter	Egy közös felület, amelyet az összes műveleti paraméter kiterjeszt.
OperationQueryParameter	Egy művelet paramétere, amely lekérdezési paraméterként lesz hozzáadva a művelet HTTP-kéréséhez.
OperationRequestOptions	Az SDK-művelet által küldött HTTP-kérések kezelésének konfigurálását lehetővé tevő beállítások.
OperationResponse	OperationResponse, amely egyetlen állapotkód műveleti kéréséből adható vissza.
OperationSpec	Egy specifikáció, amely meghatározza, hogyan hajthat végre egy adott szolgáltatásműveletet HTTP-en keresztül, beleértve a kérésadatok megfelelő szerializálását és a válaszinformációk deszerializálását a ServiceClientáltal visszaadott objektum hasznos adatává.
OperationURLParameter	Egy művelet paramétere, amely a művelet kérési URL-címére lesz helyettesítve.
ParameterValue	A RequestPrepareOptions elérési út- vagy lekérdezésparamétereihez megadott paraméterérték
PipelineOptions	Meghatározza az SDK-ügyfél HTTP-folyamatának konfigurálásához használt beállításokat.
PolymorphicDiscriminator	A diszkriminált típusú szakszervezetek egyértelműsítésére szolgál. Ha például a válasz számos alakzatot tartalmazhat, de tartalmaz egy "kind" mezőt (vagy hasonlót), akkor ez a mező határozza meg, hogyan lehet deszerializálni a választ a megfelelő típusra.
ProxySettings	A kimenő kérelmek proxyjának konfigurálására szolgáló beállítások (csakNode.js).
RedirectOptions	Az átirányítási válaszok kezelésének beállításai.
RequestOptionsBase	Az összes műveletben használt beállításobjektum alapstruktúráját ismerteti.
RequestPolicy	A kérelemházirend mögöttes struktúrája.
RequestPolicyOptionsLike	Nem kötelező tulajdonságok, amelyek a RequestPolicy létrehozásakor használhatók.
RequestPrepareOptions	A kimenő HTTP-kérések előkészítésének lehetőségei.
RestResponse	A REST-hívásra adott összesimított válasz. Tartalmazza a httpOperationResponse mögöttes, valamint a `parsedBody`egyesített tulajdonságait, `parsedHeaders`stb.
RetryOptions	A sikertelen kérések újrapróbálkozására vonatkozó beállítások.
SequenceMapper	Tömböket leíró térkép.
SequenceMapperType	Segít létrehozni egy térképelőt, amely leírja, hogyan elemezhet egy leképezett értékek sorozatát.
SerializerOptions	Az xml-elemző és -szerkesztő viselkedésének szabályozására vonatkozó beállítások.
ServiceCallback
ServiceClientCredentials	Olyan objektumot vagy osztályt jelöl `signRequest` metódussal, amely aláírja a kimenő kéréseket (például a `Authorization` fejléc beállításával).
ServiceClientOptions	Az ügyfél létrehozásakor meg kell adni a beállításokat.
SimpleMapperType	Az egyszerű leképező típusa.
TokenCredential	Hitelesítési jogkivonat megadására alkalmas hitelesítő adatokat jelöl.
TracingPolicyOptions	A nyomkövetési szabályzat testreszabásának beállításai.
UrlParameterValue	EGY URL-paraméter értékét képviselő felület.
UserAgentOptions	A felhasználói ügynök adatainak a kimenő kérelmekhez való hozzáadásának lehetőségei.
WebResourceLike	A távoli kiszolgálóra irányuló HTTP-kérés leírása.

Típus-aliasok

Authenticator	Olyan függvény, amely kihívást kap, és sztring jogkivonattal old meg egy ígéretet.
CommonRequestInfo	A `fetch()`hívásához használt sztring URL-címek.
CommonRequestInit	A kimenő HTTP-kéréssel kapcsolatos információkat tartalmazó objektum.
CommonResponse	Egy objektum, amely információkat tartalmaz a bejövő HTTP-válaszról.
HttpMethods	A támogatott HTTP-metódusok listája.
HttpRequestBody	Lehetséges HTTP-kérés törzstípusai
Mapper	A leképezők a kódtárban használt adatmodellek definíciói. Ezek az adatmodellek a válaszokban vagy paraméterekben szereplő művelet- vagy ügyféldefiníciók részét képezik.
ParameterPath	Egy elérési út, amely leírja, hogyan lehet elérni egy adott tulajdonságot egy adott objektum adatforrásában. Lehet egy tulajdonságnév, egy tömb, amely beágyazott tulajdonságneveket jelöl, vagy összetett objektumértékek esetén több elnevezett tulajdonság halmaza elérési úttal.
ProxyOptions	A ProxySettings aliasa későbbi használatra.
RawHttpHeaders	Egyszerű JSON-objektumként ábrázolt HttpHeaders-gyűjtemény.
RequestPolicyFactory	Létrehoz egy kérésenként egy új RequestPolicy-t, amely a megadott nextPolicy-t használja.
TelemetryInfo	Telemetriai adatok. A User-Agent sztringbe belefoglalandó kulcs-/érték párok.
TransferProgressEvent	A feltöltési vagy letöltési folyamatra válaszul aktiválódott.

Enums

HttpPipelineLogLevel	A HttpPipelineLoggerrel használható naplók különböző szintjei.
QueryCollectionFormat	Az a formátum, amely egy értéktömb összeillesztéséhez használható egy lekérdezési paraméter értékéhez.
RetryMode	Az újrapróbálkozási mód típusát ismerteti. Jelenleg csak exponenciális támogatás.

Functions

applyMixins(unknown, any[])	A sourceCtors prototípus tulajdonságainak alkalmazása a targetCtor prototípusára
bearerTokenAuthenticationPolicy(TokenCredential, string \| string[])	Létrehoz egy új gyárat a RequestPolicy számára, amely egy tulajdonosi jogkivonatot alkalmaz a kérések `Authorization` fejlécére.
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	A megadott beállítások alapján létrehoz egy HTTP-folyamatot.
delay(number, DelayOptions)	A setTimeout burkolója, amely a timeInMs ezredmásodperc után felold egy ígéretet.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	Hozzon létre egy új szerializációs RequestPolicyCreatort, amely szerializálja a HTTP-kérelemtörzseket, miközben áthaladnak a HTTP-folyamaton.
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	Tekintettel arra, hogy egy adott tartalomtípus JSON-ként vagy XML-ként elemezhető, a HTTP-választ felhasználja a kérelem OperationSpecáltal meghatározott eredményobjektum létrehozásához.
disableResponseDecompressionPolicy()	Egy kérésházirend-előállítót ad vissza, amely a <xref:DisableResponseDecompressionPolicy>egy példányának létrehozásához használható.
encodeUri(string)	Kódol egy URI-t.
executePromisesSequentially(any[], unknown)	Az ígéretek tömbjének egymást követő végrehajtása. Ihletet erre a módszerre van itt: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Fantasztikus blog az ígéretekről!
exponentialRetryPolicy(number, number, number)	A kérést újrapróbálkozási szabályzat, amely a megadott maximális újrapróbálkozási időintervallumig többször újrapróbálkozza a kérést, minden újrapróbálkozás a legutóbbi időpontnál hosszabb ideig vár.
flattenResponse(HttpOperationResponse, undefined \| OperationResponse)	Egy HttpOperationResponse normalizált HTTP-válaszobjektumba (RestResponse) elemzi.
generateClientRequestIdPolicy(string)	Létrehoz egy szabályzatot, amely egyedi kérésazonosítót rendel a kimenő kérésekhez.
generateUuid()	Generált UUID
getDefaultProxySettings(string)	Egy proxykiszolgáló adott URL-címét `ProxySettings` konvertálja, vagy ha nem adja át, `ProxySettings` próbál lekérni az aktuális környezetből.
getDefaultUserAgentValue()	A felhasználói ügynökök létrehozásának alapértelmezett módszere. A csomagból származó statikus információkat, valamint a futtatókörnyezetből elérhető rendszerinformációkat használja.
isDuration(string)	Azt jelzi, hogy a megadott sztring ISO 8601 formátumban van-e.
isTokenCredential(unknown)	Tesztel egy objektumot annak megállapításához, hogy implementálja-e a TokenCredentialt.
isValidUuid(string)	A megadott uuid sztringként való érvényesítése
keepAlivePolicy(KeepAliveOptions)	Létrehoz egy szabályzatot, amely szabályozza, hogy a HTTP-kapcsolatok megmaradnak-e a jövőbeli kérések esetében.
logPolicy(LogPolicyOptions)	Létrehoz egy szabályzatot, amely naplózza a kimenő kéréssel és a bejövő válaszokkal kapcsolatos információkat.
operationOptionsToRequestOptionsBase<T>(T)	Az OperationOptions átalakítása RequestOptionsBase-vé
parseXML(string, SerializerOptions)	Adott XML-sztring átalakítása JSON-fájllá
promiseToCallback(Promise<any>)	Az ígéreteket visszahívássá alakítja.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Az ígéreteket szolgáltatásvisszahívássá alakítja.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Olyan szabályzat, amely lehetővé teszi, hogy proxybeállításokat alkalmazzon az összes kérelemre. Ha nem ad át statikus beállításokat, a rendszer lekéri őket a HTTPS_PROXY vagy HTTP_PROXY környezeti változókból.
redirectPolicy(number)	Létrehoz egy átirányítási szabályzatot, amely megismétli a kérést egy új célhelyre, ha egy válasz egy "hely" fejléccel és egy 300 és 307 közötti állapotkóddal érkezik.
serializeObject(unknown)	Olyan segédprogramfüggvény, amely bináris információkat tartalmazó objektumokat szerializál egy egyszerű objektumba, tömbbe vagy sztringbe.
signingPolicy(ServiceClientCredentials)	Létrehoz egy szabályzatot, amely aláírja a kimenő kéréseket a megadott `authenticationProvidersignRequest` metódusának meghívásával.
stringifyXML(unknown, SerializerOptions)	Adott JSON-objektum konvertálása XML-sztringgé
stripRequest(WebResourceLike)	A Http-kérelem olyan lecsupaszított verzióját adja vissza, amely nem tartalmazza az Engedélyezési fejlécet.
stripResponse(HttpOperationResponse)	A Http-válasz egy lecsupaszított verzióját adja vissza, amely csak törzset, fejléceket és állapotot tartalmaz.
systemErrorRetryPolicy(number, number, number, number)	Az "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" vagy "ENOENT" kóddal azonosított, rendszerhiba esetén újrapróbálkozott szabályzat.
throttlingRetryPolicy()	Létrehoz egy szabályzatot, amely újra elküldi a kérést, ha a válasz azt jelzi, hogy a kérés szabályozási okok miatt meghiúsult. Ha például a válasz egy `Retry-After` fejlécet tartalmaz, újra megkísérli elküldeni a kérést az adott fejléc értéke alapján. További információ: 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 és https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tracingPolicy(TracingPolicyOptions)	Létrehoz egy szabályzatot, amely a kimenő kéréseket nyomkövetési időtartammal burkolja.
userAgentPolicy(TelemetryInfo)	Egy szabályzatot ad vissza, amely hozzáadja a felhasználói ügynök fejlécét a kimenő kérelmekhez a megadott TelemetriaInfoalapján.

Változók

MapperType	String enum, amely tartalmazza a tulajdonságleképezők stringtípusait.
Constants	Egy állandó halmaz, amelyet belsőleg használnak a kérések feldolgozásakor.
XML_ATTRKEY	Az alapértelmezett kulcs, amelyet az XML attribútumok elérésére használnak.
XML_CHARKEY	Az alapértelmezett kulcs, amelyet az XML érték tartalmához lehet használni.
isNode	Egy állandó, amely jelzi, hogy a kód által futó környezet Node.js kompatibilis-e.

Funkciók részletei

applyMixins(unknown, any[])

A sourceCtors prototípus tulajdonságainak alkalmazása a targetCtor prototípusára

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

Paraméterek

targetCtorParam: unknown

sourceCtors: any[]

Forrásobjektumok tömbje, amelyekből a tulajdonságokat meg kell adni.

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Létrehoz egy új gyárat a RequestPolicy számára, amely egy tulajdonosi jogkivonatot alkalmaz a kérések Authorization fejlécére.

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

Paraméterek

credential: TokenCredential

A TokenCredential implementáció, amely képes biztosítani a tulajdonosi jogkivonatot.

scopes: string | string[]

Azok a hatókörök, amelyekre a tulajdonosi jogkivonat vonatkozik.

Visszatér

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

A megadott beállítások alapján létrehoz egy HTTP-folyamatot.

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

Paraméterek

pipelineOptions: InternalPipelineOptions

Az SDK-ügyfél HTTP-folyamatában a szabályzatok konfigurálásához használt beállításokat határozza meg.

authPolicyFactory: RequestPolicyFactory

Nem kötelező hitelesítési házirend-előállító, amelyet a kérések aláírásához használhat.

Visszatér

ServiceClientOptions

Új ServiceClient-létrehozásához adható beállítások készlete.

delay(number, DelayOptions)

A setTimeout burkolója, amely a timeInMs ezredmásodperc után felold egy ígéretet.

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

Paraméterek

timeInMs: number

A késleltetni kívánt ezredmásodpercek száma.

options: DelayOptions

A késleltetési lehetőségek – jelenleg megszakított beállítások

Visszatér

Promise<void>

A timeInMs után feloldott ígéret

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Hozzon létre egy új szerializációs RequestPolicyCreatort, amely szerializálja a HTTP-kérelemtörzseket, miközben áthaladnak a HTTP-folyamaton.

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

Paraméterek

deserializationContentTypes: DeserializationContentTypes

parsingOptions: SerializerOptions

Visszatér

RequestPolicyFactory

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

Tekintettel arra, hogy egy adott tartalomtípus JSON-ként vagy XML-ként elemezhető, a HTTP-választ felhasználja a kérelem OperationSpecáltal meghatározott eredményobjektum létrehozásához.

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

Paraméterek

jsonContentTypes: string[]

Választartalom-típusok a törzs JSON-ként való elemzéséhez.

xmlContentTypes: string[]

Választartalom-típusok a törzs XML-ként való elemzéséhez.

response: HttpOperationResponse

HTTP-válasz a folyamatból.

options: SerializerOptions

A szerializáló beállításai, főként az XML-elemző konfigurálásához, ha szükséges.

Visszatér

Promise<HttpOperationResponse>

A ServiceClientáltal visszaadott HttpOperationResponse .

disableResponseDecompressionPolicy()

Egy kérésházirend-előállítót ad vissza, amely a <xref:DisableResponseDecompressionPolicy>egy példányának létrehozásához használható.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

Visszatér

RequestPolicyFactory

encodeUri(string)

Kódol egy URI-t.

function encodeUri(uri: string): string

Paraméterek

uri: string

A kódolandó URI.

Visszatér

string

A kódolt URI.

executePromisesSequentially(any[], unknown)

Az ígéretek tömbjének egymást követő végrehajtása. Ihletet erre a módszerre van itt: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Fantasztikus blog az ígéretekről!

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

Paraméterek

promiseFactories: any[]

Ígéretgyárak tömbje (Az ígéretet visszaadó függvény)

kickstart: unknown

Az ígéretlánc elindításához használt első ígéret bemenete. Ha nincs megadva, akkor az ígéretlánc meghatározatlannal kezdődik.

Visszatér

Promise<any>

Feloldott vagy elutasított ígéretek lánca

exponentialRetryPolicy(number, number, number)

A kérést újrapróbálkozási szabályzat, amely a megadott maximális újrapróbálkozási időintervallumig többször újrapróbálkozza a kérést, minden újrapróbálkozás a legutóbbi időpontnál hosszabb ideig vár.

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

Paraméterek

retryCount: number

Az újrapróbálkozések maximális száma.

retryInterval: number

Az újrapróbálkozások közötti alapidő.

maxRetryInterval: number

Az újrapróbálkozások közötti várakozás maximális ideje.

Visszatér

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Egy HttpOperationResponse normalizált HTTP-válaszobjektumba (RestResponse) elemzi.

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

Paraméterek

_response: HttpOperationResponse

Burkolóobjektum http-válaszhoz.

responseSpec: undefined | OperationResponse

Megfeleltetők a választulajdonságok elemzéséhez.

Visszatér

RestResponse

Normalizált válaszobjektum.

generateClientRequestIdPolicy(string)

Létrehoz egy szabályzatot, amely egyedi kérésazonosítót rendel a kimenő kérésekhez.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Paraméterek

requestIdHeaderName: string

Az egyedi azonosító kéréshez való hozzárendeléséhez használandó fejléc neve.

Visszatér

RequestPolicyFactory

generateUuid()

Generált UUID

function generateUuid(): string

Visszatér

string

RFC4122 v4 UUID azonosítót.

getDefaultProxySettings(string)

Egy proxykiszolgáló adott URL-címét ProxySettings konvertálja, vagy ha nem adja át, ProxySettings próbál lekérni az aktuális környezetből.

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

Paraméterek

proxyUrl: string

A proxy URL-címe

Visszatér

ProxySettings | undefined

Az alapértelmezett proxybeállítások, vagy nem definiálva.

getDefaultUserAgentValue()

A felhasználói ügynökök létrehozásának alapértelmezett módszere. A csomagból származó statikus információkat, valamint a futtatókörnyezetből elérhető rendszerinformációkat használja.

function getDefaultUserAgentValue(): string

Visszatér

string

isDuration(string)

Azt jelzi, hogy a megadott sztring ISO 8601 formátumban van-e.

function isDuration(value: string): boolean

Paraméterek

value: string

Az ISO 8601 időtartamformátumban érvényesítendő érték.

Visszatér

boolean

true, ha érvényes, false ellenkező esetben.

isTokenCredential(unknown)

Tesztel egy objektumot annak megállapításához, hogy implementálja-e a TokenCredentialt.

function isTokenCredential(credential: unknown): credential

Paraméterek

credential: unknown

A tesztelendő feltételezett TokenCredential.

Visszatér

credential

isValidUuid(string)

A megadott uuid sztringként való érvényesítése

function isValidUuid(uuid: string): boolean

Paraméterek

uuid: string

Az uuid sztringként, amelyet ellenőrizni kell

Visszatér

boolean

Igaz, ha az uuid érvényes; máskülönben hamis.

keepAlivePolicy(KeepAliveOptions)

Létrehoz egy szabályzatot, amely szabályozza, hogy a HTTP-kapcsolatok megmaradnak-e a jövőbeli kérések esetében.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Paraméterek

keepAliveOptions: KeepAliveOptions

Életben tarthatja a lehetőségeket. Alapértelmezés szerint a HTTP-kapcsolatok megmaradnak a jövőbeli kérésekhez.

Visszatér

RequestPolicyFactory

A <xref:KeepAlivePolicy> egy példánya

logPolicy(LogPolicyOptions)

Létrehoz egy szabályzatot, amely naplózza a kimenő kéréssel és a bejövő válaszokkal kapcsolatos információkat.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

Paraméterek

loggingOptions: LogPolicyOptions

Naplózási beállítások.

Visszatér

RequestPolicyFactory

A <xref:LogPolicy> egy példánya

operationOptionsToRequestOptionsBase<T>(T)

Az OperationOptions átalakítása RequestOptionsBase-vé

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

Paraméterek

opts: T

A RequestOptionsBase-be konvertálandó OperationOptions objektum

Visszatér

RequestOptionsBase

parseXML(string, SerializerOptions)

Adott XML-sztring átalakítása JSON-fájllá

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

Paraméterek

str: string

A JSON-ba elemezendő XML-tartalmat tartalmazó sztring

opts: SerializerOptions

Adott XML-sztring elemzését szabályozó beállítások

Visszatér

Promise<any>

promiseToCallback(Promise<any>)

Figyelmeztetés

Ez az API most már elavult volt.

generated code should instead depend on responseToBody

Az ígéreteket visszahívássá alakítja.

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

Paraméterek

promise: Promise<any>

A visszahívássá konvertálandó ígéret

Visszatér

(cb: Function) => void

A visszahívási (cb: Function) => void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Az ígéreteket szolgáltatásvisszahívássá alakítja.

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

Paraméterek

promise: Promise<HttpOperationResponse>

A HttpOperationResponse szolgáltatásvisszahívássá alakításának ígérete

Visszatér

(cb: ServiceCallback<T>) => void

A szolgáltatás visszahívását fogadó függvény (cb: ServiceCallback<T>): void

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

Olyan szabályzat, amely lehetővé teszi, hogy proxybeállításokat alkalmazzon az összes kérelemre. Ha nem ad át statikus beállításokat, a rendszer lekéri őket a HTTPS_PROXY vagy HTTP_PROXY környezeti változókból.

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

Paraméterek

proxySettings: ProxySettings

Az egyes kérelmekhez használandó ProxySettings.

options: { customNoProxyList?: string[] }

további beállítások, például egyéni NO_PROXY minták

Visszatér

RequestPolicyFactory

redirectPolicy(number)

Létrehoz egy átirányítási szabályzatot, amely megismétli a kérést egy új célhelyre, ha egy válasz egy "hely" fejléccel és egy 300 és 307 közötti állapotkóddal érkezik.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Paraméterek

maximumRetries: number

Követendő átirányítások maximális száma.

Visszatér

RequestPolicyFactory

A <xref:RedirectPolicy> egy példánya

serializeObject(unknown)

Olyan segédprogramfüggvény, amely bináris információkat tartalmazó objektumokat szerializál egy egyszerű objektumba, tömbbe vagy sztringbe.

function serializeObject(toSerialize: unknown): any

Paraméterek

toSerialize: unknown

Visszatér

any

signingPolicy(ServiceClientCredentials)

Létrehoz egy szabályzatot, amely aláírja a kimenő kéréseket a megadott authenticationProvidersignRequest metódusának meghívásával.

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Paraméterek

authenticationProvider: ServiceClientCredentials

A hitelesítésszolgáltató.

Visszatér

RequestPolicyFactory

A <xref:SigningPolicy>egy példánya.

stringifyXML(unknown, SerializerOptions)

Adott JSON-objektum konvertálása XML-sztringgé

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

Paraméterek

obj: unknown

XML-sztringgé konvertálandó JSON-objektum

opts: SerializerOptions

Az adott JSON-objektum elemzését szabályozó beállítások

Visszatér

string

stripRequest(WebResourceLike)

A Http-kérelem olyan lecsupaszított verzióját adja vissza, amely nem tartalmazza az Engedélyezési fejlécet.

function stripRequest(request: WebResourceLike): WebResourceLike

Paraméterek

request: WebResourceLike

A Http-kérelem objektum

Visszatér

WebResourceLike

A Http-kérelem lecsupaszított verziója.

stripResponse(HttpOperationResponse)

A Http-válasz egy lecsupaszított verzióját adja vissza, amely csak törzset, fejléceket és állapotot tartalmaz.

function stripResponse(response: HttpOperationResponse): any

Paraméterek

response: HttpOperationResponse

A HTTP-válasz

Visszatér

any

A Http Response lecsupaszított verziója.

systemErrorRetryPolicy(number, number, number, number)

Az "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" vagy "ENOENT" kóddal azonosított, rendszerhiba esetén újrapróbálkozott szabályzat.

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

Paraméterek

retryCount: number

Az újrapróbálkozések maximális száma.

retryInterval: number

Az ügyfél újrapróbálkozási időköze ezredmásodpercben.

minRetryInterval: number

A minimális újrapróbálkozási időköz ezredmásodpercben.

maxRetryInterval: number

A maximális újrapróbálkozási időköz ezredmásodpercben.

Visszatér

RequestPolicyFactory

A <xref:SystemErrorRetryPolicy> egy példánya

throttlingRetryPolicy()

Létrehoz egy szabályzatot, amely újra elküldi a kérést, ha a válasz azt jelzi, hogy a kérés szabályozási okok miatt meghiúsult. Ha például a válasz egy Retry-After fejlécet tartalmaz, újra megkísérli elküldeni a kérést az adott fejléc értéke alapján.

További információ: 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 és https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): RequestPolicyFactory

Visszatér

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

Létrehoz egy szabályzatot, amely a kimenő kéréseket nyomkövetési időtartammal burkolja.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

Paraméterek

tracingOptions: TracingPolicyOptions

Nyomkövetési beállítások.

Visszatér

RequestPolicyFactory

A <xref:TracingPolicy> osztály egy példánya.

userAgentPolicy(TelemetryInfo)

Egy szabályzatot ad vissza, amely hozzáadja a felhasználói ügynök fejlécét a kimenő kérelmekhez a megadott TelemetriaInfoalapján.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Paraméterek

userAgentData: TelemetryInfo

Telemetriai adatok.

Visszatér

RequestPolicyFactory

Új <xref:UserAgentPolicy>.

Variable Details

MapperType

String enum, amely tartalmazza a tulajdonságleképezők stringtípusait.

MapperType: { Base64Url: "Base64Url", Boolean: "Boolean", ByteArray: "ByteArray", Composite: "Composite", Date: "Date", DateTime: "DateTime", DateTimeRfc1123: "DateTimeRfc1123", Dictionary: "Dictionary", Enum: "Enum", Number: "Number", Object: "Object", Sequence: "Sequence", Stream: "Stream", String: "String", TimeSpan: "TimeSpan", UnixTime: "UnixTime" }

Típus

{ Base64Url: "Base64Url", Boolean: "Boolean", ByteArray: "ByteArray", Composite: "Composite", Date: "Date", DateTime: "DateTime", DateTimeRfc1123: "DateTimeRfc1123", Dictionary: "Dictionary", Enum: "Enum", Number: "Number", Object: "Object", Sequence: "Sequence", Stream: "Stream", String: "String", TimeSpan: "TimeSpan", UnixTime: "UnixTime" }

Constants

Egy állandó halmaz, amelyet belsőleg használnak a kérések feldolgozásakor.

Constants: { ALL_PROXY: string, HTTP: string, HTTPS: string, HTTPS_PROXY: string, HTTP_PROXY: string, HeaderConstants: { AUTHORIZATION: string, AUTHORIZATION_SCHEME: string, RETRY_AFTER: string, USER_AGENT: string }, HttpConstants: { HttpVerbs: { DELETE: string, GET: string, HEAD: string, MERGE: string, PATCH: string, POST: string, PUT: string }, StatusCodes: { ServiceUnavailable: number, TooManyRequests: number } }, NO_PROXY: string, coreHttpVersion: string }

Típus

{ ALL_PROXY: string, HTTP: string, HTTPS: string, HTTPS_PROXY: string, HTTP_PROXY: string, HeaderConstants: { AUTHORIZATION: string, AUTHORIZATION_SCHEME: string, RETRY_AFTER: string, USER_AGENT: string }, HttpConstants: { HttpVerbs: { DELETE: string, GET: string, HEAD: string, MERGE: string, PATCH: string, POST: string, PUT: string }, StatusCodes: { ServiceUnavailable: number, TooManyRequests: number } }, NO_PROXY: string, coreHttpVersion: string }

XML_ATTRKEY

Az alapértelmezett kulcs, amelyet az XML attribútumok elérésére használnak.

XML_ATTRKEY: "$"

Típus

"$"

XML_CHARKEY

Az alapértelmezett kulcs, amelyet az XML érték tartalmához lehet használni.

XML_CHARKEY: "_"

Típus

"_"

isNode

Figyelmeztetés

Ez az API most már elavult volt.

Use isNodeLike instead.

Egy állandó, amely jelzi, hogy a kód által futó környezet Node.js kompatibilis-e.

isNode: boolean

Típus

boolean

Megosztás a következőn keresztül:

@azure/core-http package

Előkelő társaság

Felületek

Típus-aliasok

Enums

Functions

Változók

Funkciók részletei

applyMixins(unknown, any[])

Paraméterek

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Paraméterek

Visszatér

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Paraméterek

Visszatér

delay(number, DelayOptions)

Paraméterek

Visszatér

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Paraméterek

Visszatér

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

Paraméterek

Visszatér

disableResponseDecompressionPolicy()

Visszatér

encodeUri(string)

Paraméterek

Visszatér

executePromisesSequentially(any[], unknown)

Paraméterek

Visszatér

exponentialRetryPolicy(number, number, number)

Paraméterek

Visszatér

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Paraméterek

Visszatér

generateClientRequestIdPolicy(string)

Paraméterek

Visszatér

generateUuid()

Visszatér

getDefaultProxySettings(string)

Paraméterek

Visszatér

getDefaultUserAgentValue()

Visszatér

isDuration(string)

Paraméterek

Visszatér

isTokenCredential(unknown)

Paraméterek

Visszatér

isValidUuid(string)

Paraméterek

Visszatér

keepAlivePolicy(KeepAliveOptions)

Paraméterek

Visszatér

logPolicy(LogPolicyOptions)

Paraméterek

Visszatér

operationOptionsToRequestOptionsBase<T>(T)

Paraméterek

Visszatér

parseXML(string, SerializerOptions)

Paraméterek

Visszatér

promiseToCallback(Promise<any>)

Paraméterek

Visszatér

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Paraméterek

Visszatér

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

Paraméterek

Visszatér