DeviceUpdateClientOptionalParams interface

Pacote:

@azure/iot-device-update

Parâmetros opcionais.

Extends

ServiceClientOptions

Propriedades

endpoint

Substitui o ponto final do cliente.

Propriedades Herdadas

clientRequestIdHeaderName	Se for especificado, será adicionado um GenerateRequestIdPolicy ao pipeline HTTP que irá adicionar um cabeçalho a todos os pedidos de saída com este nome de cabeçalho e um UUID aleatório como O ID do pedido.
credentialScopes	Se especificado, será utilizado para criar o BearerTokenAuthenticationPolicy.
deserializationContentTypes	Os tipos de conteúdo que serão associados à serialização JSON ou XML.
generateClientRequestIdHeader	Se pretende ou não gerar um cabeçalho de ID de pedido de cliente para cada pedido HTTP.
httpClient	O HttpClient que será utilizado para enviar pedidos HTTP.
httpPipelineLogger	O HttpPipelineLogger que pode ser utilizado para depurar RequestPolicies no pipeline HTTP.
noRetryPolicy	Se estiver definido como verdadeiro, desative a política de repetição predefinida.
proxySettings	Definições de proxy que serão utilizadas para cada pedido HTTP (apenas Node.js).
requestPolicyFactories	Uma matriz de fábricas que são chamadas para criar o pipeline RequestPolicy utilizado para enviar um pedido HTTP no fio ou uma função que recebe o defaultRequestPolicyFactories e devolve o requestPolicyFactories que será utilizado.
rpRegistrationRetryTimeout	Obtém ou define o tempo limite de repetição em segundos para AutomaticRPRegistration. O valor predefinido é 30.
userAgent	A cadeia a ser definida para o cabeçalho de telemetria ao enviar o pedido ou uma função que utiliza a cadeia de agente de utilizador predefinida e devolve a cadeia de carateres user-agent que será utilizada.
userAgentHeaderName	O nome do cabeçalho a utilizar para o cabeçalho de telemetria ao enviar o pedido. Se isto não for especificado, será utilizado "User-Agent" quando for executado no Node.js e "x-ms-useragent" será utilizado ao executar num browser.
withCredentials	Se pretende incluir credenciais em pedidos CORS no browser. Consulte https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials para obter mais informações.

Detalhes de Propriedade

endpoint

Substitui o ponto final do cliente.

endpoint?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

clientRequestIdHeaderName

Se for especificado, será adicionado um GenerateRequestIdPolicy ao pipeline HTTP que irá adicionar um cabeçalho a todos os pedidos de saída com este nome de cabeçalho e um UUID aleatório como O ID do pedido.

clientRequestIdHeaderName?: string

Valor de Propriedade

string

Herdado de coreHttp.ServiceClientOptions.clientRequestIdHeaderName

credentialScopes

Se especificado, será utilizado para criar o BearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

Valor de Propriedade

string | string[]

Herdado de coreHttp.ServiceClientOptions.credentialScopes

deserializationContentTypes

Os tipos de conteúdo que serão associados à serialização JSON ou XML.

deserializationContentTypes?: DeserializationContentTypes

Valor de Propriedade

DeserializationContentTypes

Herdado de coreHttp.ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Se pretende ou não gerar um cabeçalho de ID de pedido de cliente para cada pedido HTTP.

generateClientRequestIdHeader?: boolean

Valor de Propriedade

boolean

Herdado de coreHttp.ServiceClientOptions.generateClientRequestIdHeader

httpClient

O HttpClient que será utilizado para enviar pedidos HTTP.

httpClient?: HttpClient

Valor de Propriedade

HttpClient

Herdado de coreHttp.ServiceClientOptions.httpClient

httpPipelineLogger

O HttpPipelineLogger que pode ser utilizado para depurar RequestPolicies no pipeline HTTP.

httpPipelineLogger?: HttpPipelineLogger

Valor de Propriedade

HttpPipelineLogger

Herdado de coreHttp.ServiceClientOptions.httpPipelineLogger

noRetryPolicy

Se estiver definido como verdadeiro, desative a política de repetição predefinida.

noRetryPolicy?: boolean

Valor de Propriedade

boolean

Herdado de coreHttp.ServiceClientOptions.noRetryPolicy

proxySettings

Definições de proxy que serão utilizadas para cada pedido HTTP (apenas Node.js).

proxySettings?: ProxySettings

Valor de Propriedade

ProxySettings

Herdado de coreHttp.ServiceClientOptions.proxySettings

requestPolicyFactories

Uma matriz de fábricas que são chamadas para criar o pipeline RequestPolicy utilizado para enviar um pedido HTTP no fio ou uma função que recebe o defaultRequestPolicyFactories e devolve o requestPolicyFactories que será utilizado.

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

Valor de Propriedade

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

Herdado de coreHttp.ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Obtém ou define o tempo limite de repetição em segundos para AutomaticRPRegistration. O valor predefinido é 30.

rpRegistrationRetryTimeout?: number

Valor de Propriedade

number

Herdado de coreHttp.ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

A cadeia a ser definida para o cabeçalho de telemetria ao enviar o pedido ou uma função que utiliza a cadeia de agente de utilizador predefinida e devolve a cadeia de carateres user-agent que será utilizada.

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

Valor de Propriedade

string | (defaultUserAgent: string) => string

Herdado de coreHttp.ServiceClientOptions.userAgent

userAgentHeaderName

O nome do cabeçalho a utilizar para o cabeçalho de telemetria ao enviar o pedido. Se isto não for especificado, será utilizado "User-Agent" quando for executado no Node.js e "x-ms-useragent" será utilizado ao executar num browser.

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

Valor de Propriedade

string | (defaultUserAgentHeaderName: string) => string

Herdado de coreHttp.ServiceClientOptions.userAgentHeaderName

withCredentials

Se pretende incluir credenciais em pedidos CORS no browser. Consulte https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials para obter mais informações.

withCredentials?: boolean

Valor de Propriedade

boolean

Herdado de coreHttp.ServiceClientOptions.withCredentials