ServiceClientOptions interface
Optionen, die beim Erstellen des Clients bereitgestellt werden sollen.
- Extends
Eigenschaften
base |
Wenn angegeben, ist dies der Basis-URI, an den Anforderungen für diesen ServiceClient gesendet werden. Wenn sie nicht angegeben ist, müssen alle OperationSpecs eine baseUrl-Eigenschaft enthalten. |
credential | Anmeldeinformationen, die zum Authentifizieren der Anforderung verwendet werden. |
credential |
Wenn angegeben, wird zum Erstellen der BearerTokenAuthenticationPolicy verwendet. |
endpoint | Wenn angegeben, ist dies der Endpunkt, an den Anforderungen für diesen ServiceClient gesendet werden. Wenn sie nicht angegeben ist, müssen alle OperationSpecs eine baseUrl-Eigenschaft enthalten. Um den Kunden zur Verwendung des Endpunkts zu ermutigen, markieren wir den baseUri als veraltet. |
pipeline | Eine zu verwendende benutzerdefinierte Pipeline, andernfalls wird eine Standardpipeline erstellt. |
request |
Der Standardmäßige Anforderungsinhaltstyp für den Dienst. Wird verwendet, wenn in einer OperationSpec kein requestContentType vorhanden ist. |
Geerbte Eigenschaften
additional |
Zusätzliche Richtlinien, die in die HTTP-Pipeline aufgenommen werden sollen. |
allow |
Auf TRUE festgelegt, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird. |
http |
Der HttpClient, der zum Senden von HTTP-Anforderungen verwendet wird. |
proxy |
Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen. |
redirect |
Optionen für die Behandlung von Umleitungsantworten. |
retry |
Optionen, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden. |
telemetry |
Optionen zum Festlegen allgemeiner Telemetriedaten und Ablaufverfolgungsinformationen auf ausgehende Anforderungen. |
tls |
Optionen zum Konfigurieren der TLS-Authentifizierung |
user |
Optionen zum Hinzufügen von Benutzer-Agent-Details zu ausgehenden Anforderungen. |
Details zur Eigenschaft
baseUri
Warnung
Diese API ist nun veraltet.
This property is deprecated and will be removed soon, please use endpoint instead
Wenn angegeben, ist dies der Basis-URI, an den Anforderungen für diesen ServiceClient gesendet werden. Wenn sie nicht angegeben ist, müssen alle OperationSpecs eine baseUrl-Eigenschaft enthalten.
baseUri?: string
Eigenschaftswert
string
credential
Anmeldeinformationen, die zum Authentifizieren der Anforderung verwendet werden.
credential?: TokenCredential
Eigenschaftswert
credentialScopes
Wenn angegeben, wird zum Erstellen der BearerTokenAuthenticationPolicy verwendet.
credentialScopes?: string | string[]
Eigenschaftswert
string | string[]
endpoint
Wenn angegeben, ist dies der Endpunkt, an den Anforderungen für diesen ServiceClient gesendet werden. Wenn sie nicht angegeben ist, müssen alle OperationSpecs eine baseUrl-Eigenschaft enthalten. Um den Kunden zur Verwendung des Endpunkts zu ermutigen, markieren wir den baseUri als veraltet.
endpoint?: string
Eigenschaftswert
string
pipeline
Eine zu verwendende benutzerdefinierte Pipeline, andernfalls wird eine Standardpipeline erstellt.
pipeline?: Pipeline
Eigenschaftswert
requestContentType
Der Standardmäßige Anforderungsinhaltstyp für den Dienst. Wird verwendet, wenn in einer OperationSpec kein requestContentType vorhanden ist.
requestContentType?: string
Eigenschaftswert
string
Geerbte Eigenschaftsdetails
additionalPolicies
Zusätzliche Richtlinien, die in die HTTP-Pipeline aufgenommen werden sollen.
additionalPolicies?: AdditionalPolicyConfig[]
Eigenschaftswert
Geerbt vonCommonClientOptions.additionalPolicies
allowInsecureConnection
Auf TRUE festgelegt, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird.
allowInsecureConnection?: boolean
Eigenschaftswert
boolean
httpClient
Der HttpClient, der zum Senden von HTTP-Anforderungen verwendet wird.
httpClient?: HttpClient
Eigenschaftswert
Geerbt vonCommonClientOptions.httpClient
proxyOptions
Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen.
proxyOptions?: ProxySettings
Eigenschaftswert
Geerbt vonCommonClientOptions.proxyOptions
redirectOptions
Optionen für die Behandlung von Umleitungsantworten.
redirectOptions?: RedirectPolicyOptions
Eigenschaftswert
Geerbt vonCommonClientOptions.redirectOptions
retryOptions
Optionen, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden.
retryOptions?: PipelineRetryOptions
Eigenschaftswert
Geerbt vonCommonClientOptions.retryOptions
telemetryOptions
Optionen zum Festlegen allgemeiner Telemetriedaten und Ablaufverfolgungsinformationen auf ausgehende Anforderungen.
telemetryOptions?: TelemetryOptions
Eigenschaftswert
Geerbt vonCommonClientOptions.telemetryOptions
tlsOptions
Optionen zum Konfigurieren der TLS-Authentifizierung
tlsOptions?: TlsSettings
Eigenschaftswert
Geerbt vonCommonClientOptions.tlsOptions
userAgentOptions
Optionen zum Hinzufügen von Benutzer-Agent-Details zu ausgehenden Anforderungen.
userAgentOptions?: UserAgentPolicyOptions
Eigenschaftswert
Geerbt vonCommonClientOptions.userAgentOptions