IotHubClientOptionalParams interface
Parâmetros opcionais.
- Extends
Propriedades
$host | parâmetro do servidor |
api |
A versão da API |
endpoint | Substitui o ponto final do cliente. |
Propriedades Herdadas
additional |
Políticas adicionais a incluir no pipeline HTTP. |
allow |
Definir como verdadeiro se o pedido for enviado através de HTTP em vez de HTTPS |
base |
Se especificado, este é o URI base para o qual os pedidos serão feitos para este ServiceClient. Se não for especificado, todos os OperationSpecs têm de conter uma propriedade baseUrl. |
credential | Credencial utilizada para autenticar o pedido. |
credential |
Se especificado, será utilizado para criar o BearerTokenAuthenticationPolicy. |
http |
O HttpClient que será utilizado para enviar pedidos HTTP. |
pipeline | Um pipeline personalizado para utilizar, caso contrário, será criado um pipeline predefinido. |
proxy |
Opções para configurar um proxy para pedidos de saída. |
redirect |
Opções para a forma como as respostas de redirecionamento são processadas. |
request |
O tipo de conteúdo de pedido predefinido para o serviço. Utilizado se não existir nenhum requestContentType numa OperationSpec. |
retry |
Opções que controlam como repetir pedidos falhados. |
telemetry |
Opções para definir informações comuns de telemetria e rastreio para pedidos enviados. |
tls |
Opções para configurar a autenticação TLS |
user |
Opções para adicionar detalhes do agente de utilizador aos pedidos de saída. |
Detalhes de Propriedade
$host
parâmetro do servidor
$host?: string
Valor de Propriedade
string
apiVersion
A versão da API
apiVersion?: string
Valor de Propriedade
string
endpoint
Substitui o ponto final do cliente.
endpoint?: string
Valor de Propriedade
string
Detalhes da Propriedade Herdada
additionalPolicies
Políticas adicionais a incluir no pipeline HTTP.
additionalPolicies?: AdditionalPolicyConfig[]
Valor de Propriedade
Herdado de coreClient.ServiceClientOptions.additionalPolicies
allowInsecureConnection
Definir como verdadeiro se o pedido for enviado através de HTTP em vez de HTTPS
allowInsecureConnection?: boolean
Valor de Propriedade
boolean
Herdado de coreClient.ServiceClientOptions.allowInsecureConnection
baseUri
Aviso
Esta API foi preterida.
This property is deprecated and will be removed soon, please use endpoint instead
Se especificado, este é o URI base para o qual os pedidos serão feitos para este ServiceClient. Se não for especificado, todos os OperationSpecs têm de conter uma propriedade baseUrl.
baseUri?: string
Valor de Propriedade
string
Herdado de coreClient.ServiceClientOptions.baseUri
credential
Credencial utilizada para autenticar o pedido.
credential?: TokenCredential
Valor de Propriedade
Herdado de coreClient.ServiceClientOptions.credential
credentialScopes
Se especificado, será utilizado para criar o BearerTokenAuthenticationPolicy.
credentialScopes?: string | string[]
Valor de Propriedade
string | string[]
Herdado de coreClient.ServiceClientOptions.credentialScopes
httpClient
O HttpClient que será utilizado para enviar pedidos HTTP.
httpClient?: HttpClient
Valor de Propriedade
Herdado de coreClient.ServiceClientOptions.httpClient
pipeline
Um pipeline personalizado para utilizar, caso contrário, será criado um pipeline predefinido.
pipeline?: Pipeline
Valor de Propriedade
Herdado de coreClient.ServiceClientOptions.pipeline
proxyOptions
Opções para configurar um proxy para pedidos de saída.
proxyOptions?: ProxySettings
Valor de Propriedade
Herdado de coreClient.ServiceClientOptions.proxyOptions
redirectOptions
Opções para a forma como as respostas de redirecionamento são processadas.
redirectOptions?: RedirectPolicyOptions
Valor de Propriedade
Herdado de coreClient.ServiceClientOptions.redirectOptions
requestContentType
O tipo de conteúdo de pedido predefinido para o serviço. Utilizado se não existir nenhum requestContentType numa OperationSpec.
requestContentType?: string
Valor de Propriedade
string
Herdado de coreClient.ServiceClientOptions.requestContentType
retryOptions
Opções que controlam como repetir pedidos falhados.
retryOptions?: PipelineRetryOptions
Valor de Propriedade
Herdado de coreClient.ServiceClientOptions.retryOptions
telemetryOptions
Opções para definir informações comuns de telemetria e rastreio para pedidos enviados.
telemetryOptions?: TelemetryOptions
Valor de Propriedade
Herdado de coreClient.ServiceClientOptions.telemetryOptions
tlsOptions
Opções para configurar a autenticação TLS
tlsOptions?: TlsSettings
Valor de Propriedade
Herdado de coreClient.ServiceClientOptions.tlsOptions
userAgentOptions
Opções para adicionar detalhes do agente de utilizador aos pedidos de saída.
userAgentOptions?: UserAgentPolicyOptions
Valor de Propriedade
Herdado de coreClient.ServiceClientOptions.userAgentOptions