MapsClientOptions interface

Balíček:

azure-maps-rest

Rozhraní představující MapsClientOptions.

Extends

AzureServiceClientOptions

Vlastnosti

baseUri

Zděděné vlastnosti

acceptLanguage	{string} [options.acceptLanguage] – získá nebo nastaví upřednostňovaný jazyk odpovědi. Výchozí hodnota je: "en-US".
agentSettings	Agenti HTTP a HTTPS, kteří se budou používat pro každý požadavek HTTP (pouze Node.js).
clientRequestIdHeaderName	Pokud je zadána hodnota GenerateRequestIdPolicy, přidá se do kanálu HTTP hlavička, která přidá hlavičku do všech odchozích požadavků s tímto názvem hlavičky a náhodným UUID jako ID požadavku.
deserializationContentTypes	Typy obsahu, které budou přidruženy k serializaci JSON nebo XML.
generateClientRequestIdHeader	Určuje, jestli se má pro každý požadavek HTTP vygenerovat hlavička ID požadavku klienta.
httpClient	HttpClient, který se použije k odesílání požadavků HTTP.
httpPipelineLogger	HttpPipelineLogger, který lze použít k ladění RequestPolicies v rámci kanálu HTTP.
longRunningOperationRetryTimeout	{number} [options.longRunningOperationRetryTimeout] – Získá nebo nastaví časový limit opakování v sekundách pro dlouhotrvající operace. Výchozí hodnota je 30.
noRetryPolicy	Pokud je nastavená hodnota true, vypněte výchozí zásady opakování.
proxySettings	Nastavení proxy serveru, které se použije pro každý požadavek HTTP (pouze Node.js).
requestPolicyFactories	Pole továren, které jsou volány k vytvoření kanálu RequestPolicy sloužícího k odeslání požadavku HTTP na drátu, nebo funkce, která převezme defaultRequestPolicyFactories a vrátí requestPolicyFactories, která se použije.
rpRegistrationRetryTimeout	Získá nebo nastaví časový limit opakování v sekundách pro AutomaticRPRegistration. Výchozí hodnota je 30.
userAgent	Řetězec, který se má nastavit na hlavičku telemetrie při odesílání požadavku, nebo funkce, která převezme výchozí řetězec uživatelského agenta a vrátí řetězec user-agent, který se použije.
userAgentHeaderName	Název hlavičky, který se použije pro hlavičku telemetrie při odesílání požadavku. Pokud není zadaný, použije se při spuštění na Node.js user-agent a při spuštění v prohlížeči se použije x-ms-command-name.
withCredentials	Jestli se mají přihlašovací údaje zahrnout do požadavků CORS v prohlížeči. Další informace naleznete v tématu https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

Podrobnosti vlastnosti

baseUri

baseUri?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

acceptLanguage

{string} [options.acceptLanguage] – získá nebo nastaví upřednostňovaný jazyk odpovědi. Výchozí hodnota je: "en-US".

acceptLanguage?: string

Hodnota vlastnosti

string

Zděděno z AzureServiceClientOptions.acceptLanguage

agentSettings

Agenti HTTP a HTTPS, kteří se budou používat pro každý požadavek HTTP (pouze Node.js).

agentSettings?: AgentSettings

Hodnota vlastnosti

AgentSettings

Zděděno z ServiceClientOptions.agentSettings

clientRequestIdHeaderName

Pokud je zadána hodnota GenerateRequestIdPolicy, přidá se do kanálu HTTP hlavička, která přidá hlavičku do všech odchozích požadavků s tímto názvem hlavičky a náhodným UUID jako ID požadavku.

clientRequestIdHeaderName?: string

Hodnota vlastnosti

string

Zděděno z ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

Typy obsahu, které budou přidruženy k serializaci JSON nebo XML.

deserializationContentTypes?: DeserializationContentTypes

Hodnota vlastnosti

DeserializationContentTypes

Zděděno z ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Určuje, jestli se má pro každý požadavek HTTP vygenerovat hlavička ID požadavku klienta.

generateClientRequestIdHeader?: boolean

Hodnota vlastnosti

boolean

Zděděno z ServiceClientOptions.generateClientRequestIdHeader

httpClient

HttpClient, který se použije k odesílání požadavků HTTP.

httpClient?: HttpClient

Hodnota vlastnosti

HttpClient

Zděděno z ServiceClientOptions.httpClient

httpPipelineLogger

HttpPipelineLogger, který lze použít k ladění RequestPolicies v rámci kanálu HTTP.

httpPipelineLogger?: HttpPipelineLogger

Hodnota vlastnosti

HttpPipelineLogger

Zděděno z ServiceClientOptions.httpPipelineLogger

longRunningOperationRetryTimeout

{number} [options.longRunningOperationRetryTimeout] – Získá nebo nastaví časový limit opakování v sekundách pro dlouhotrvající operace. Výchozí hodnota je 30.

longRunningOperationRetryTimeout?: number

Hodnota vlastnosti

number

Zděděno z AzureServiceClientOptions.longRunningOperationRetryTimeout

noRetryPolicy

Pokud je nastavená hodnota true, vypněte výchozí zásady opakování.

noRetryPolicy?: boolean

Hodnota vlastnosti

boolean

Zděděno z ServiceClientOptions.noRetryPolicy

proxySettings

Nastavení proxy serveru, které se použije pro každý požadavek HTTP (pouze Node.js).

proxySettings?: ProxySettings

Hodnota vlastnosti

ProxySettings

Zděděno z ServiceClientOptions.proxySettings

requestPolicyFactories

Pole továren, které jsou volány k vytvoření kanálu RequestPolicy sloužícího k odeslání požadavku HTTP na drátu, nebo funkce, která převezme defaultRequestPolicyFactories a vrátí requestPolicyFactories, která se použije.

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

Hodnota vlastnosti

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

Zděděno z ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Získá nebo nastaví časový limit opakování v sekundách pro AutomaticRPRegistration. Výchozí hodnota je 30.

rpRegistrationRetryTimeout?: number

Hodnota vlastnosti

number

Zděděno z ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

Řetězec, který se má nastavit na hlavičku telemetrie při odesílání požadavku, nebo funkce, která převezme výchozí řetězec uživatelského agenta a vrátí řetězec user-agent, který se použije.

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

Hodnota vlastnosti

string | (defaultUserAgent: string) => string

Zděděno z ServiceClientOptions.userAgent

userAgentHeaderName

Název hlavičky, který se použije pro hlavičku telemetrie při odesílání požadavku. Pokud není zadaný, použije se při spuštění na Node.js user-agent a při spuštění v prohlížeči se použije x-ms-command-name.

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

Hodnota vlastnosti

string | (defaultUserAgentHeaderName: string) => string

Zděděno z ServiceClientOptions.userAgentHeaderName

withCredentials

Jestli se mají přihlašovací údaje zahrnout do požadavků CORS v prohlížeči. Další informace naleznete v tématu https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Hodnota vlastnosti

boolean

Zděděno z ServiceClientOptions.withCredentials