ServiceClientOptions interface

Pakiet:

@azure/ms-rest-js

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

Właściwości

agentSettings	Agenci HTTP i HTTPS, którzy będą używać dla każdego żądania HTTP (tylko Node.js).
baseUri	Jeśli określono: Stanie się to baseUri podstawowym identyfikatorem URI, względem którego będą wysyłane żądania dla tego obiektu ServiceClient. Jeśli element baseUri jest zgodny ze znanym punktem końcowym usługi Resource Manager i jeśli TokenCredential obiekt został przekazany przez konstruktor, definiuje getToken zakres baseUri , który ma mieć wartość ${options.baseUri}/.default. W przeciwnym razie zakres będzie domyślnie miał wartość "https://management.azure.com/.default"". Jeśli nie zostanie określony: Wszystkie operacjeSpecs muszą zawierać właściwość baseUrl. TokenCredential Jeśli element został przekazany przez konstruktor, getToken zakres ma wartość "https://management.azure.com/.default"".
clientRequestIdHeaderName	Jeśli zostanie określony, do potoku HTTP zostanie dodany element GenerateRequestIdPolicy, który doda nagłówek do wszystkich żądań wychodzących o tej nazwie nagłówka i losowy identyfikator UUID jako identyfikator żądania.
deserializationContentTypes	Typy zawartości, które będą skojarzone z serializacji JSON lub XML.
generateClientRequestIdHeader	Określa, czy chcesz 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órego można użyć do debugowania elementów RequestPolicies w potoku HTTP.
noRetryPolicy	W przypadku ustawienia wartości true wyłącz domyślne zasady ponawiania.
proxySettings	Ustawienia serwera proxy, które będą używane dla każdego żądania HTTP (tylko Node.js).
redirectOptions	Opcje obsługi odpowiedzi przekierowania.
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 element defaultRequestPolicyFactories i zwraca elementy requestPolicyFactories, które będą używane.
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 user-agent, który będzie używany.
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 w Node.js zostanie użyty element "User-Agent", a polecenie "x-ms-command-name" będzie używane podczas uruchamiania w przeglądarce.
withCredentials	Określa, 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

agentSettings

Agenci HTTP i HTTPS, którzy będą używać dla każdego żądania HTTP (tylko Node.js).

agentSettings?: AgentSettings

Wartość właściwości

AgentSettings

baseUri

Jeśli określono:

• Stanie się to baseUri podstawowym identyfikatorem URI, względem którego będą wysyłane żądania dla tego obiektu ServiceClient.
• Jeśli element baseUri jest zgodny ze znanym punktem końcowym usługi Resource Manager i jeśli TokenCredential obiekt został przekazany przez konstruktor, definiuje getToken zakres baseUri , który ma mieć wartość ${options.baseUri}/.default. W przeciwnym razie zakres będzie domyślnie miał wartość "https://management.azure.com/.default"".

Jeśli nie zostanie określony:

• Wszystkie operacjeSpecs muszą zawierać właściwość baseUrl.
• TokenCredential Jeśli element został przekazany przez konstruktor, getToken zakres ma wartość "https://management.azure.com/.default"".

baseUri?: string

Wartość właściwości

string

clientRequestIdHeaderName

Jeśli zostanie określony, do potoku HTTP zostanie dodany element GenerateRequestIdPolicy, 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

deserializationContentTypes

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

deserializationContentTypes?: DeserializationContentTypes

Wartość właściwości

DeserializationContentTypes

generateClientRequestIdHeader

Określa, czy chcesz 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órego można użyć do debugowania elementów RequestPolicies w potoku HTTP.

httpPipelineLogger?: HttpPipelineLogger

Wartość właściwości

HttpPipelineLogger

noRetryPolicy

W przypadku ustawienia wartości true wyłącz domyślne zasady ponawiania.

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

redirectOptions

Opcje obsługi odpowiedzi przekierowania.

redirectOptions?: RedirectOptions

Wartość właściwości

RedirectOptions

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 element defaultRequestPolicyFactories i zwraca elementy requestPolicyFactories, które będą używane.

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 user-agent, który będzie używany.

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 w Node.js zostanie użyty element "User-Agent", a polecenie "x-ms-command-name" będzie używane podczas uruchamiania w przeglądarce.

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

Wartość właściwości

string | (defaultUserAgentHeaderName: string) => string

withCredentials

Określa, 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