Compartilhar via


ServiceClientOptions interface

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

Extends

Propriedades

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.

endpoint

Se especificado, esse é o ponto de extremidade 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. para incentivar o cliente a usar o ponto de extremidade, marcamos o baseUri como preterido.

pipeline

Um pipeline personalizado a ser usado, 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 de usuário a solicitações de saída.

Detalhes da propriedade

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

credential

Credencial usada para autenticar a solicitação.

credential?: TokenCredential

Valor da propriedade

credentialScopes

Se especificado, será usado para criar o BearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

Valor da propriedade

string | string[]

endpoint

Se especificado, esse é o ponto de extremidade 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. para incentivar o cliente a usar o ponto de extremidade, marcamos o baseUri como preterido.

endpoint?: string

Valor da propriedade

string

pipeline

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

pipeline?: Pipeline

Valor da 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 da propriedade

string

Detalhes das propriedades herdadas

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Valor da propriedade

Herdado deCommonClientOptions.additionalPolicies

allowInsecureConnection

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

allowInsecureConnection?: boolean

Valor da propriedade

boolean

Herdado deCommonClientOptions.allowInsecureConnection

httpClient

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

httpClient?: HttpClient

Valor da propriedade

Herdado deCommonClientOptions.httpClient

proxyOptions

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

proxyOptions?: ProxySettings

Valor da propriedade

Herdado deCommonClientOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

Valor da propriedade

Herdado deCommonClientOptions.redirectOptions

retryOptions

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

retryOptions?: PipelineRetryOptions

Valor da 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 da propriedade

Herdado deCommonClientOptions.telemetryOptions

tlsOptions

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

tlsOptions?: TlsSettings

Valor da propriedade

Herdado deCommonClientOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Valor da propriedade

Herdado deCommonClientOptions.userAgentOptions