ServiceClientOptions interface

Balíček:

@azure/core-client

Možnosti, které se mají poskytnout při vytváření klienta.

Extends

CommonClientOptions

Vlastnosti

baseUri	Pokud je zadáno, jedná se o základní identifikátor URI, pro který se budou požadavky provádět pro tohoto serviceClient. Pokud není zadán, musí všechny OperationSpecs obsahovat vlastnost baseUrl.
credential	Přihlašovací údaje použité k ověření požadavku.
credentialScopes	Pokud je zadáno, použije se k sestavení BearerTokenAuthenticationPolicy.
endpoint	Pokud je zadáno, jedná se o koncový bod, pro který se budou požadavky provádět pro tohoto klienta Služby. Pokud není zadán, musí všechny OperationSpecs obsahovat vlastnost baseUrl. abychom zákazníka povzbudili k používání koncového bodu, označíme základní identifikátor URI jako zastaralý.
pipeline	Přizpůsobený kanál, který se má použít, jinak se vytvoří výchozí kanál.
requestContentType	Výchozí typ obsahu požadavku pro službu. Používá se, pokud v operationSpec není k dispozici žádný requestContentType.

Zděděné vlastnosti

additionalPolicies	Další zásady, které se mají zahrnout do kanálu HTTP.
agent	Možnosti konfigurace instance agenta pro odchozí požadavky
allowInsecureConnection	Nastavte hodnotu true, pokud se požadavek odesílá přes protokol HTTP místo HTTPS.
httpClient	HttpClient, který se použije k odesílání požadavků HTTP.
proxyOptions	Možnosti konfigurace proxy serveru pro odchozí požadavky
redirectOptions	Možnosti zpracování odpovědí na přesměrování
retryOptions	Možnosti, které řídí, jak opakovat neúspěšné požadavky.
telemetryOptions	Možnosti nastavení běžné telemetrie a trasování informací pro odchozí požadavky
tlsOptions	Možnosti konfigurace ověřování TLS
userAgentOptions	Možnosti přidání podrobností o uživatelském agentu do odchozích požadavků

Podrobnosti vlastnosti

baseUri

Upozornění

Toto rozhraní API je teď zastaralé.

This property is deprecated and will be removed soon, please use endpoint instead

Pokud je zadáno, jedná se o základní identifikátor URI, pro který se budou požadavky provádět pro tohoto serviceClient. Pokud není zadán, musí všechny OperationSpecs obsahovat vlastnost baseUrl.

baseUri?: string

Hodnota vlastnosti

string

credential

Přihlašovací údaje použité k ověření požadavku.

credential?: TokenCredential

Hodnota vlastnosti

TokenCredential

credentialScopes

Pokud je zadáno, použije se k sestavení BearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

Hodnota vlastnosti

string | string[]

endpoint

Pokud je zadáno, jedná se o koncový bod, pro který se budou požadavky provádět pro tohoto klienta Služby. Pokud není zadán, musí všechny OperationSpecs obsahovat vlastnost baseUrl. abychom zákazníka povzbudili k používání koncového bodu, označíme základní identifikátor URI jako zastaralý.

endpoint?: string

Hodnota vlastnosti

string

pipeline

Přizpůsobený kanál, který se má použít, jinak se vytvoří výchozí kanál.

pipeline?: Pipeline

Hodnota vlastnosti

Pipeline

requestContentType

Výchozí typ obsahu požadavku pro službu. Používá se, pokud v operationSpec není k dispozici žádný requestContentType.

requestContentType?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

additionalPolicies

Další zásady, které se mají zahrnout do kanálu HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Hodnota vlastnosti

AdditionalPolicyConfig[]

zděděné zCommonClientOptions.additionalPolicies

agent

Možnosti konfigurace instance agenta pro odchozí požadavky

agent?: Agent

Hodnota vlastnosti

Agent

zděděno z CommonClientOptions.agent

allowInsecureConnection

Nastavte hodnotu true, pokud se požadavek odesílá přes protokol HTTP místo HTTPS.

allowInsecureConnection?: boolean

Hodnota vlastnosti

boolean

zděděno zCommonClientOptions.allowInsecureConnection

httpClient

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

httpClient?: HttpClient

Hodnota vlastnosti

HttpClient

zděděné z CommonClientOptions.httpClient

proxyOptions

Možnosti konfigurace proxy serveru pro odchozí požadavky

proxyOptions?: ProxySettings

Hodnota vlastnosti

ProxySettings

zděděné zCommonClientOptions.proxyOptions

redirectOptions

Možnosti zpracování odpovědí na přesměrování

redirectOptions?: RedirectPolicyOptions

Hodnota vlastnosti

RedirectPolicyOptions

zděděné zCommonClientOptions.redirectOptions

retryOptions

Možnosti, které řídí, jak opakovat neúspěšné požadavky.

retryOptions?: PipelineRetryOptions

Hodnota vlastnosti

PipelineRetryOptions

zděděné zCommonClientOptions.retryOptions

telemetryOptions

Možnosti nastavení běžné telemetrie a trasování informací pro odchozí požadavky

telemetryOptions?: TelemetryOptions

Hodnota vlastnosti

TelemetryOptions

zděděné zCommonClientOptions.telemetryOptions

tlsOptions

Možnosti konfigurace ověřování TLS

tlsOptions?: TlsSettings

Hodnota vlastnosti

TlsSettings

zděděné zCommonClientOptions.tlsOptions

userAgentOptions

Možnosti přidání podrobností o uživatelském agentu do odchozích požadavků

userAgentOptions?: UserAgentPolicyOptions

Hodnota vlastnosti

UserAgentPolicyOptions

zděděné zCommonClientOptions.userAgentOptions