次の方法で共有

DeviceUpdateClientOptionalParams interface

  • リファレンス
パッケージ:
@azure/iot-device-update

省略可能なパラメーター。

Extends
ServiceClientOptions

プロパティ

endpoint

クライアント エンドポイントをオーバーライドします。

継承されたプロパティ

clientRequestIdHeaderName

指定すると、GenerateRequestIdPolicy が HTTP パイプラインに追加されます。これにより、このヘッダー名とランダム UUID を要求 ID として持つすべての送信要求にヘッダーが追加されます。
credentialScopes

指定した場合は、 を使用して BearerTokenAuthenticationPolicy をビルドします。
deserializationContentTypes

JSON または XML シリアル化に関連付けられるコンテンツタイプ。
generateClientRequestIdHeader

HTTP 要求ごとにクライアント要求 ID ヘッダーを生成するかどうか。
httpClient

HTTP 要求の送信に使用される HttpClient。
httpPipelineLogger

HTTP パイプライン内で RequestPolicies をデバッグするために使用できる HttpPipelineLogger。
noRetryPolicy

true に設定されている場合は、既定の再試行ポリシーをオフにします。
proxySettings

すべての HTTP 要求に使用されるプロキシ設定 (Node.jsのみ)。
requestPolicyFactories

ワイヤで HTTP 要求を送信するために使用される RequestPolicy パイプラインを作成するために呼び出されるファクトリの配列、または defaultRequestPolicyFactories を受け取って使用される requestPolicyFactories を返す関数。
rpRegistrationRetryTimeout

AutomaticRPRegistration の再試行タイムアウトを秒単位で取得または設定します。 既定値は 30 です。
userAgent

要求の送信中にテレメトリ ヘッダーに設定される文字列、または既定のユーザー エージェント文字列を受け取り、使用されるユーザー エージェント文字列を返す関数。
userAgentHeaderName

要求の送信時にテレメトリ ヘッダーに使用するヘッダー名。 これを指定しない場合は、Node.jsで実行するときに "User-Agent" が使用され、ブラウザーで実行するときに "x-ms-useragent" が使用されます。
withCredentials

ブラウザーの CORS 要求に資格情報を含めるかどうか。 詳細については、「https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials」を参照してください。

プロパティの詳細

endpoint

クライアント エンドポイントをオーバーライドします。

endpoint?: string

プロパティ値

string

継承されたプロパティの詳細

clientRequestIdHeaderName

指定すると、GenerateRequestIdPolicy が HTTP パイプラインに追加されます。これにより、このヘッダー名とランダム UUID を要求 ID として持つすべての送信要求にヘッダーが追加されます。

clientRequestIdHeaderName?: string

プロパティ値

string

継承元 コアHttp.ServiceClientOptions.clientRequestIdHeaderName

credentialScopes

指定した場合は、 を使用して BearerTokenAuthenticationPolicy をビルドします。

credentialScopes?: string | string[]

プロパティ値

string | string[]

継承元 コアHttp.ServiceClientOptions.credentialScopes

deserializationContentTypes

JSON または XML シリアル化に関連付けられるコンテンツタイプ。

deserializationContentTypes?: DeserializationContentTypes

プロパティ値

DeserializationContentTypes

継承元 コアHttp.ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

HTTP 要求ごとにクライアント要求 ID ヘッダーを生成するかどうか。

generateClientRequestIdHeader?: boolean

プロパティ値

boolean

継承元 コアHttp.ServiceClientOptions.generateClientRequestIdHeader

httpClient

HTTP 要求の送信に使用される HttpClient。

httpClient?: HttpClient

プロパティ値

HttpClient

継承元コアHttp.ServiceClientOptions.httpClient

httpPipelineLogger

HTTP パイプライン内で RequestPolicies をデバッグするために使用できる HttpPipelineLogger。

httpPipelineLogger?: HttpPipelineLogger

プロパティ値

HttpPipelineLogger

継承元コアHttp.ServiceClientOptions.httpPipelineLogger

noRetryPolicy

true に設定されている場合は、既定の再試行ポリシーをオフにします。

noRetryPolicy?: boolean

プロパティ値

boolean

継承元コアHttp.ServiceClientOptions.noRetryPolicy

proxySettings

すべての HTTP 要求に使用されるプロキシ設定 (Node.jsのみ)。

proxySettings?: ProxySettings

プロパティ値

ProxySettings

継承元 コアHttp.ServiceClientOptions.proxySettings

requestPolicyFactories

ワイヤで HTTP 要求を送信するために使用される RequestPolicy パイプラインを作成するために呼び出されるファクトリの配列、または defaultRequestPolicyFactories を受け取って使用される requestPolicyFactories を返す関数。

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

プロパティ値

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

継承元 コアHttp.ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

AutomaticRPRegistration の再試行タイムアウトを秒単位で取得または設定します。 既定値は 30 です。

rpRegistrationRetryTimeout?: number

プロパティ値

number

継承元コアHttp.ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

要求の送信中にテレメトリ ヘッダーに設定される文字列、または既定のユーザー エージェント文字列を受け取り、使用されるユーザー エージェント文字列を返す関数。

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

プロパティ値

string | (defaultUserAgent: string) => string

継承元 コアHttp.ServiceClientOptions.userAgent

userAgentHeaderName

要求の送信時にテレメトリ ヘッダーに使用するヘッダー名。 これを指定しない場合は、Node.jsで実行するときに "User-Agent" が使用され、ブラウザーで実行するときに "x-ms-useragent" が使用されます。

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

プロパティ値

string | (defaultUserAgentHeaderName: string) => string

継承元 コアHttp.ServiceClientOptions.userAgentHeaderName

withCredentials

ブラウザーの CORS 要求に資格情報を含めるかどうか。 詳細については、「https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials」を参照してください。

withCredentials?: boolean

プロパティ値

boolean

継承元 コアHttp.ServiceClientOptions.withCredentials