ServiceClientOptions interface

Pakiet:

@azure/core-client

Opcje, które należy podać podczas tworzenia klienta.

Extends

CommonClientOptions

Właściwości

baseUri	Jeśli zostanie określony, jest to podstawowy identyfikator URI, względem którego będą wykonywane żądania dla tego elementu ServiceClient. Jeśli nie zostanie określony, wszystkie elementy OperationSpecs muszą zawierać właściwość baseUrl.
credential	Poświadczenia używane do uwierzytelniania żądania.
credentialScopes	Jeśli zostanie określony, zostanie użyty do skompilowania elementu BearerTokenAuthenticationPolicy.
endpoint	Jeśli zostanie określony, jest to punkt końcowy, dla którego będą wysyłane żądania dla tego elementu ServiceClient. Jeśli nie zostanie określony, wszystkie elementy OperationSpecs muszą zawierać właściwość baseUrl. Aby zachęcić klienta do korzystania z punktu końcowego, oznaczymy identyfikator baseUri jako przestarzały.
pipeline	Dostosowany potok do użycia. W przeciwnym razie zostanie utworzony domyślny potok.
requestContentType	Domyślny typ zawartości żądania dla usługi. Używany, jeśli parametr requestContentType nie jest obecny w obiekcie OperationSpec.

Właściwości dziedziczone

additionalPolicies	Dodatkowe zasady do uwzględnienia w potoku HTTP.
allowInsecureConnection	Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS
httpClient	Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.
proxyOptions	Opcje konfigurowania serwera proxy dla żądań wychodzących.
redirectOptions	Opcje obsługi odpowiedzi przekierowania.
retryOptions	Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
telemetryOptions	Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.
tlsOptions	Opcje konfigurowania uwierzytelniania TLS
userAgentOptions	Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

Szczegóły właściwości

baseUri

Ostrzeżenie

Ten interfejs API jest już przestarzały.

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

Jeśli zostanie określony, jest to podstawowy identyfikator URI, względem którego będą wykonywane żądania dla tego elementu ServiceClient. Jeśli nie zostanie określony, wszystkie elementy OperationSpecs muszą zawierać właściwość baseUrl.

baseUri?: string

Wartość właściwości

string

credential

Poświadczenia używane do uwierzytelniania żądania.

credential?: TokenCredential

Wartość właściwości

TokenCredential

credentialScopes

Jeśli zostanie określony, zostanie użyty do skompilowania elementu BearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

Wartość właściwości

string | string[]

endpoint

Jeśli zostanie określony, jest to punkt końcowy, dla którego będą wysyłane żądania dla tego elementu ServiceClient. Jeśli nie zostanie określony, wszystkie elementy OperationSpecs muszą zawierać właściwość baseUrl. Aby zachęcić klienta do korzystania z punktu końcowego, oznaczymy identyfikator baseUri jako przestarzały.

endpoint?: string

Wartość właściwości

string

pipeline

Dostosowany potok do użycia. W przeciwnym razie zostanie utworzony domyślny potok.

pipeline?: Pipeline

Wartość właściwości

Pipeline

requestContentType

Domyślny typ zawartości żądania dla usługi. Używany, jeśli parametr requestContentType nie jest obecny w obiekcie OperationSpec.

requestContentType?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

additionalPolicies

Dodatkowe zasady do uwzględnienia w potoku HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Wartość właściwości

AdditionalPolicyConfig[]

Dziedziczone zcommonClientOptions.additionalPolicies

allowInsecureConnection

Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS

allowInsecureConnection?: boolean

Wartość właściwości

boolean

Dziedziczone zcommonClientOptions.allowInsecureConnection

httpClient

Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.

httpClient?: HttpClient

Wartość właściwości

HttpClient

Dziedziczone zcommonClientOptions.httpClient

proxyOptions

Opcje konfigurowania serwera proxy dla żądań wychodzących.

proxyOptions?: ProxySettings

Wartość właściwości

ProxySettings

Dziedziczone zcommonClientOptions.proxyOptions

redirectOptions

Opcje obsługi odpowiedzi przekierowania.

redirectOptions?: RedirectPolicyOptions

Wartość właściwości

RedirectPolicyOptions

Dziedziczone zcommonClientOptions.redirectOptions

retryOptions

Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.

retryOptions?: PipelineRetryOptions

Wartość właściwości

PipelineRetryOptions

Dziedziczone zcommonClientOptions.retryOptions

telemetryOptions

Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.

telemetryOptions?: TelemetryOptions

Wartość właściwości

TelemetryOptions

Dziedziczone zcommonClientOptions.telemetryOptions

tlsOptions

Opcje konfigurowania uwierzytelniania TLS

tlsOptions?: TlsSettings

Wartość właściwości

TlsSettings

Dziedziczone zcommonClientOptions.tlsOptions

userAgentOptions

Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

userAgentOptions?: UserAgentPolicyOptions

Wartość właściwości

UserAgentPolicyOptions

Dziedziczone zcommonClientOptions.userAgentOptions