Udostępnij za pośrednictwem

DeviceUpdateClientOptionalParams interface

  • Odwołanie
Pakiet:
@azure/iot-device-update

Parametry opcjonalne.

Extends
ServiceClientOptions

Właściwości

endpoint

Zastępuje punkt końcowy klienta.

Właściwości dziedziczone

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.
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

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).
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 nie zostanie to określone, podczas uruchamiania polecenia w Node.js zostanie użyty element "User-Agent", a polecenie "x-ms-useragent" 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

endpoint

Zastępuje punkt końcowy klienta.

endpoint?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

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

Dziedziczone z coreHttp.ServiceClientOptions.clientRequestIdHeaderName

credentialScopes

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

credentialScopes?: string | string[]

Wartość właściwości

string | string[]

Dziedziczone z coreHttp.ServiceClientOptions.credentialScopes

deserializationContentTypes

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

deserializationContentTypes?: DeserializationContentTypes

Wartość właściwości

DeserializationContentTypes

Dziedziczone z coreHttp.ServiceClientOptions.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

Dziedziczone z coreHttp.ServiceClientOptions.generateClientRequestIdHeader

httpClient

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

httpClient?: HttpClient

Wartość właściwości

HttpClient

Dziedziczone z coreHttp.ServiceClientOptions.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

Dziedziczone z coreHttp.ServiceClientOptions.httpPipelineLogger

noRetryPolicy

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

noRetryPolicy?: boolean

Wartość właściwości

boolean

Dziedziczone z coreHttp.ServiceClientOptions.noRetryPolicy

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

Dziedziczone z coreHttp.ServiceClientOptions.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 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[]

Dziedziczone z coreHttp.ServiceClientOptions.requestPolicyFactories

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

Dziedziczone z coreHttp.ServiceClientOptions.rpRegistrationRetryTimeout

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

Dziedziczone z coreHttp.ServiceClientOptions.userAgent

userAgentHeaderName

Nazwa nagłówka do użycia dla nagłówka telemetrii podczas wysyłania żądania. Jeśli nie zostanie to określone, podczas uruchamiania polecenia w Node.js zostanie użyty element "User-Agent", 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

Dziedziczone z coreHttp.ServiceClientOptions.userAgentHeaderName

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

Dziedziczone z coreHttp.ServiceClientOptions.withCredentials