ServiceClientOptions interface

Csomag:

@azure/ms-rest-js

Az ügyfél létrehozásakor meg kell adni a beállításokat.

Tulajdonságok

agentSettings	HTTP- és HTTPS-ügynökök, amelyeket minden HTTP-kéréshez használunk (csakNode.js).
baseUri	Ha meg van adva: Ez a baseUri lesz az az alap URI, amely a ServiceClientre vonatkozó kéréseket küldi el. Ha a baseUri egy ismert Resource Manager-végpontnak felel meg, és a konstruktoron keresztül egy TokenCredential haladt át, ez a baseUri határozza meg a getToken${options.baseUri}/.default hatókört. Ellenkező esetben a hatókör alapértelmezés szerint "https://management.azure.com/.default". Ha nincs megadva: Minden OperationSpecs tulajdonságnak tartalmaznia kell egy baseUrl tulajdonságot. Ha egy TokenCredential a konstruktoron keresztül lett átadva, a getToken hatókör értéke "https://management.azure.com/.default".
clientRequestIdHeaderName	Ha meg van adva, egy GenerateRequestIdPolicy lesz hozzáadva a HTTP-folyamathoz, amely fejlécet ad hozzá az összes kimenő kéréshez ezzel a fejlécnévvel és egy véletlenszerű UUID azonosítóval a kérés azonosítójaként.
deserializationContentTypes	A JSON- vagy XML-szerializáláshoz társított tartalomtípusok.
generateClientRequestIdHeader	Az ügyfélkérés-azonosító fejlécének létrehozása az egyes HTTP-kérésekhez.
httpClient	A HTTP-kérések küldéséhez használt HttpClient.
httpPipelineLogger	A HttpPipelineLogger, amely a RequestPolicies http-folyamaton belüli hibakeresésére használható.
noRetryPolicy	Ha igaz értékre van állítva, kapcsolja ki az alapértelmezett újrapróbálkozási szabályzatot.
proxySettings	Proxybeállítások, amelyeket minden HTTP-kéréshez használunk (csakNode.js).
redirectOptions	Az átirányítási válaszok kezelésének beállításai.
requestPolicyFactories	Olyan gyárak tömbje, amelyek meghívva lesznek a HTTP-kérések vezetéken való küldéséhez használt RequestPolicy-folyamat létrehozásához, vagy egy függvény, amely a defaultRequestPolicyFactories függvényt veszi fel, és visszaadja a használni kívánt requestPolicyFactories parancsot.
rpRegistrationRetryTimeout	Másodpercek alatt lekéri vagy beállítja az újrapróbálkozási időtúllépést az AutomaticRPRegistration esetében. Az alapértelmezett érték 30.
userAgent	A kérés elküldése során a telemetriai fejlécre beállítani kívánt sztring, vagy egy függvény, amely az alapértelmezett felhasználói ügynök sztringet veszi fel, és a használni kívánt felhasználói ügynök sztringet adja vissza.
userAgentHeaderName	A telemetriai fejléchez a kérelem elküldése során használandó fejlécnév. Ha ez nincs megadva, akkor a "User-Agent" lesz használva, amikor Node.js fut, és az "x-ms-command-name" lesz használva a böngészőben való futtatáskor.
withCredentials	Adja meg a hitelesítő adatokat a CORS-kérelmekben a böngészőben. További információt a https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials talál.

Tulajdonság adatai

agentSettings

HTTP- és HTTPS-ügynökök, amelyeket minden HTTP-kéréshez használunk (csakNode.js).

agentSettings?: AgentSettings

Tulajdonság értéke

AgentSettings

baseUri

Ha meg van adva:

• Ez a baseUri lesz az az alap URI, amely a ServiceClientre vonatkozó kéréseket küldi el.
• Ha a baseUri egy ismert Resource Manager-végpontnak felel meg, és a konstruktoron keresztül egy TokenCredential haladt át, ez a baseUri határozza meg a getToken${options.baseUri}/.default hatókört. Ellenkező esetben a hatókör alapértelmezés szerint "https://management.azure.com/.default".

