Partilhar via


ServiceClientOptions interface

Opções a serem fornecidas durante a criação do cliente.

Extends

Propriedades

baseUri

Se especificado, este é o URI base contra o qual as solicitações serão feitas para este ServiceClient. Se não for especificado, todos os OperationSpecs devem conter uma propriedade baseUrl.

credential

Credencial usada para autenticar a solicitação.

credentialScopes

Se especificado, será usado para criar o BearerTokenAuthenticationPolicy.

endpoint

Se especificado, este é o ponto de extremidade contra o qual as solicitações serão feitas para este ServiceClient. Se não for especificado, todos os OperationSpecs devem conter uma propriedade baseUrl. para incentivar o cliente a usar o endpoint, marcamos o baseUri como obsoleto.

pipeline

Um pipeline personalizado para usar, caso contrário, um padrão será criado.

requestContentType

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

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

httpClient

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

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.

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 do usuário às solicitações de saída.

Detalhes de Propriedade

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 contra o qual as solicitações serão feitas para este ServiceClient. Se não for especificado, todos os OperationSpecs devem conter uma propriedade baseUrl.

baseUri?: string

Valor de Propriedade

string

credential

Credencial usada para autenticar a solicitação.

credential?: TokenCredential

Valor de Propriedade

credentialScopes

Se especificado, será usado para criar o BearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

Valor de Propriedade

string | string[]

endpoint

Se especificado, este é o ponto de extremidade contra o qual as solicitações serão feitas para este ServiceClient. Se não for especificado, todos os OperationSpecs devem conter uma propriedade baseUrl. para incentivar o cliente a usar o endpoint, marcamos o baseUri como obsoleto.

endpoint?: string

Valor de Propriedade

string

pipeline

Um pipeline personalizado para usar, caso contrário, um padrão será criado.

pipeline?: Pipeline

Valor de Propriedade

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 de Propriedade

string

Detalhes da Propriedade Herdada

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Valor de Propriedade

herdado deCommonClientOptions.additionalPolicies

allowInsecureConnection

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

allowInsecureConnection?: boolean

Valor de Propriedade

boolean

herdado de CommonClientOptions.allowInsecureConnection

httpClient

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

httpClient?: HttpClient

Valor de Propriedade

herdado deCommonClientOptions.httpClient

proxyOptions

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

proxyOptions?: ProxySettings

Valor de Propriedade

herdado deCommonClientOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

Valor de Propriedade

herdado deCommonClientOptions.redirectOptions

retryOptions

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

retryOptions?: PipelineRetryOptions

Valor de Propriedade

herdado deCommonClientOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Valor de Propriedade

herdado deCommonClientOptions.telemetryOptions

tlsOptions

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

tlsOptions?: TlsSettings

Valor de Propriedade

herdado de CommonClientOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Valor de Propriedade

herdado de CommonClientOptions.userAgentOptions