Share via

ServiceClientOptions interface

  • Referencia
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, amelyek minden HTTP-kéréshez használhatók (csak Node.js).
baseUri

Ha meg van adva:

  • Ez baseUri lesz az alap URI, amellyel a rendszer kéréseket küld a ServiceClienthez.
  • Ha az baseUri egy ismert Resource Manager-végpontnak felel meg, és egy TokenCredential át lett adva a konstruktoron, ez baseUri határozza meg a getToken hatókört.${options.baseUri}/.default Ellenkező esetben a hatókör alapértelmezés szerint "https://management.azure.com/.default"" lesz.

Ha nincs megadva:

  • Minden OperationSpecs tulajdonságnak tartalmaznia kell egy baseUrl tulajdonságot.
  • Ha egy TokenCredential át lett adva a konstruktoron, 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 hozzáad egy fejlécet az összes kimenő kérelemhez, amelynek a fejlécneve és egy véletlenszerű UUID lesz a kérés azonosítója.
deserializationContentTypes

A JSON- vagy XML-szerializáláshoz társítandó 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 hibakereséséhez használható a HTTP-folyamatban.
noRetryPolicy

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

Proxybeállítások, amelyek minden HTTP-kéréshez használhatók (csak Node.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 létrehozzák a HTTP-kérések küldésére használt RequestPolicy folyamatot a vezetéken, vagy egy függvény, amely a defaultRequestPolicyFactories függvényt veszi fel, és visszaadja a használni kívánt requestPolicyFactories értéket.
rpRegistrationRetryTimeout

Lekéri vagy beállítja az újrapróbálkozási időtúllépést másodpercben az AutomaticRPRegistration függvényhez. 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 visszaadja a használni kívánt felhasználói-ügynök sztringet.
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ó: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

Tulajdonság adatai

agentSettings

HTTP- és HTTPS-ügynökök, amelyek minden HTTP-kéréshez használhatók (csak Node.js).

agentSettings?: AgentSettings

Tulajdonság értéke

AgentSettings

baseUri

Ha meg van adva:

  • Ez baseUri lesz az alap URI, amellyel a rendszer kéréseket küld a ServiceClienthez.
  • Ha az baseUri egy ismert Resource Manager-végpontnak felel meg, és egy TokenCredential át lett adva a konstruktoron, ez baseUri határozza meg a getToken hatókört.${options.baseUri}/.default Ellenkező esetben a hatókör alapértelmezés szerint "https://management.azure.com/.default"" lesz.

Ha nincs megadva:

  • Minden OperationSpecs tulajdonságnak tartalmaznia kell egy baseUrl tulajdonságot.
  • Ha egy TokenCredential át lett adva a konstruktoron, 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 hozzáad egy fejlécet az összes kimenő kérelemhez, amelynek a fejlécneve és egy véletlenszerű UUID lesz a kérés azonosítója.

clientRequestIdHeaderName?: string

Tulajdonság értéke

string

deserializationContentTypes

A JSON- vagy XML-szerializáláshoz társítandó 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 hibakereséséhez használható a HTTP-folyamatban.

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, amelyek minden HTTP-kéréshez használhatók (csak Node.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 létrehozzák a HTTP-kérések küldésére használt RequestPolicy folyamatot a vezetéken, vagy egy függvény, amely a defaultRequestPolicyFactories függvényt veszi fel, és visszaadja a használni kívánt requestPolicyFactories értéket.

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

Tulajdonság értéke

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

rpRegistrationRetryTimeout

Lekéri vagy beállítja az újrapróbálkozási időtúllépést másodpercben az AutomaticRPRegistration függvényhez. 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 visszaadja a használni kívánt felhasználói-ügynök sztringet.

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ó: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Tulajdonság értéke

boolean