DeviceUpdateClientOptionalParams interface

Paket:

@azure/iot-device-update

Optionale Parameter.

Extends

ServiceClientOptions

Eigenschaften

endpoint

Überschreibt den Clientendpunkt.

Geerbte Eigenschaften

clientRequestIdHeaderName	Wenn angegeben, wird der HTTP-Pipeline eine GenerateRequestIdPolicy hinzugefügt, die allen ausgehenden Anforderungen einen Header mit diesem Headernamen und einer zufälligen UUID als Anforderungs-ID hinzufügt.
credentialScopes	Falls angegeben, wird zum Erstellen der BearerTokenAuthenticationPolicy verwendet.
deserializationContentTypes	Die Inhaltstypen, die der JSON- oder XML-Serialisierung zugeordnet werden.
generateClientRequestIdHeader	Gibt an, ob ein Clientanforderungs-ID-Header für jede HTTP-Anforderung generiert werden soll.
httpClient	Der HttpClient, der zum Senden von HTTP-Anforderungen verwendet wird.
httpPipelineLogger	Der HttpPipelineLogger, der zum Debuggen von RequestPolicies innerhalb der HTTP-Pipeline verwendet werden kann.
noRetryPolicy	Wenn auf "true" festgelegt ist, deaktivieren Sie die Standard-Wiederholungsrichtlinie.
proxySettings	Proxyeinstellungen, die für jede HTTP-Anforderung verwendet werden (nur Node.js).
requestPolicyFactories	Ein Array von Fabriken, die aufgerufen werden, um die RequestPolicy-Pipeline zu erstellen, die zum Senden einer HTTP-Anforderung über die Verbindung verwendet wird, oder eine Funktion, die die defaultRequestPolicyFactories übernimmt und die verwendete requestPolicyFactories zurückgibt.
rpRegistrationRetryTimeout	Ruft das Wiederholungstimeout in Sekunden für AutomaticRPRegistration ab oder legt es fest. Standardwert: 30.
userAgent	Die Zeichenfolge, die beim Senden der Anforderung auf den Telemetrieheader festgelegt werden soll, oder eine Funktion, die die Standardzeichenfolge des Benutzer-Agents übernimmt und die verwendete Benutzer-Agent-Zeichenfolge zurückgibt.
userAgentHeaderName	Der Headername, der beim Senden der Anforderung für den Telemetrieheader verwendet werden soll. Wenn dies nicht angegeben ist, wird "User-Agent" verwendet, wenn auf Node.js ausgeführt wird, und "x-ms-useragent" wird bei der Ausführung in einem Browser verwendet.
withCredentials	Gibt an, ob Anmeldeinformationen in CORS-Anforderungen im Browser eingeschlossen werden sollen. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

Details zur Eigenschaft

endpoint

Überschreibt den Clientendpunkt.

endpoint?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

clientRequestIdHeaderName

Wenn angegeben, wird der HTTP-Pipeline eine GenerateRequestIdPolicy hinzugefügt, die allen ausgehenden Anforderungen einen Header mit diesem Headernamen und einer zufälligen UUID als Anforderungs-ID hinzufügt.

clientRequestIdHeaderName?: string

Eigenschaftswert

string

Geerbt von coreHttp.ServiceClientOptions.clientRequestIdHeaderName

credentialScopes

Falls angegeben, wird zum Erstellen der BearerTokenAuthenticationPolicy verwendet.

credentialScopes?: string | string[]

Eigenschaftswert

string | string[]

Geerbt von coreHttp.ServiceClientOptions.credentialScopes

deserializationContentTypes

Die Inhaltstypen, die der JSON- oder XML-Serialisierung zugeordnet werden.

deserializationContentTypes?: DeserializationContentTypes

Eigenschaftswert

DeserializationContentTypes

Geerbt von coreHttp.ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Gibt an, ob ein Clientanforderungs-ID-Header für jede HTTP-Anforderung generiert werden soll.

generateClientRequestIdHeader?: boolean

Eigenschaftswert

boolean

Geerbt von coreHttp.ServiceClientOptions.generateClientRequestIdHeader

httpClient

Der HttpClient, der zum Senden von HTTP-Anforderungen verwendet wird.

httpClient?: HttpClient

Eigenschaftswert

HttpClient

Geerbt von coreHttp.ServiceClientOptions.httpClient

httpPipelineLogger

Der HttpPipelineLogger, der zum Debuggen von RequestPolicies innerhalb der HTTP-Pipeline verwendet werden kann.

httpPipelineLogger?: HttpPipelineLogger

Eigenschaftswert

HttpPipelineLogger

Geerbt von coreHttp.ServiceClientOptions.httpPipelineLogger

noRetryPolicy

Wenn auf "true" festgelegt ist, deaktivieren Sie die Standard-Wiederholungsrichtlinie.

noRetryPolicy?: boolean

Eigenschaftswert

boolean

Geerbt von coreHttp.ServiceClientOptions.noRetryPolicy

proxySettings

Proxyeinstellungen, die für jede HTTP-Anforderung verwendet werden (nur Node.js).

proxySettings?: ProxySettings

Eigenschaftswert

ProxySettings

Geerbt von coreHttp.ServiceClientOptions.proxySettings

requestPolicyFactories

Ein Array von Fabriken, die aufgerufen werden, um die RequestPolicy-Pipeline zu erstellen, die zum Senden einer HTTP-Anforderung über die Verbindung verwendet wird, oder eine Funktion, die die defaultRequestPolicyFactories übernimmt und die verwendete requestPolicyFactories zurückgibt.

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

Eigenschaftswert

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

Geerbt von coreHttp.ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Ruft das Wiederholungstimeout in Sekunden für AutomaticRPRegistration ab oder legt es fest. Standardwert: 30.

rpRegistrationRetryTimeout?: number

Eigenschaftswert

number

Geerbt von coreHttp.ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

Die Zeichenfolge, die beim Senden der Anforderung auf den Telemetrieheader festgelegt werden soll, oder eine Funktion, die die Standardzeichenfolge des Benutzer-Agents übernimmt und die verwendete Benutzer-Agent-Zeichenfolge zurückgibt.

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

Eigenschaftswert

string | (defaultUserAgent: string) => string

Geerbt von coreHttp.ServiceClientOptions.userAgent

userAgentHeaderName

Der Headername, der beim Senden der Anforderung für den Telemetrieheader verwendet werden soll. Wenn dies nicht angegeben ist, wird "User-Agent" verwendet, wenn auf Node.js ausgeführt wird, und "x-ms-useragent" wird bei der Ausführung in einem Browser verwendet.

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

Eigenschaftswert

string | (defaultUserAgentHeaderName: string) => string

Geerbt von coreHttp.ServiceClientOptions.userAgentHeaderName

withCredentials

Gibt an, ob Anmeldeinformationen in CORS-Anforderungen im Browser eingeschlossen werden sollen. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Eigenschaftswert

boolean

Geerbt von coreHttp.ServiceClientOptions.withCredentials