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 (somenteNode.js).
baseUri	Se especificado: Esse baseUri se torna o URI base contra o qual as solicitações serão feitas para este ServiceClient. Se o baseUri corresponder a um ponto de extremidade conhecido do gerenciador de recursos e se um TokenCredential foi passado pelo construtor, esse baseUri define o escopo getToken a ser ${options.baseUri}/.default. Caso contrário, o escopo seria padrão para "https://management.azure.com/.default". Se não for especificado: Todos os OperationSpecs devem conter uma propriedade baseUrl. Se um TokenCredential foi passado através do construtor, o escopo getToken é 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 um UUID aleatório como 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 dentro do 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 (somenteNode.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 no fio, ou uma função que recebe o 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 durante o envio da solicitação ou uma função que recebe a cadeia de caracteres padrão do agente do usuário e retorna a cadeia de caracteres do agente do usuário que será usada.
userAgentHeaderName	O nome do cabeçalho a ser usado para o cabeçalho de telemetria durante o envio da solicitação. Se isso não for especificado, "User-Agent" será usado ao executar no Node.js e "x-ms-command-name" será usado ao executar em um navegador.
withCredentials	Se as credenciais devem ser incluídas em solicitações CORS no navegador. 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 usados para cada solicitação HTTP (somenteNode.js).

agentSettings?: AgentSettings

Valor de Propriedade

AgentSettings

baseUri

Se especificado:

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

Se não for especificado:

• Todos os OperationSpecs devem conter uma propriedade baseUrl.
• Se um TokenCredential foi passado através do construtor, o escopo getToken é definido como "https://management.azure.com/.default".

baseUri?: string

Valor de 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 um UUID aleatório como ID da solicitação.

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 deve ou não gerar um cabeçalho de ID de solicitação de cliente para cada solicitação HTTP.

generateClientRequestIdHeader?: boolean

Valor de Propriedade

boolean

httpClient

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

httpClient?: HttpClient

Valor de Propriedade

HttpClient

httpPipelineLogger

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

httpPipelineLogger?: HttpPipelineLogger

Valor de Propriedade

HttpPipelineLogger

noRetryPolicy

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

noRetryPolicy?: boolean

Valor de Propriedade

boolean

proxySettings

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

proxySettings?: ProxySettings

Valor de Propriedade

ProxySettings

redirectOptions

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

redirectOptions?: RedirectOptions

Valor de Propriedade

RedirectOptions

requestPolicyFactories

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

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 padrão é 30.

rpRegistrationRetryTimeout?: number

Valor de Propriedade

number

userAgent

A cadeia de caracteres a ser definida como o cabeçalho de telemetria durante o envio da solicitação ou uma função que recebe a cadeia de caracteres padrão do agente do usuário e retorna a cadeia de caracteres do agente do usuário que será usada.

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

Valor de Propriedade

string | (defaultUserAgent: string) => string

userAgentHeaderName

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

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

Valor de Propriedade

string | (defaultUserAgentHeaderName: string) => string

withCredentials

Se as credenciais devem ser incluídas 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 de Propriedade

boolean