ServiceClientOptions interface

Pacote:

@azure/ms-rest-js

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

Propriedades

agentSettings	Agentes HTTP e HTTPS que serão usados para cada solicitação HTTP (somente Node.js).
baseUri	Se especificado: Isso baseUri se torna o URI base em que as solicitações serão feitas para esse ServiceClient. Se o corresponder a baseUri um ponto de extremidade conhecido do gerenciador de recursos e se um TokenCredential tiver sido passado pelo construtor, isso baseUri definirá o getToken escopo como ${options.baseUri}/.default. Caso contrário, o escopo seria padrão para "https://management.azure.com/.default". Se não for especificado: Todas as OperationSpecs devem conter uma propriedade baseUrl. Se um TokenCredential tiver sido passado pelo construtor, o getToken escopo será definido como "https://management.azure.com/.default".
clientRequestIdHeaderName	Se especificado, um GenerateRequestIdPolicy será adicionado ao pipeline HTTP que adicionará um cabeçalho a todas as solicitações de saída com esse nome de cabeçalho e uma UUID aleatória como a ID da solicitação.
deserializationContentTypes	Os tipos de conteúdo que serão associados à serialização JSON ou XML.
generateClientRequestIdHeader	Se deve ou não gerar um cabeçalho de ID de solicitação de cliente para cada solicitação HTTP.
httpClient	O HttpClient que será usado para enviar solicitações HTTP.
httpPipelineLogger	O HttpPipelineLogger que pode ser usado para depurar RequestPolicies no pipeline HTTP.
noRetryPolicy	Se definido como true, desative a política de repetição padrão.
proxySettings	Configurações de proxy que serão usadas para cada solicitação HTTP (somente Node.js).
redirectOptions	Opções de como as respostas de redirecionamento são tratadas.
requestPolicyFactories	Uma matriz de fábricas que são chamadas para criar o pipeline RequestPolicy usado para enviar uma solicitação HTTP na transmissão ou uma função que usa defaultRequestPolicyFactories e retorna o requestPolicyFactories que será usado.
rpRegistrationRetryTimeout	Obtém ou define o tempo limite de repetição em segundos para AutomaticRPRegistration. O valor padrão é 30.
userAgent	A cadeia de caracteres a ser definida como o cabeçalho de telemetria ao enviar a solicitação ou uma função que usa a cadeia de caracteres padrão user-agent e retorna a cadeia de caracteres usuário-agente que será usada.
userAgentHeaderName	O nome do cabeçalho a ser usado para o cabeçalho de telemetria ao enviar a solicitação. Se isso não for especificado, "User-Agent" será usado ao executar em Node.js e "x-ms-command-name" será usado ao executar em um navegador.
withCredentials	Se deve incluir credenciais em solicitações CORS no navegador. Consulte https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials para obter mais informações.

Detalhes da propriedade

agentSettings

Agentes HTTP e HTTPS que serão usados para cada solicitação HTTP (somente Node.js).

agentSettings?: AgentSettings

Valor da propriedade

AgentSettings

baseUri

Se especificado:

• Isso baseUri se torna o URI base em que as solicitações serão feitas para esse ServiceClient.
• Se o corresponder a baseUri um ponto de extremidade conhecido do gerenciador de recursos e se um TokenCredential tiver sido passado pelo construtor, isso baseUri definirá o getToken escopo como ${options.baseUri}/.default. Caso contrário, o escopo seria padrão para "https://management.azure.com/.default".

Se não for especificado:

• Todas as OperationSpecs devem conter uma propriedade baseUrl.
• Se um TokenCredential tiver sido passado pelo construtor, o getToken escopo será definido como "https://management.azure.com/.default".

baseUri?: string

Valor da propriedade

string

clientRequestIdHeaderName

Se especificado, um GenerateRequestIdPolicy será adicionado ao pipeline HTTP que adicionará um cabeçalho a todas as solicitações de saída com esse nome de cabeçalho e uma UUID aleatória como a ID da solicitação.

clientRequestIdHeaderName?: string

Valor da propriedade

string

deserializationContentTypes

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

deserializationContentTypes?: DeserializationContentTypes

Valor da propriedade

DeserializationContentTypes

generateClientRequestIdHeader

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

generateClientRequestIdHeader?: boolean

Valor da propriedade

boolean

httpClient

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

httpClient?: HttpClient

Valor da propriedade

HttpClient

httpPipelineLogger

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

httpPipelineLogger?: HttpPipelineLogger

Valor da propriedade

HttpPipelineLogger

noRetryPolicy

Se definido como true, desative a política de repetição padrão.

noRetryPolicy?: boolean

Valor da propriedade

boolean

proxySettings

Configurações de proxy que serão usadas para cada solicitação HTTP (somente Node.js).

proxySettings?: ProxySettings

Valor da propriedade

ProxySettings

redirectOptions

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

redirectOptions?: RedirectOptions

Valor da propriedade

RedirectOptions

requestPolicyFactories

Uma matriz de fábricas que são chamadas para criar o pipeline RequestPolicy usado para enviar uma solicitação HTTP na transmissão ou uma função que usa defaultRequestPolicyFactories e retorna o requestPolicyFactories que será usado.

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

Valor da propriedade

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

rpRegistrationRetryTimeout

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

rpRegistrationRetryTimeout?: number

Valor da propriedade

number

userAgent

A cadeia de caracteres a ser definida como o cabeçalho de telemetria ao enviar a solicitação ou uma função que usa a cadeia de caracteres padrão user-agent e retorna a cadeia de caracteres usuário-agente que será usada.

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

Valor da propriedade

string | (defaultUserAgent: string) => string

userAgentHeaderName

O nome do cabeçalho a ser usado para o cabeçalho de telemetria ao enviar a solicitação. Se isso não for especificado, "User-Agent" será usado ao executar em Node.js e "x-ms-command-name" será usado ao executar em um navegador.

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

Valor da propriedade

string | (defaultUserAgentHeaderName: string) => string

withCredentials

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

withCredentials?: boolean

Valor da propriedade

boolean