Sdílet prostřednictvím


ServiceClientOptions interface

Možnosti, které se mají poskytnout při vytváření klienta.

Vlastnosti

clientRequestIdHeaderName

Pokud je tato možnost zadána, přidá se do kanálu HTTP generateRequestIdPolicy, která přidá hlavičku do všech odchozích požadavků s tímto názvem hlavičky a náhodným UUID jako ID požadavku.

credentialScopes

Pokud je zadaný, použije se k sestavení BearerTokenAuthenticationPolicy.

deserializationContentTypes

Typy obsahu, které budou přidruženy k serializaci JSON nebo XML.

generateClientRequestIdHeader

Jestli se má vygenerovat hlavička ID požadavku klienta pro každý požadavek HTTP.

httpClient

HttpClient, který se použije k odesílání požadavků HTTP.

httpPipelineLogger

HttpPipelineLogger, který lze použít k ladění RequestPolicies v rámci kanálu HTTP.

noRetryPolicy

Pokud je nastavená hodnota true, vypněte výchozí zásadu opakování.

proxySettings

Nastavení proxy serveru, které se použije pro každý požadavek HTTP (pouze Node.js).

requestPolicyFactories

Pole továren, které jsou volány k vytvoření kanálu RequestPolicy sloužícího k odeslání požadavku HTTP na drátu, nebo funkce, která přebírá defaultRequestPolicyFactories a vrací requestPolicyFactories, která se použije.

rpRegistrationRetryTimeout

Získá nebo nastaví časový limit opakování v sekundách pro AutomaticRPRegistration. Výchozí hodnota je 30.

userAgent

Řetězec, který se má nastavit na hlavičku telemetrie při odesílání požadavku, nebo funkce, která převezme výchozí řetězec uživatelského agenta a vrátí řetězec uživatelského agenta, který se použije.

userAgentHeaderName

Název hlavičky, který se má použít pro hlavičku telemetrie při odesílání požadavku. Pokud není zadaný, použije se při spuštění na Node.js user-agent a při spuštění v prohlížeči se použije "x-ms-useragent".

withCredentials

Jestli se mají přihlašovací údaje zahrnout do požadavků CORS v prohlížeči. Další informace naleznete v tématu https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

Podrobnosti vlastnosti

clientRequestIdHeaderName

Pokud je tato možnost zadána, přidá se do kanálu HTTP generateRequestIdPolicy, která přidá hlavičku do všech odchozích požadavků s tímto názvem hlavičky a náhodným UUID jako ID požadavku.

clientRequestIdHeaderName?: string

Hodnota vlastnosti

string

credentialScopes

Pokud je zadaný, použije se k sestavení BearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

Hodnota vlastnosti

string | string[]

deserializationContentTypes

Typy obsahu, které budou přidruženy k serializaci JSON nebo XML.

deserializationContentTypes?: DeserializationContentTypes

Hodnota vlastnosti

generateClientRequestIdHeader

Jestli se má vygenerovat hlavička ID požadavku klienta pro každý požadavek HTTP.

generateClientRequestIdHeader?: boolean

Hodnota vlastnosti

boolean

httpClient

HttpClient, který se použije k odesílání požadavků HTTP.

httpClient?: HttpClient

Hodnota vlastnosti

httpPipelineLogger

HttpPipelineLogger, který lze použít k ladění RequestPolicies v rámci kanálu HTTP.

httpPipelineLogger?: HttpPipelineLogger

Hodnota vlastnosti

noRetryPolicy

Pokud je nastavená hodnota true, vypněte výchozí zásadu opakování.

noRetryPolicy?: boolean

Hodnota vlastnosti

boolean

proxySettings

Nastavení proxy serveru, které se použije pro každý požadavek HTTP (pouze Node.js).

proxySettings?: ProxySettings

Hodnota vlastnosti

requestPolicyFactories

Pole továren, které jsou volány k vytvoření kanálu RequestPolicy sloužícího k odeslání požadavku HTTP na drátu, nebo funkce, která přebírá defaultRequestPolicyFactories a vrací requestPolicyFactories, která se použije.

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

Hodnota vlastnosti

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

rpRegistrationRetryTimeout

Získá nebo nastaví časový limit opakování v sekundách pro AutomaticRPRegistration. Výchozí hodnota je 30.

rpRegistrationRetryTimeout?: number

Hodnota vlastnosti

number

userAgent

Řetězec, který se má nastavit na hlavičku telemetrie při odesílání požadavku, nebo funkce, která převezme výchozí řetězec uživatelského agenta a vrátí řetězec uživatelského agenta, který se použije.

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

Hodnota vlastnosti

string | (defaultUserAgent: string) => string

userAgentHeaderName

Název hlavičky, který se má použít pro hlavičku telemetrie při odesílání požadavku. Pokud není zadaný, použije se při spuštění na Node.js user-agent a při spuštění v prohlížeči se použije "x-ms-useragent".

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

Hodnota vlastnosti

string | (defaultUserAgentHeaderName: string) => string

withCredentials

Jestli se mají přihlašovací údaje zahrnout do požadavků CORS v prohlížeči. Další informace naleznete v tématu https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Hodnota vlastnosti

boolean