Udostępnij za pośrednictwem

ServiceClientOptions interface

  • Odwołanie
Pakiet:
@azure/core-http

Opcje, które należy podać podczas tworzenia klienta.

Właściwości

clientRequestIdHeaderName

Jeśli zostanie określony, element GenerateRequestIdPolicy zostanie dodany do potoku HTTP, który doda nagłówek do wszystkich żądań wychodzących o tej nazwie nagłówka i losowy identyfikator UUID jako identyfikator żądania.
credentialScopes

Jeśli zostanie określony, zostanie użyty do skompilowania elementu BearerTokenAuthenticationPolicy.
deserializationContentTypes

Typy zawartości, które będą skojarzone z serializacji JSON lub XML.
generateClientRequestIdHeader

Niezależnie od tego, czy należy wygenerować nagłówek identyfikatora żądania klienta dla każdego żądania HTTP.
httpClient

Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.
httpPipelineLogger

HttpPipelineLogger, który może służyć do debugowania żądańPolicies w potoku HTTP.
noRetryPolicy

Jeśli ustawiono wartość true, wyłącz domyślne zasady ponawiania prób.
proxySettings

Ustawienia serwera proxy, które będą używane dla każdego żądania HTTP (tylko Node.js).
requestPolicyFactories

Tablica fabryk, które są wywoływane w celu utworzenia potoku RequestPolicy używanego do wysyłania żądania HTTP w sieci lub funkcji, która przyjmuje wartość domyślnąRequestPolicyFactories i zwraca wartość requestPolicyFactories, która zostanie użyta.
rpRegistrationRetryTimeout

Pobiera lub ustawia limit czasu ponawiania w sekundach dla funkcji AutomaticRPRegistration. Wartość domyślna to 30.
userAgent

Ciąg, który ma zostać ustawiony na nagłówek telemetrii podczas wysyłania żądania, lub funkcji, która przyjmuje domyślny ciąg user-agent i zwraca ciąg agenta użytkownika, który zostanie użyty.
userAgentHeaderName

Nazwa nagłówka do użycia dla nagłówka telemetrii podczas wysyłania żądania. Jeśli ta wartość nie zostanie określona, podczas uruchamiania polecenia "User-Agent" będzie używany podczas uruchamiania w Node.js i "x-ms-useragent" będzie używany podczas uruchamiania w przeglądarce.
withCredentials

Czy należy dołączać poświadczenia do żądań CORS w przeglądarce. Aby uzyskać więcej informacji, zobacz https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

Szczegóły właściwości

clientRequestIdHeaderName

Jeśli zostanie określony, element GenerateRequestIdPolicy zostanie dodany do potoku HTTP, który doda nagłówek do wszystkich żądań wychodzących o tej nazwie nagłówka i losowy identyfikator UUID jako identyfikator żądania.

clientRequestIdHeaderName?: string

Wartość właściwości

string

credentialScopes

Jeśli zostanie określony, zostanie użyty do skompilowania elementu BearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

Wartość właściwości

string | string[]

deserializationContentTypes

Typy zawartości, które będą skojarzone z serializacji JSON lub XML.

deserializationContentTypes?: DeserializationContentTypes

Wartość właściwości

DeserializationContentTypes

generateClientRequestIdHeader

Niezależnie od tego, czy należy wygenerować nagłówek identyfikatora żądania klienta dla każdego żądania HTTP.

generateClientRequestIdHeader?: boolean

Wartość właściwości

boolean

httpClient

Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.

httpClient?: HttpClient

Wartość właściwości

HttpClient

httpPipelineLogger

HttpPipelineLogger, który może służyć do debugowania żądańPolicies w potoku HTTP.

httpPipelineLogger?: HttpPipelineLogger

Wartość właściwości

HttpPipelineLogger

noRetryPolicy

Jeśli ustawiono wartość true, wyłącz domyślne zasady ponawiania prób.

noRetryPolicy?: boolean

Wartość właściwości

boolean

proxySettings

Ustawienia serwera proxy, które będą używane dla każdego żądania HTTP (tylko Node.js).

proxySettings?: ProxySettings

Wartość właściwości

ProxySettings

requestPolicyFactories

Tablica fabryk, które są wywoływane w celu utworzenia potoku RequestPolicy używanego do wysyłania żądania HTTP w sieci lub funkcji, która przyjmuje wartość domyślnąRequestPolicyFactories i zwraca wartość requestPolicyFactories, która zostanie użyta.

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

Wartość właściwości

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

rpRegistrationRetryTimeout

Pobiera lub ustawia limit czasu ponawiania w sekundach dla funkcji AutomaticRPRegistration. Wartość domyślna to 30.

rpRegistrationRetryTimeout?: number

Wartość właściwości

number

userAgent

Ciąg, który ma zostać ustawiony na nagłówek telemetrii podczas wysyłania żądania, lub funkcji, która przyjmuje domyślny ciąg user-agent i zwraca ciąg agenta użytkownika, który zostanie użyty.

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

Wartość właściwości

string | (defaultUserAgent: string) => string

userAgentHeaderName

Nazwa nagłówka do użycia dla nagłówka telemetrii podczas wysyłania żądania. Jeśli ta wartość nie zostanie określona, podczas uruchamiania polecenia "User-Agent" będzie używany podczas uruchamiania w Node.js i "x-ms-useragent" będzie używany podczas uruchamiania w przeglądarce.

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

Wartość właściwości

string | (defaultUserAgentHeaderName: string) => string

withCredentials

Czy należy dołączać poświadczenia do żądań CORS w przeglądarce. Aby uzyskać więcej informacji, zobacz https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Wartość właściwości

boolean