IotHubResource interface
واجهة تمثل IotHubResource.
الأساليب
تفاصيل الأسلوب
beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
إنشاء بيانات التعريف لمركز Iot أو تحديثها. النمط المعتاد لتعديل خاصية هو استرداد بيانات تعريف مركز IoT وبيانات تعريف الأمان، ثم دمجها مع القيم المعدلة في نص جديد لتحديث مركز IoT. إذا كانت بعض الخصائص مفقودة في JSON، فقد يؤدي تحديث IoT Hub إلى إرجاع هذه القيم إلى الوضع الافتراضي، مما قد يؤدي إلى سلوك غير متوقع.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
- iotHubDescription
- IotHubDescription
بيانات تعريف مركز IoT وبيانات تعريف الأمان.
معلمات الخيارات.
المرتجعات
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
إنشاء بيانات التعريف لمركز Iot أو تحديثها. النمط المعتاد لتعديل خاصية هو استرداد بيانات تعريف مركز IoT وبيانات تعريف الأمان، ثم دمجها مع القيم المعدلة في نص جديد لتحديث مركز IoT. إذا كانت بعض الخصائص مفقودة في JSON، فقد يؤدي تحديث IoT Hub إلى إرجاع هذه القيم إلى الوضع الافتراضي، مما قد يؤدي إلى سلوك غير متوقع.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
- iotHubDescription
- IotHubDescription
بيانات تعريف مركز IoT وبيانات تعريف الأمان.
معلمات الخيارات.
المرتجعات
Promise<IotHubDescription>
beginDelete(string, string, IotHubResourceDeleteOptionalParams)
حذف مركز IoT.
function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
معلمات الخيارات.
المرتجعات
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)
حذف مركز IoT.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
معلمات الخيارات.
المرتجعات
Promise<IotHubDescription>
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
تحديث علامات IoT Hub موجودة. لتحديث الحقول الأخرى، استخدم أسلوب CreateOrUpdate
function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>المعلمات
- resourceGroupName
-
string
معرف مجموعة الموارد.
- resourceName
-
string
اسم مركز iot المراد تحديثه.
- iotHubTags
- TagsResource
معلومات العلامة المحدثة لتعيينها في مثيل مركز iot.
معلمات الخيارات.
المرتجعات
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
تحديث علامات IoT Hub موجودة. لتحديث الحقول الأخرى، استخدم أسلوب CreateOrUpdate
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubDescription>المعلمات
- resourceGroupName
-
string
معرف مجموعة الموارد.
- resourceName
-
string
اسم مركز iot المراد تحديثه.
- iotHubTags
- TagsResource
معلومات العلامة المحدثة لتعيينها في مثيل مركز iot.
معلمات الخيارات.
المرتجعات
Promise<IotHubDescription>
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)
تحقق مما إذا كان اسم مركز IoT متوفرا.
function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>المعلمات
- operationInputs
- OperationInputs
تعيين معلمة الاسم في بنية OperationInputs إلى اسم مركز IoT للتحقق.
معلمات الخيارات.
المرتجعات
Promise<IotHubNameAvailabilityInfo>
createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)
إضافة مجموعة مستهلكين إلى نقطة نهاية متوافقة مع Event Hub في مركز IoT.
function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, consumerGroupBody: EventHubConsumerGroupBodyDescription, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
- eventHubEndpointName
-
string
اسم نقطة النهاية المتوافقة مع Event Hub في مركز IoT.
- name
-
string
اسم مجموعة المستهلكين المراد إضافتها.
- consumerGroupBody
- EventHubConsumerGroupBodyDescription
مجموعة المستهلكين المراد إضافتها.
معلمات الخيارات.
المرتجعات
Promise<EventHubConsumerGroupInfo>
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)
حذف مجموعة مستهلكين من نقطة نهاية متوافقة مع Event Hub في مركز IoT.
function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
- eventHubEndpointName
-
string
اسم نقطة النهاية المتوافقة مع Event Hub في مركز IoT.
- name
-
string
اسم مجموعة المستهلكين المراد حذفها.
معلمات الخيارات.
المرتجعات
Promise<void>
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)
تصدير جميع هويات الجهاز في سجل هوية مركز IoT إلى حاوية كائن ثنائي كبير الحجم ل Azure Storage. لمزيد من المعلومات، راجع: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
function exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: ExportDevicesRequest, options?: IotHubResourceExportDevicesOptionalParams): Promise<JobResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
- exportDevicesParameters
- ExportDevicesRequest
المعلمات التي تحدد عملية تصدير الأجهزة.
معلمات الخيارات.
المرتجعات
Promise<JobResponse>
get(string, string, IotHubResourceGetOptionalParams)
احصل على بيانات التعريف غير المتعلقة بالأمان لمركز IoT.
function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
- options
- IotHubResourceGetOptionalParams
معلمات الخيارات.
المرتجعات
Promise<IotHubDescription>
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)
احصل على مجموعة مستهلكين من نقطة النهاية المتوافقة مع Event Hub من جهاز إلى سحابة لمركز IoT.
function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
- eventHubEndpointName
-
string
اسم نقطة النهاية المتوافقة مع Event Hub في مركز IoT.
- name
-
string
اسم مجموعة المستهلكين المراد استردادها.
معلمات الخيارات.
المرتجعات
Promise<EventHubConsumerGroupInfo>
getJob(string, string, string, IotHubResourceGetJobOptionalParams)
احصل على تفاصيل الوظيفة من مركز IoT. لمزيد من المعلومات، راجع: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<JobResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
- jobId
-
string
معرف الوظيفة.
معلمات الخيارات.
المرتجعات
Promise<JobResponse>
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)
احصل على نهج وصول مشترك بالاسم من مركز IoT. لمزيد من المعلومات، راجع: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRule>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
- keyName
-
string
اسم نهج الوصول المشترك.
معلمات الخيارات.
المرتجعات
getStats(string, string, IotHubResourceGetStatsOptionalParams)
احصل على الإحصائيات من مركز IoT.
function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
معلمات الخيارات.
المرتجعات
Promise<RegistryStatistics>
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)
استيراد هويات الجهاز أو تحديثها أو حذفها في سجل هوية مركز IoT من كائن ثنائي كبير الحجم. لمزيد من المعلومات، راجع: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
function importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: ImportDevicesRequest, options?: IotHubResourceImportDevicesOptionalParams): Promise<JobResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
- importDevicesParameters
- ImportDevicesRequest
المعلمات التي تحدد عملية استيراد الأجهزة.
معلمات الخيارات.
المرتجعات
Promise<JobResponse>
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)
احصل على جميع مراكز IoT في مجموعة موارد.
function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
معلمات الخيارات.
المرتجعات
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
احصل على جميع مراكز IoT في اشتراك.
function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>المعلمات
معلمات الخيارات.
المرتجعات
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)
احصل على صحة نقاط النهاية للتوجيه.
function listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>المعلمات
- resourceGroupName
-
string
- iotHubName
-
string
معلمات الخيارات.
المرتجعات
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)
احصل على قائمة بمجموعات المستهلكين في نقطة النهاية المتوافقة مع Event Hub من جهاز إلى سحابة في مركز IoT.
function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
- eventHubEndpointName
-
string
اسم نقطة النهاية المتوافقة مع Event Hub.
معلمات الخيارات.
المرتجعات
listJobs(string, string, IotHubResourceListJobsOptionalParams)
احصل على قائمة بجميع الوظائف في مركز IoT. لمزيد من المعلومات، راجع: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
معلمات الخيارات.
المرتجعات
listKeys(string, string, IotHubResourceListKeysOptionalParams)
احصل على بيانات تعريف الأمان لمركز IoT. لمزيد من المعلومات، راجع: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
معلمات الخيارات.
المرتجعات
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)
احصل على مقاييس الحصة النسبية لمركز IoT.
function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
معلمات الخيارات.
المرتجعات
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)
احصل على قائمة وحدات SKU الصالحة لمركز IoT.
function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على مركز IoT.
- resourceName
-
string
اسم مركز IoT.
معلمات الخيارات.
المرتجعات
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)
اختبار جميع المسارات التي تم تكوينها في مركز Iot هذا
function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>المعلمات
- iotHubName
-
string
IotHub ليتم اختباره
- resourceGroupName
-
string
مجموعة الموارد التي ينتمي إليها Iot Hub
- input
- TestAllRoutesInput
إدخال لاختبار جميع المسارات
معلمات الخيارات.
المرتجعات
Promise<TestAllRoutesResult>
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)
اختبار المسار الجديد ل Iot Hub هذا
function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>المعلمات
- iotHubName
-
string
IotHub ليتم اختباره
- resourceGroupName
-
string
مجموعة الموارد التي ينتمي إليها Iot Hub
- input
- TestRouteInput
المسار الذي يجب اختباره
معلمات الخيارات.
المرتجعات
Promise<TestRouteResult>