IotHubClientOptionalParams interface

Pakiet:

@azure/arm-iothub

Parametry opcjonalne.

Extends

ServiceClientOptions

Właściwości

$host	parametr serwera
apiVersion	Wersję interfejsu API
endpoint	Zastępuje punkt końcowy klienta.

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
baseUri	Jeśli zostanie określony, jest to podstawowy identyfikator URI, dla którego będą wykonywane żądania dla tego elementu ServiceClient. Jeśli nie zostanie określona, 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.
httpClient	Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.
pipeline	Dostosowany potok do użycia, w przeciwnym razie zostanie utworzony domyślny potok.
proxyOptions	Opcje konfigurowania serwera proxy dla żądań wychodzących.
redirectOptions	Opcje obsługi odpowiedzi przekierowania.
requestContentType	Domyślny typ zawartości żądania dla usługi. Używany, jeśli w obiekcie OperationSpec nie ma elementu requestContentType.
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

$host

parametr serwera

$host?: string

Wartość właściwości

string

apiVersion

Wersję interfejsu API

apiVersion?: string

Wartość właściwości

string

endpoint

Zastępuje punkt końcowy klienta.

endpoint?: 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 z coreClient.ServiceClientOptions.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 z coreClient.ServiceClientOptions.allowInsecureConnection

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, dla którego będą wykonywane żądania dla tego elementu ServiceClient. Jeśli nie zostanie określona, wszystkie elementy OperationSpecs muszą zawierać właściwość baseUrl.

baseUri?: string

Wartość właściwości

string

Dziedziczone z coreClient.ServiceClientOptions.baseUri

credential

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

credential?: TokenCredential

Wartość właściwości

TokenCredential

Dziedziczone z coreClient.ServiceClientOptions.credential

credentialScopes

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

credentialScopes?: string | string[]

Wartość właściwości

string | string[]

Dziedziczone z coreClient.ServiceClientOptions.credentialScopes

httpClient

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

httpClient?: HttpClient

Wartość właściwości

HttpClient

Dziedziczone z coreClient.ServiceClientOptions.httpClient

pipeline

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

pipeline?: Pipeline

Wartość właściwości

Pipeline

Dziedziczone z coreClient.ServiceClientOptions.pipeline

proxyOptions

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

proxyOptions?: ProxySettings

Wartość właściwości

ProxySettings

Dziedziczone z coreClient.ServiceClientOptions.proxyOptions

redirectOptions

Opcje obsługi odpowiedzi przekierowania.

redirectOptions?: RedirectPolicyOptions

Wartość właściwości

RedirectPolicyOptions

Dziedziczone z coreClient.ServiceClientOptions.redirectOptions

requestContentType

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

requestContentType?: string

Wartość właściwości

string

Dziedziczone z coreClient.ServiceClientOptions.requestContentType

retryOptions

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

retryOptions?: PipelineRetryOptions

Wartość właściwości

PipelineRetryOptions

Dziedziczone z coreClient.ServiceClientOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Wartość właściwości

TelemetryOptions

Dziedziczone z coreClient.ServiceClientOptions.telemetryOptions

tlsOptions

Opcje konfigurowania uwierzytelniania TLS

tlsOptions?: TlsSettings

Wartość właściwości

TlsSettings

Dziedziczone z coreClient.ServiceClientOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Wartość właściwości

UserAgentPolicyOptions

Dziedziczone z coreClient.ServiceClientOptions.userAgentOptions