StorageClientOptionalParams interface

Pakiet:

@azure/storage-blob

Parametry opcjonalne.

Rozszerzenie

ServiceClientOptions

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.
endpoint	Zastępuje punkt końcowy klienta.
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óry może służyć do debugowania elementów RequestPolicies w potoku HTTP.
noRetryPolicy	Jeśli ustawiono wartość true, wyłącz domyślne zasady ponawiania.
proxySettings	Ustawienia serwera proxy, które będą używane dla każdego żądania HTTP (tylkoNode.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 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 opcja nie zostanie określona, podczas uruchamiania polecenia "User-Agent" będzie używany podczas uruchamiania w Node.js, a polecenie "x-ms-useragent" będzie używane podczas uruchamiania w przeglądarce.
version	Określa wersję operacji do użycia dla tego żądania.
withCredentials	Określa, czy poświadczenia mają być uwzględniane w żądaniach 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

endpoint

Zastępuje punkt końcowy klienta.

endpoint?: string

Wartość właściwości

string

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óry może służyć do debugowania elementów RequestPolicies w potoku HTTP.

httpPipelineLogger?: HttpPipelineLogger

Wartość właściwości

HttpPipelineLogger

noRetryPolicy

Jeśli ustawiono wartość 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 (tylkoNode.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 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 opcja nie zostanie określona, podczas uruchamiania polecenia "User-Agent" będzie używany podczas uruchamiania w Node.js, a polecenie "x-ms-useragent" będzie używane podczas uruchamiania w przeglądarce.

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

Wartość właściwości

string | (defaultUserAgentHeaderName: string) => string

version

Określa wersję operacji do użycia dla tego żądania.

version?: string

Wartość właściwości

string

withCredentials

Określa, czy poświadczenia mają być uwzględniane w żądaniach 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