IotHubResource interface
Интерфейс, представляющий IotHubResource.
Методы
| begin |
Создайте или обновите метаданные центра Iot. Обычный шаблон изменения свойства — получить метаданные центра Интернета вещей и метаданные безопасности, а затем объединить их с измененными значениями в новом тексте для обновления Центра Интернета вещей. Если некоторые свойства отсутствуют в ФОРМАТЕ JSON, обновление Центра Интернета вещей может привести к возврату этих значений по умолчанию, что может привести к неожиданному поведению. |
| begin |
Создайте или обновите метаданные центра Iot. Обычный шаблон изменения свойства — получить метаданные центра Интернета вещей и метаданные безопасности, а затем объединить их с измененными значениями в новом тексте для обновления Центра Интернета вещей. Если некоторые свойства отсутствуют в ФОРМАТЕ JSON, обновление Центра Интернета вещей может привести к возврату этих значений по умолчанию, что может привести к неожиданному поведению. |
| begin |
Удаление центра Интернета вещей. |
| begin |
Удаление центра Интернета вещей. |
| begin |
Обновите существующие теги Центра Интернета вещей. для обновления других полей используйте метод CreateOrUpdate |
| begin |
Обновите существующие теги Центра Интернета вещей. для обновления других полей используйте метод CreateOrUpdate |
| check |
Проверьте, доступно ли имя центра Интернета вещей. |
| create |
Добавьте группу потребителей в конечную точку, совместимую с Концентратором событий, в Центре Интернета вещей. |
| delete |
Удалите группу потребителей из конечной точки, совместимой с Концентратором событий, в Центре Интернета вещей. |
| export |
Экспортирует все удостоверения устройств в реестре удостоверений Центра Интернета вещей в контейнер BLOB-объектов службы хранилища Azure. Дополнительные сведения см. в статье https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. |
| get(string, string, Iot |
Получение метаданных, связанных с безопасностью центра Интернета вещей. |
| get |
Получите группу потребителей из конечной точки центра событий, совместимой с устройством и облаком, для Центра Интернета вещей. |
| get |
Получение сведений о задании из Центра Интернета вещей. Дополнительные сведения см. в статье https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. |
| get |
Получите политику общего доступа по имени из Центра Интернета вещей. Дополнительные сведения см. в статье https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. |
| get |
Получение статистики из Центра Интернета вещей. |
| import |
Импорт, обновление или удаление удостоверений устройств в реестре удостоверений Центра Интернета вещей из большого двоичного объекта. Дополнительные сведения см. в статье https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. |
| list |
Получите все центры Интернета вещей в группе ресурсов. |
| list |
Получите все центры Интернета вещей в подписке. |
| list |
Получение работоспособности для конечных точек маршрутизации. |
| list |
Получение списка групп потребителей в конечной точке центра событий, совместимой с устройством и облаком, в Центре Интернета вещей. |
| list |
Получение списка всех заданий в Центре Интернета вещей. Дополнительные сведения см. в статье https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. |
| list |
Получение метаданных безопасности для Центра Интернета вещей. Дополнительные сведения см. в статье https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. |
| list |
Получение метрик квоты для Центра Интернета вещей. |
| list |
Получите список допустимых номеров SKU для Центра Интернета вещей. |
| test |
Тестирование всех маршрутов, настроенных в этом Центре Iot |
| test |
Тестирование нового маршрута для этого Центра Iot |
Сведения о методе
beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Создайте или обновите метаданные центра Iot. Обычный шаблон изменения свойства — получить метаданные центра Интернета вещей и метаданные безопасности, а затем объединить их с измененными значениями в новом тексте для обновления Центра Интернета вещей. Если некоторые свойства отсутствуют в ФОРМАТЕ JSON, обновление Центра Интернета вещей может привести к возврату этих значений по умолчанию, что может привести к неожиданному поведению.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
- iotHubDescription
- IotHubDescription
Метаданные центра Интернета вещей и метаданные безопасности.
Параметры параметров.
Возвращаемое значение
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Создайте или обновите метаданные центра Iot. Обычный шаблон изменения свойства — получить метаданные центра Интернета вещей и метаданные безопасности, а затем объединить их с измененными значениями в новом тексте для обновления Центра Интернета вещей. Если некоторые свойства отсутствуют в ФОРМАТЕ JSON, обновление Центра Интернета вещей может привести к возврату этих значений по умолчанию, что может привести к неожиданному поведению.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
- iotHubDescription
- IotHubDescription
Метаданные центра Интернета вещей и метаданные безопасности.
Параметры параметров.
Возвращаемое значение
Promise<IotHubDescription>
beginDelete(string, string, IotHubResourceDeleteOptionalParams)
Удаление центра Интернета вещей.
function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
Параметры параметров.
Возвращаемое значение
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)
Удаление центра Интернета вещей.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
Параметры параметров.
Возвращаемое значение
Promise<IotHubDescription>
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Обновите существующие теги Центра Интернета вещей. для обновления других полей используйте метод 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)
Обновите существующие теги Центра Интернета вещей. для обновления других полей используйте метод 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)
Проверьте, доступно ли имя центра Интернета вещей.
function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>
Параметры
- operationInputs
- OperationInputs
Задайте параметр имени в структуре OperationInputs именем центра Интернета вещей для проверки.
Параметры параметров.
Возвращаемое значение
Promise<IotHubNameAvailabilityInfo>
createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)
Добавьте группу потребителей в конечную точку, совместимую с Концентратором событий, в Центре Интернета вещей.
function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, consumerGroupBody: EventHubConsumerGroupBodyDescription, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
- eventHubEndpointName
-
string
Имя конечной точки, совместимой с Концентратором событий, в Центре Интернета вещей.
- name
-
string
Имя добавляемой группы потребителей.
- consumerGroupBody
- EventHubConsumerGroupBodyDescription
Добавленная группа потребителей.
Параметры параметров.
Возвращаемое значение
Promise<EventHubConsumerGroupInfo>
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)
Удалите группу потребителей из конечной точки, совместимой с Концентратором событий, в Центре Интернета вещей.
function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
- eventHubEndpointName
-
string
Имя конечной точки, совместимой с Концентратором событий, в Центре Интернета вещей.
- name
-
string
Имя группы потребителей для удаления.
Параметры параметров.
Возвращаемое значение
Promise<void>
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)
Экспортирует все удостоверения устройств в реестре удостоверений Центра Интернета вещей в контейнер BLOB-объектов службы хранилища Azure. Дополнительные сведения см. в статье 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
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
- exportDevicesParameters
- ExportDevicesRequest
Параметры, указывающие операцию экспорта устройств.
Параметры параметров.
Возвращаемое значение
Promise<JobResponse>
get(string, string, IotHubResourceGetOptionalParams)
Получение метаданных, связанных с безопасностью центра Интернета вещей.
function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
- options
- IotHubResourceGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<IotHubDescription>
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)
Получите группу потребителей из конечной точки центра событий, совместимой с устройством и облаком, для Центра Интернета вещей.
function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
- eventHubEndpointName
-
string
Имя конечной точки, совместимой с Концентратором событий, в Центре Интернета вещей.
- name
-
string
Имя извлекаемой группы потребителей.
Параметры параметров.
Возвращаемое значение
Promise<EventHubConsumerGroupInfo>
getJob(string, string, string, IotHubResourceGetJobOptionalParams)
Получение сведений о задании из Центра Интернета вещей. Дополнительные сведения см. в статье 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
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
- jobId
-
string
Идентификатор задания.
Параметры параметров.
Возвращаемое значение
Promise<JobResponse>
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)
Получите политику общего доступа по имени из Центра Интернета вещей. Дополнительные сведения см. в статье 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
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
- keyName
-
string
Имя политики общего доступа.
Параметры параметров.
Возвращаемое значение
getStats(string, string, IotHubResourceGetStatsOptionalParams)
Получение статистики из Центра Интернета вещей.
function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
Параметры параметров.
Возвращаемое значение
Promise<RegistryStatistics>
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)
Импорт, обновление или удаление удостоверений устройств в реестре удостоверений Центра Интернета вещей из большого двоичного объекта. Дополнительные сведения см. в статье 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
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
- importDevicesParameters
- ImportDevicesRequest
Параметры, указывающие операцию импорта устройств.
Параметры параметров.
Возвращаемое значение
Promise<JobResponse>
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)
Получите все центры Интернета вещей в группе ресурсов.
function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей Центр Интернета вещей.
Параметры параметров.
Возвращаемое значение
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
Получите все центры Интернета вещей в подписке.
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)
Получение списка групп потребителей в конечной точке центра событий, совместимой с устройством и облаком, в Центре Интернета вещей.
function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
- eventHubEndpointName
-
string
Имя конечной точки, совместимой с Концентратором событий.
Параметры параметров.
Возвращаемое значение
listJobs(string, string, IotHubResourceListJobsOptionalParams)
Получение списка всех заданий в Центре Интернета вещей. Дополнительные сведения см. в статье 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
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
Параметры параметров.
Возвращаемое значение
listKeys(string, string, IotHubResourceListKeysOptionalParams)
Получение метаданных безопасности для Центра Интернета вещей. Дополнительные сведения см. в статье 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
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
Параметры параметров.
Возвращаемое значение
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)
Получение метрик квоты для Центра Интернета вещей.
function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
Параметры параметров.
Возвращаемое значение
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)
Получите список допустимых номеров SKU для Центра Интернета вещей.
function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей Центр Интернета вещей.
- resourceName
-
string
Имя Центра Интернета вещей.
Параметры параметров.
Возвращаемое значение
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)
Тестирование всех маршрутов, настроенных в этом Центре Iot
function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>
Параметры
- iotHubName
-
string
Тестируемый IotHub
- resourceGroupName
-
string
группа ресурсов, к которой принадлежит Центр Iot
- input
- TestAllRoutesInput
Входные данные для тестирования всех маршрутов
Параметры параметров.
Возвращаемое значение
Promise<TestAllRoutesResult>
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)
Тестирование нового маршрута для этого Центра Iot
function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>
Параметры
- iotHubName
-
string
Тестируемый IotHub
- resourceGroupName
-
string
группа ресурсов, к которой принадлежит Центр Iot
- input
- TestRouteInput
Маршрут, который необходимо проверить
Параметры параметров.
Возвращаемое значение
Promise<TestRouteResult>