Ha nincs megadva:

• Minden OperationSpecs tulajdonságnak tartalmaznia kell egy baseUrl tulajdonságot.
• Ha egy TokenCredential a konstruktoron keresztül lett átadva, a getToken hatókör értéke "https://management.azure.com/.default".

baseUri?: string

Tulajdonság értéke

string

clientRequestIdHeaderName

Ha meg van adva, egy GenerateRequestIdPolicy lesz hozzáadva a HTTP-folyamathoz, amely fejlécet ad hozzá az összes kimenő kéréshez ezzel a fejlécnévvel és egy véletlenszerű UUID azonosítóval a kérés azonosítójaként.

clientRequestIdHeaderName?: string

Tulajdonság értéke

string

deserializationContentTypes

A JSON- vagy XML-szerializáláshoz társított tartalomtípusok.

deserializationContentTypes?: DeserializationContentTypes

Tulajdonság értéke

DeserializationContentTypes

generateClientRequestIdHeader

Az ügyfélkérés-azonosító fejlécének létrehozása az egyes HTTP-kérésekhez.

generateClientRequestIdHeader?: boolean

Tulajdonság értéke

boolean

httpClient

A HTTP-kérések küldéséhez használt HttpClient.

httpClient?: HttpClient

Tulajdonság értéke

HttpClient

httpPipelineLogger

A HttpPipelineLogger, amely a RequestPolicies http-folyamaton belüli hibakeresésére használható.

httpPipelineLogger?: HttpPipelineLogger

Tulajdonság értéke

HttpPipelineLogger

noRetryPolicy

Ha igaz értékre van állítva, kapcsolja ki az alapértelmezett újrapróbálkozási szabályzatot.

noRetryPolicy?: boolean

Tulajdonság értéke

boolean

proxySettings

Proxybeállítások, amelyeket minden HTTP-kéréshez használunk (csakNode.js).

proxySettings?: ProxySettings

Tulajdonság értéke

ProxySettings

redirectOptions

Az átirányítási válaszok kezelésének beállításai.

redirectOptions?: RedirectOptions

Tulajdonság értéke

RedirectOptions

requestPolicyFactories

Olyan gyárak tömbje, amelyek meghívva lesznek a HTTP-kérések vezetéken való küldéséhez használt RequestPolicy-folyamat létrehozásához, vagy egy függvény, amely a defaultRequestPolicyFactories függvényt veszi fel, és visszaadja a használni kívánt requestPolicyFactories parancsot.

requestPolicyFactories?: RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

Tulajdonság értéke

RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

rpRegistrationRetryTimeout

Másodpercek alatt lekéri vagy beállítja az újrapróbálkozási időtúllépést az AutomaticRPRegistration esetében. Az alapértelmezett érték 30.

rpRegistrationRetryTimeout?: number

Tulajdonság értéke

number

userAgent

A kérés elküldése során a telemetriai fejlécre beállítani kívánt sztring, vagy egy függvény, amely az alapértelmezett felhasználói ügynök sztringet veszi fel, és a használni kívánt felhasználói ügynök sztringet adja vissza.

userAgent?: string | (defaultUserAgent: string) => string

Tulajdonság értéke

string | (defaultUserAgent: string) => string

userAgentHeaderName

A telemetriai fejléchez a kérelem elküldése során használandó fejlécnév. Ha ez nincs megadva, akkor a "User-Agent" lesz használva, amikor Node.js fut, és az "x-ms-command-name" lesz használva a böngészőben való futtatáskor.

userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => string

Tulajdonság értéke

string | (defaultUserAgentHeaderName: string) => string

withCredentials

Adja meg a hitelesítő adatokat a CORS-kérelmekben a böngészőben. További információt a https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials talál.

withCredentials?: boolean

Tulajdonság értéke

boolean