IotHubClientOptionalParams interface

الحزمة:

@azure/arm-iothub

المعلمات الاختيارية.

Extends

ServiceClientOptions

الخصائص

$host	معلمة الخادم
apiVersion	إصدار واجهة برمجة التطبيقات
endpoint	يتجاوز نقطة نهاية العميل.

الخصائص الموروثة

additionalPolicies	نهج إضافية لتضمينها في البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.
allowInsecureConnection	تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS
baseUri	إذا تم تحديده، فهذا هو عنوان URI الأساسي الذي سيتم إجراء الطلبات مقابله ل ServiceClient هذا. إذا لم يتم تحديده، فيجب أن تحتوي جميع OperationSpecs على خاصية baseUrl.
credential	بيانات الاعتماد المستخدمة لمصادقة الطلب.
credentialScopes	إذا تم تحديده، فسيتم استخدامه لإنشاء BearerTokenAuthenticationPolicy.
httpClient	HttpClient الذي سيتم استخدامه لإرسال طلبات HTTP.
pipeline	البنية الأساسية لبرنامج ربط العمليات التجارية المخصصة لاستخدامها، وإلا سيتم إنشاء مسار افتراضي.
proxyOptions	خيارات لتكوين وكيل للطلبات الصادرة.
redirectOptions	خيارات لكيفية معالجة استجابات إعادة التوجيه.
requestContentType	نوع محتوى الطلب الافتراضي للخدمة. يستخدم إذا لم يكن requestContentType موجودا على OperationSpec.
retryOptions	الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.
telemetryOptions	خيارات لتعيين معلومات القياس عن بعد والتتبع الشائعة للطلبات الصادرة.
tlsOptions	خيارات لتكوين مصادقة TLS
userAgentOptions	خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.

تفاصيل الخاصية

$host

معلمة الخادم

$host?: string

قيمة الخاصية

string

apiVersion

إصدار واجهة برمجة التطبيقات

apiVersion?: string

قيمة الخاصية

string

endpoint

يتجاوز نقطة نهاية العميل.

endpoint?: string

قيمة الخاصية

string

تفاصيل الخاصية الموروثة

additionalPolicies

نهج إضافية لتضمينها في البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

قيمة الخاصية

AdditionalPolicyConfig[]

موروث من coreClient.ServiceClientOptions.additionalPolicies

allowInsecureConnection

تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS

allowInsecureConnection?: boolean

قيمة الخاصية

boolean

موروث من coreClient.ServiceClientOptions.allowInsecureConnection

baseUri

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

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

إذا تم تحديده، فهذا هو عنوان URI الأساسي الذي سيتم إجراء الطلبات مقابله ل ServiceClient هذا. إذا لم يتم تحديده، فيجب أن تحتوي جميع OperationSpecs على خاصية baseUrl.

baseUri?: string

قيمة الخاصية

string

موروث من coreClient.ServiceClientOptions.baseUri

credential

بيانات الاعتماد المستخدمة لمصادقة الطلب.

credential?: TokenCredential

قيمة الخاصية

TokenCredential

موروث من coreClient.ServiceClientOptions.credential

credentialScopes

إذا تم تحديده، فسيتم استخدامه لإنشاء BearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

قيمة الخاصية

string | string[]

موروث من coreClient.ServiceClientOptions.credentialScopes

httpClient

HttpClient الذي سيتم استخدامه لإرسال طلبات HTTP.

httpClient?: HttpClient

قيمة الخاصية

HttpClient

موروث من coreClient.ServiceClientOptions.httpClient

pipeline

البنية الأساسية لبرنامج ربط العمليات التجارية المخصصة لاستخدامها، وإلا سيتم إنشاء مسار افتراضي.

pipeline?: Pipeline

قيمة الخاصية

Pipeline

موروث من coreClient.ServiceClientOptions.pipeline

proxyOptions

خيارات لتكوين وكيل للطلبات الصادرة.

proxyOptions?: ProxySettings

قيمة الخاصية

ProxySettings

موروث من coreClient.ServiceClientOptions.proxyOptions

redirectOptions

خيارات لكيفية معالجة استجابات إعادة التوجيه.

redirectOptions?: RedirectPolicyOptions

قيمة الخاصية

RedirectPolicyOptions

موروث من coreClient.ServiceClientOptions.redirectOptions

requestContentType

نوع محتوى الطلب الافتراضي للخدمة. يستخدم إذا لم يكن requestContentType موجودا على OperationSpec.

requestContentType?: string

قيمة الخاصية

string

موروث من coreClient.ServiceClientOptions.requestContentType

retryOptions

الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.

retryOptions?: PipelineRetryOptions

قيمة الخاصية

PipelineRetryOptions

موروث من coreClient.ServiceClientOptions.retryOptions

telemetryOptions

خيارات لتعيين معلومات القياس عن بعد والتتبع الشائعة للطلبات الصادرة.

telemetryOptions?: TelemetryOptions

قيمة الخاصية

TelemetryOptions

موروث من coreClient.ServiceClientOptions.telemetryOptions

tlsOptions

خيارات لتكوين مصادقة TLS

tlsOptions?: TlsSettings

قيمة الخاصية

TlsSettings

موروث من coreClient.ServiceClientOptions.tlsOptions

userAgentOptions

خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.

userAgentOptions?: UserAgentPolicyOptions

قيمة الخاصية

UserAgentPolicyOptions

موروث من coreClient.ServiceClientOptions.userAgentOptions