ServiceClientOptions interface
Možnosti, které se mají poskytnout při vytváření klienta.
- Extends
Vlastnosti
base |
Pokud je zadaný, jedná se o základní identifikátor URI, proti kterému se budou provádět požadavky pro tohoto klienta služby ServiceClient. Pokud není zadán, pak musí všechny OperationSpecs obsahovat vlastnost baseUrl. |
credential | Přihlašovací údaje použité k ověření požadavku. |
credential |
Pokud je zadaný, použije se k sestavení BearerTokenAuthenticationPolicy. |
endpoint | Pokud je zadaný, jedná se o koncový bod, na který se budou provádět požadavky pro tohoto klienta služby ServiceClient. Pokud není zadán, pak musí všechny OperationSpecs obsahovat vlastnost baseUrl. Abychom zákazníka povzbudili, aby používal koncový bod, označíme baseUri jako zastaralý. |
pipeline | Vlastní kanál, který se má použít, jinak se vytvoří výchozí kanál. |
request |
Výchozí typ obsahu požadavku pro službu. Používá se, pokud v objektu OperationSpec není k dispozici žádný typ requestContentType. |
Zděděné vlastnosti
additional |
Další zásady, které se mají zahrnout do kanálu HTTP. |
allow |
Nastavte na hodnotu true, pokud se požadavek odesílá přes HTTP místo https. |
http |
HttpClient, který se použije k odesílání požadavků HTTP. |
proxy |
Možnosti konfigurace proxy serveru pro odchozí požadavky |
redirect |
Možnosti zpracování odpovědí přesměrování |
retry |
Možnosti, které určují, jak opakovat neúspěšné žádosti. |
telemetry |
Možnosti nastavení běžné telemetrie a trasování informací pro odchozí požadavky |
tls |
Možnosti konfigurace ověřování TLS |
user |
Možnosti pro přidání podrobností o uživatelském agentu k odchozím požadavkům |
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 zadaný, jedná se o základní identifikátor URI, proti kterému se budou provádět požadavky pro tohoto klienta služby ServiceClient. Pokud není zadán, pak 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
credentialScopes
Pokud je zadaný, použije se k sestavení BearerTokenAuthenticationPolicy.
credentialScopes?: string | string[]
Hodnota vlastnosti
string | string[]
endpoint
Pokud je zadaný, jedná se o koncový bod, na který se budou provádět požadavky pro tohoto klienta služby ServiceClient. Pokud není zadán, pak musí všechny OperationSpecs obsahovat vlastnost baseUrl. Abychom zákazníka povzbudili, aby používal koncový bod, označíme baseUri jako zastaralý.
endpoint?: string
Hodnota vlastnosti
string
pipeline
Vlastní kanál, který se má použít, jinak se vytvoří výchozí kanál.
pipeline?: Pipeline
Hodnota vlastnosti
requestContentType
Výchozí typ obsahu požadavku pro službu. Používá se, pokud v objektu OperationSpec není k dispozici žádný typ 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
allowInsecureConnection
Nastavte na hodnotu true, pokud se požadavek odesílá přes HTTP místo https.
allowInsecureConnection?: boolean
Hodnota vlastnosti
boolean
httpClient
HttpClient, který se použije k odesílání požadavků HTTP.
httpClient?: HttpClient
Hodnota vlastnosti
Zděděno zCommonClientOptions.httpClient
proxyOptions
Možnosti konfigurace proxy serveru pro odchozí požadavky
proxyOptions?: ProxySettings
Hodnota vlastnosti
Zděděno zCommonClientOptions.proxyOptions
redirectOptions
Možnosti zpracování odpovědí přesměrování
redirectOptions?: RedirectPolicyOptions
Hodnota vlastnosti
Zděděno zCommonClientOptions.redirectOptions
retryOptions
Možnosti, které určují, jak opakovat neúspěšné žádosti.
retryOptions?: PipelineRetryOptions
Hodnota vlastnosti
Zděděno zCommonClientOptions.retryOptions
telemetryOptions
Možnosti nastavení běžné telemetrie a trasování informací pro odchozí požadavky
telemetryOptions?: TelemetryOptions
Hodnota vlastnosti
Zděděno zCommonClientOptions.telemetryOptions
tlsOptions
Možnosti konfigurace ověřování TLS
tlsOptions?: TlsSettings
Hodnota vlastnosti
Zděděno zCommonClientOptions.tlsOptions
userAgentOptions
Možnosti pro přidání podrobností o uživatelském agentu k odchozím požadavkům
userAgentOptions?: UserAgentPolicyOptions
Hodnota vlastnosti
Zděděno zCommonClientOptions.userAgentOptions