MapsClientOptions interface

  • Referência
Pacote:
azure-maps-rest

Uma interface que representa MapsClientOptions.

Extends

AzureServiceClientOptions

Propriedades

baseUri

Propriedades herdadas

acceptLanguage

{string} [options.acceptLanguage] – Obtém ou define o idioma preferido para a resposta. O valor padrão é: "en-US".
agentSettings

Agentes HTTP e HTTPS que serão usados para cada solicitação HTTP (somente Node.js).
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.
longRunningOperationRetryTimeout

{number} [options.longRunningOperationRetryTimeout] – Obtém ou define o tempo limite de repetição em segundos para Operações de Execução Longa. O valor padrão é 30.
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).
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

baseUri 

baseUri?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

acceptLanguage

{string} [options.acceptLanguage] – Obtém ou define o idioma preferido para a resposta. O valor padrão é: "en-US".

acceptLanguage?: string

Valor da propriedade

string

Herdado de AzureServiceClientOptions.acceptLanguage

agentSettings

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

agentSettings?: AgentSettings

Valor da propriedade

AgentSettings

Herdado de ServiceClientOptions.agentSettings

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

Herdado de ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

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

deserializationContentTypes?: DeserializationContentTypes

Valor da propriedade

DeserializationContentTypes

Herdado de ServiceClientOptions.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

Herdado de ServiceClientOptions.generateClientRequestIdHeader

httpClient

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

httpClient?: HttpClient

Valor da propriedade

HttpClient

Herdado de ServiceClientOptions.httpClient

httpPipelineLogger

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

httpPipelineLogger?: HttpPipelineLogger

Valor da propriedade

HttpPipelineLogger

Herdado de ServiceClientOptions.httpPipelineLogger

longRunningOperationRetryTimeout

{number} [options.longRunningOperationRetryTimeout] – Obtém ou define o tempo limite de repetição em segundos para Operações de Execução Longa. O valor padrão é 30.

longRunningOperationRetryTimeout?: number

Valor da propriedade

number

Herdado de AzureServiceClientOptions.longRunningOperationRetryTimeout

noRetryPolicy

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

noRetryPolicy?: boolean

Valor da propriedade

boolean

Herdado de ServiceClientOptions.noRetryPolicy

proxySettings

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

proxySettings?: ProxySettings

Valor da propriedade

ProxySettings

Herdado de ServiceClientOptions.proxySettings

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 | { create(nextPolicy: RequestPolicy, options: RequestPolicyOptions) => RequestPolicy }[]

Valor da propriedade

RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | { create(nextPolicy: RequestPolicy, options: RequestPolicyOptions) => RequestPolicy }[]

Herdado de ServiceClientOptions.requestPolicyFactories

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

Herdado de ServiceClientOptions.rpRegistrationRetryTimeout

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

Herdado de ServiceClientOptions.userAgent

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

Herdado de ServiceClientOptions.userAgentHeaderName

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

Herdado de ServiceClientOptions.withCredentials