IotHubClientOptionalParams interface

  • Referência
Pacote:
@azure/arm-iothub

Parâmetros opcionais.

Extends
ServiceClientOptions

Propriedades

$host

parâmetro do servidor
apiVersion

Versão da API
endpoint

Substitui o ponto de extremidade do cliente.

Propriedades herdadas

additionalPolicies

Políticas adicionais a serem incluídas no pipeline HTTP.
allowInsecureConnection

Defina como true se a solicitação for enviada por HTTP em vez de HTTPS
baseUri

Se especificado, esse é o URI base em que as solicitações serão feitas para esse ServiceClient. Se não for especificado, todas as OperationSpecs deverão conter uma propriedade baseUrl.
credential

Credencial usada para autenticar a solicitação.
credentialScopes

Se especificado, será usado para criar o BearerTokenAuthenticationPolicy.
httpClient

O HttpClient que será usado para enviar solicitações HTTP.
pipeline

Um pipeline personalizado a ser usado, caso contrário, um padrão será criado.
proxyOptions

Opções para configurar um proxy para solicitações de saída.
redirectOptions

Opções de como as respostas de redirecionamento são tratadas.
requestContentType

O tipo de conteúdo de solicitação padrão para o serviço. Usado se nenhum requestContentType estiver presente em um OperationSpec.
retryOptions

Opções que controlam como repetir solicitações com falha.
telemetryOptions

Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída.
tlsOptions

Opções para configurar a autenticação TLS
userAgentOptions

Opções para adicionar detalhes do agente de usuário a solicitações de saída.

Detalhes da propriedade

$host

parâmetro do servidor

$host?: string

Valor da propriedade

string

apiVersion

Versão da API

apiVersion?: string

Valor da propriedade

string

endpoint

Substitui o ponto de extremidade do cliente.

endpoint?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

additionalPolicies

Políticas adicionais a serem incluídas no pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor da propriedade

AdditionalPolicyConfig[]

Herdado de coreClient.ServiceClientOptions.additionalPolicies

allowInsecureConnection

Defina como true se a solicitação for enviada por HTTP em vez de HTTPS

allowInsecureConnection?: boolean

Valor da propriedade

boolean

Herdado de coreClient.ServiceClientOptions.allowInsecureConnection

baseUri

Aviso

Essa API foi preterida.

This property is deprecated and will be removed soon, please use endpoint instead

Se especificado, esse é o URI base em que as solicitações serão feitas para esse ServiceClient. Se não for especificado, todas as OperationSpecs deverão conter uma propriedade baseUrl.

baseUri?: string

Valor da propriedade

string

Herdado de coreClient.ServiceClientOptions.baseUri

credential

Credencial usada para autenticar a solicitação.

credential?: TokenCredential

Valor da propriedade

TokenCredential

Herdado de coreClient.ServiceClientOptions.credential

credentialScopes

Se especificado, será usado para criar o BearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

Valor da propriedade

string | string[]

Herdado de coreClient.ServiceClientOptions.credentialScopes

httpClient

O HttpClient que será usado para enviar solicitações HTTP.

httpClient?: HttpClient

Valor da propriedade

HttpClient

Herdado de coreClient.ServiceClientOptions.httpClient

pipeline

Um pipeline personalizado a ser usado, caso contrário, um padrão será criado.

pipeline?: Pipeline

Valor da propriedade

Pipeline

Herdado de coreClient.ServiceClientOptions.pipeline

proxyOptions

Opções para configurar um proxy para solicitações de saída.

proxyOptions?: ProxySettings

Valor da propriedade

ProxySettings

Herdado de coreClient.ServiceClientOptions.proxyOptions

redirectOptions

Opções de como as respostas de redirecionamento são tratadas.

redirectOptions?: RedirectPolicyOptions

Valor da propriedade

RedirectPolicyOptions

Herdado de coreClient.ServiceClientOptions.redirectOptions

requestContentType

O tipo de conteúdo de solicitação padrão para o serviço. Usado se nenhum requestContentType estiver presente em um OperationSpec.

requestContentType?: string

Valor da propriedade

string

Herdado de coreClient.ServiceClientOptions.requestContentType

retryOptions

Opções que controlam como repetir solicitações com falha.

retryOptions?: PipelineRetryOptions

Valor da propriedade

PipelineRetryOptions

Herdado de coreClient.ServiceClientOptions.retryOptions

telemetryOptions

Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída.

telemetryOptions?: TelemetryOptions

Valor da propriedade

TelemetryOptions

Herdado de coreClient.ServiceClientOptions.telemetryOptions

tlsOptions

Opções para configurar a autenticação TLS

tlsOptions?: TlsSettings

Valor da propriedade

TlsSettings

Herdado de coreClient.ServiceClientOptions.tlsOptions

userAgentOptions

Opções para adicionar detalhes do agente de usuário a solicitações de saída.

userAgentOptions?: UserAgentPolicyOptions

Valor da propriedade

UserAgentPolicyOptions

Herdado de coreClient.ServiceClientOptions.userAgentOptions