ServiceClientOptions interface

Pacote:

@azure/ms-rest-js

Opções a fornecer ao criar o cliente.

Propriedades

agentSettings	Agentes HTTP e HTTPS que serão utilizados para cada pedido HTTP (apenas Node.js).
baseUri	Se especificado: Isto baseUri torna-se o URI base para o qual os pedidos serão feitos para este ServiceClient. Se corresponder a baseUri um ponto final conhecido do resource manager e se um TokenCredential tiver sido transmitido através do construtor, isto baseUri define o getToken âmbito como ${options.baseUri}/.default. Caso contrário, o âmbito seria predefinido como "https://management.azure.com/.default". Se não for especificado: Todos os OperationSpecs têm de conter uma propriedade baseUrl. Se um TokenCredential tiver sido transmitido através do construtor, o getToken âmbito será definido como "https://management.azure.com/.default".
clientRequestIdHeaderName	Se for especificado, será adicionado um GenerateRequestIdPolicy ao pipeline HTTP que irá adicionar um cabeçalho a todos os pedidos de saída com este nome de cabeçalho e um UUID aleatório como O ID do pedido.
deserializationContentTypes	Os tipos de conteúdo que serão associados à serialização JSON ou XML.
generateClientRequestIdHeader	Se pretende ou não gerar um cabeçalho de ID de pedido de cliente para cada pedido HTTP.
httpClient	O HttpClient que será utilizado para enviar pedidos HTTP.
httpPipelineLogger	O HttpPipelineLogger que pode ser utilizado para depurar RequestPolicies no pipeline HTTP.
noRetryPolicy	Se estiver definido como verdadeiro, desative a política de repetição predefinida.
proxySettings	Definições de proxy que serão utilizadas para cada pedido HTTP (apenas Node.js).
redirectOptions	Opções para a forma como as respostas de redirecionamento são processadas.
requestPolicyFactories	Uma matriz de fábricas que são chamadas para criar o pipeline RequestPolicy utilizado para enviar um pedido HTTP no fio ou uma função que recebe o defaultRequestPolicyFactories e devolve o requestPolicyFactories que será utilizado.
rpRegistrationRetryTimeout	Obtém ou define o tempo limite de repetição em segundos para AutomaticRPRegistration. O valor predefinido é 30.
userAgent	A cadeia a ser definida para o cabeçalho de telemetria ao enviar o pedido ou uma função que utiliza a cadeia de agente de utilizador predefinida e devolve a cadeia de carateres user-agent que será utilizada.
userAgentHeaderName	O nome do cabeçalho a utilizar para o cabeçalho de telemetria ao enviar o pedido. Se isto não for especificado, será utilizado "User-Agent" ao ser executado no Node.js e "x-ms-command-name" ao ser executado num browser.
withCredentials	Se pretende incluir credenciais em pedidos CORS no browser. Consulte https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials para obter mais informações.

Detalhes de Propriedade

agentSettings

Agentes HTTP e HTTPS que serão utilizados para cada pedido HTTP (apenas Node.js).

agentSettings?: AgentSettings

Valor de Propriedade

AgentSettings

baseUri

Se especificado:

• Isto baseUri torna-se o URI base para o qual os pedidos serão feitos para este ServiceClient.
• Se corresponder a baseUri um ponto final conhecido do resource manager e se um TokenCredential tiver sido transmitido através do construtor, isto baseUri define o getToken âmbito como ${options.baseUri}/.default. Caso contrário, o âmbito seria predefinido como "https://management.azure.com/.default".

Se não for especificado:

• Todos os OperationSpecs têm de conter uma propriedade baseUrl.
• Se um TokenCredential tiver sido transmitido através do construtor, o getToken âmbito será definido como "https://management.azure.com/.default".

baseUri?: string

Valor de Propriedade

string

clientRequestIdHeaderName

Se for especificado, será adicionado um GenerateRequestIdPolicy ao pipeline HTTP que irá adicionar um cabeçalho a todos os pedidos de saída com este nome de cabeçalho e um UUID aleatório como O ID do pedido.

clientRequestIdHeaderName?: string

Valor de Propriedade

string

deserializationContentTypes

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

deserializationContentTypes?: DeserializationContentTypes

Valor de Propriedade

DeserializationContentTypes

generateClientRequestIdHeader

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

generateClientRequestIdHeader?: boolean

Valor de Propriedade

boolean

httpClient

O HttpClient que será utilizado para enviar pedidos HTTP.

httpClient?: HttpClient

Valor de Propriedade

HttpClient

httpPipelineLogger

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

httpPipelineLogger?: HttpPipelineLogger

Valor de Propriedade

HttpPipelineLogger

noRetryPolicy

Se estiver definido como verdadeiro, desative a política de repetição predefinida.

noRetryPolicy?: boolean

Valor de Propriedade

boolean

proxySettings

Definições de proxy que serão utilizadas para cada pedido HTTP (apenas Node.js).

proxySettings?: ProxySettings

Valor de Propriedade

ProxySettings

redirectOptions

Opções para a forma como as respostas de redirecionamento são processadas.

redirectOptions?: RedirectOptions

Valor de Propriedade

RedirectOptions

requestPolicyFactories

Uma matriz de fábricas que são chamadas para criar o pipeline RequestPolicy utilizado para enviar um pedido HTTP no fio ou uma função que recebe o defaultRequestPolicyFactories e devolve o requestPolicyFactories que será utilizado.

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

Valor de Propriedade

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

rpRegistrationRetryTimeout

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

rpRegistrationRetryTimeout?: number

Valor de Propriedade

number

userAgent

A cadeia a ser definida para o cabeçalho de telemetria ao enviar o pedido ou uma função que utiliza a cadeia de agente de utilizador predefinida e devolve a cadeia de carateres user-agent que será utilizada.

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

Valor de Propriedade

string | (defaultUserAgent: string) => string

userAgentHeaderName

O nome do cabeçalho a utilizar para o cabeçalho de telemetria ao enviar o pedido. Se isto não for especificado, será utilizado "User-Agent" ao ser executado no Node.js e "x-ms-command-name" ao ser executado num browser.

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

Valor de Propriedade

string | (defaultUserAgentHeaderName: string) => string

withCredentials

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

withCredentials?: boolean

Valor de Propriedade

boolean