DeviceUpdateClientOptionalParams interface

Paquet:

@azure/iot-device-update

Paramètres facultatifs.

Extends

ServiceClientOptions

Propriétés

endpoint

Remplace le point de terminaison du client.

Propriétés héritées

clientRequestIdHeaderName	Si elle est spécifiée, une instruction GenerateRequestIdPolicy est ajoutée au pipeline HTTP qui ajoute un en-tête à toutes les requêtes sortantes avec ce nom d’en-tête et un UUID aléatoire comme ID de requête.
credentialScopes	S’il est spécifié, est utilisé pour générer bearerTokenAuthenticationPolicy.
deserializationContentTypes	Types de contenu qui seront associés à la sérialisation JSON ou XML.
generateClientRequestIdHeader	Indique s’il faut ou non générer un en-tête d’ID de requête client pour chaque requête HTTP.
httpClient	HttpClient qui sera utilisé pour envoyer des requêtes HTTP.
httpPipelineLogger	HttpPipelineLogger qui peut être utilisé pour déboguer RequestPolicies dans le pipeline HTTP.
noRetryPolicy	Si la valeur est true, désactivez la stratégie de nouvelle tentative par défaut.
proxySettings	Paramètres de proxy qui seront utilisés pour chaque requête HTTP (Node.js uniquement).
requestPolicyFactories	Tableau de fabriques appelées pour créer le pipeline RequestPolicy utilisé pour envoyer une requête HTTP sur le réseau, ou une fonction qui accepte le defaultRequestPolicyFactories et retourne le requestPolicyFactories qui sera utilisé.
rpRegistrationRetryTimeout	Obtient ou définit le délai d’expiration de nouvelle tentative en secondes pour AutomaticRPRegistration. La valeur par défaut est 30.
userAgent	Chaîne à définir sur l’en-tête de télémétrie lors de l’envoi de la demande, ou une fonction qui accepte la chaîne user-agent par défaut et retourne la chaîne user-agent qui sera utilisée.
userAgentHeaderName	Nom d’en-tête à utiliser pour l’en-tête de télémétrie lors de l’envoi de la demande. Si ce n’est pas spécifié, « User-Agent » est utilisé lors de l’exécution sur Node.js et « x-ms-useragent » est utilisé lors de l’exécution dans un navigateur.
withCredentials	Indique s’il faut inclure des informations d’identification dans les demandes CORS dans le navigateur. Consultez la rubrique https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials (éventuellement en anglais) pour plus d'informations.

Détails de la propriété

endpoint

Remplace le point de terminaison du client.

endpoint?: string

Valeur de propriété

string

Détails de la propriété héritée

clientRequestIdHeaderName

Si elle est spécifiée, une instruction GenerateRequestIdPolicy est ajoutée au pipeline HTTP qui ajoute un en-tête à toutes les requêtes sortantes avec ce nom d’en-tête et un UUID aléatoire comme ID de requête.

clientRequestIdHeaderName?: string

Valeur de propriété

string

Hérité de coreHttp.ServiceClientOptions.clientRequestIdHeaderName

credentialScopes

S’il est spécifié, est utilisé pour générer bearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

Valeur de propriété

string | string[]

Hérité de coreHttp.ServiceClientOptions.credentialScopes

deserializationContentTypes

Types de contenu qui seront associés à la sérialisation JSON ou XML.

deserializationContentTypes?: DeserializationContentTypes

Valeur de propriété

DeserializationContentTypes

Hérité de coreHttp.ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Indique s’il faut ou non générer un en-tête d’ID de requête client pour chaque requête HTTP.

generateClientRequestIdHeader?: boolean

Valeur de propriété

boolean

Hérité de coreHttp.ServiceClientOptions.generateClientRequestIdHeader

httpClient

HttpClient qui sera utilisé pour envoyer des requêtes HTTP.

httpClient?: HttpClient

Valeur de propriété

HttpClient

Hérité de coreHttp.ServiceClientOptions.httpClient

httpPipelineLogger

HttpPipelineLogger qui peut être utilisé pour déboguer RequestPolicies dans le pipeline HTTP.

httpPipelineLogger?: HttpPipelineLogger

Valeur de propriété

HttpPipelineLogger

Hérité de coreHttp.ServiceClientOptions.httpPipelineLogger

noRetryPolicy

Si la valeur est true, désactivez la stratégie de nouvelle tentative par défaut.

noRetryPolicy?: boolean

Valeur de propriété

boolean

Hérité de coreHttp.ServiceClientOptions.noRetryPolicy

proxySettings

Paramètres de proxy qui seront utilisés pour chaque requête HTTP (Node.js uniquement).

proxySettings?: ProxySettings

Valeur de propriété

ProxySettings

Hérité de coreHttp.ServiceClientOptions.proxySettings

requestPolicyFactories

Tableau de fabriques appelées pour créer le pipeline RequestPolicy utilisé pour envoyer une requête HTTP sur le réseau, ou une fonction qui accepte le defaultRequestPolicyFactories et retourne le requestPolicyFactories qui sera utilisé.

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

Valeur de propriété

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

Hérité de coreHttp.ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Obtient ou définit le délai d’expiration de nouvelle tentative en secondes pour AutomaticRPRegistration. La valeur par défaut est 30.

rpRegistrationRetryTimeout?: number

Valeur de propriété

number

Hérité de coreHttp.ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

Chaîne à définir sur l’en-tête de télémétrie lors de l’envoi de la demande, ou une fonction qui accepte la chaîne user-agent par défaut et retourne la chaîne user-agent qui sera utilisée.

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

Valeur de propriété

string | (defaultUserAgent: string) => string

Hérité de coreHttp.ServiceClientOptions.userAgent

userAgentHeaderName

Nom d’en-tête à utiliser pour l’en-tête de télémétrie lors de l’envoi de la demande. Si ce n’est pas spécifié, « User-Agent » est utilisé lors de l’exécution sur Node.js et « x-ms-useragent » est utilisé lors de l’exécution dans un navigateur.

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

Valeur de propriété

string | (defaultUserAgentHeaderName: string) => string

Hérité de coreHttp.ServiceClientOptions.userAgentHeaderName

withCredentials

Indique s’il faut inclure des informations d’identification dans les demandes CORS dans le navigateur. Consultez la rubrique https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials (éventuellement en anglais) pour plus d'informations.

withCredentials?: boolean

Valeur de propriété

boolean

Hérité de coreHttp.ServiceClientOptions.withCredentials