@azure/arm-iothub package

Классы

IotHubClient

Интерфейсы

ArmIdentity
ArmUserIdentity
CertificateBodyDescription	Сериализованный json-сертификат X509.
CertificateDescription	Сертификат X509.
CertificateListDescription	Сериализованный в ФОРМАТЕ JSON массив объектов Certificate.
CertificateProperties	Описание сертификата ЦС X509.
CertificatePropertiesWithNonce	Описание сертификата ЦС X509, включая запрос nonce, выданный для потока подтверждения владения.
CertificateVerificationDescription	Сериализованный конечный сертификат JSON
CertificateWithNonceDescription	Сертификат X509.
Certificates	Интерфейс, представляющий сертификаты.
CertificatesCreateOrUpdateOptionalParams	Дополнительные параметры.
CertificatesDeleteOptionalParams	Дополнительные параметры.
CertificatesGenerateVerificationCodeOptionalParams	Дополнительные параметры.
CertificatesGetOptionalParams	Дополнительные параметры.
CertificatesListByIotHubOptionalParams	Дополнительные параметры.
CertificatesVerifyOptionalParams	Дополнительные параметры.
CloudToDeviceProperties	Свойства обмена сообщениями из облака на устройство в Центре Интернета вещей.
EndpointHealthData	Данные о работоспособности для конечной точки
EndpointHealthDataListResult	Сериализованный в формате JSON массив объектов EndpointHealthData со следующей ссылкой.
EnrichmentProperties	Свойства обогащения, которые центр Интернета вещей применяет к сообщениям, доставленным в конечные точки.
ErrorDetails	Сведения об ошибке.
EventHubConsumerGroupBodyDescription	Группа потребителей EventHub.
EventHubConsumerGroupInfo	Свойства объекта EventHubConsumerGroupInfo.
EventHubConsumerGroupName	Имя группы потребителей EventHub.
EventHubConsumerGroupsListResult	Сериализованный в ФОРМАТЕ JSON массив имен групп потребителей, совместимых с Концентратором событий, со следующей ссылкой.
EventHubProperties	Свойства подготовленной конечной точки, совместимой с концентратором событий, используемой Центром Интернета вещей.
ExportDevicesRequest	Используйте для предоставления параметров при запросе экспорта всех устройств в Центре Интернета вещей.
FailoverInput	Используйте для предоставления региона отработки отказа при запросе отработки отказа вручную для концентратора.
FallbackRouteProperties	Свойства резервного маршрута. Центр Интернета вещей использует эти свойства при маршрутизации сообщений в резервную конечную точку.
FeedbackProperties	Свойства очереди отзывов для сообщений из облака на устройство.
GroupIdInformation	Сведения о группе для создания частной конечной точки в IotHub
GroupIdInformationProperties	Свойства объекта сведений о группе
ImportDevicesRequest	Используйте для предоставления параметров при запросе импорта всех устройств в концентраторе.
IotHub	Интерфейс, представляющий Веб-сайт Интернета вещей.
IotHubCapacity	Центр Интернета вещей сведения о емкости.
IotHubClientOptionalParams	Дополнительные параметры.
IotHubDescription	Описание Центра Интернета вещей.
IotHubDescriptionListResult	Сериализованный в ФОРМАТЕ JSON массив объектов IotHubDescription со следующей ссылкой.
IotHubLocationDescription	Общедоступное представление одного из расположений, где подготовлен ресурс.
IotHubManualFailoverHeaders	Определяет заголовки для операции IotHub_manualFailover.
IotHubManualFailoverOptionalParams	Дополнительные параметры.
IotHubNameAvailabilityInfo	Свойства, указывающие, доступно ли заданное имя Центра Интернета вещей.
IotHubProperties	Свойства Центра Интернета вещей.
IotHubQuotaMetricInfo	Свойства метрик квоты.
IotHubQuotaMetricInfoListResult	Сериализованный в ФОРМАТЕ JSON массив объектов IotHubQuotaMetricInfo со следующей ссылкой.
IotHubResource	Интерфейс, представляющий IotHubResource.
IotHubResourceCheckNameAvailabilityOptionalParams	Дополнительные параметры.
IotHubResourceCreateEventHubConsumerGroupOptionalParams	Дополнительные параметры.
IotHubResourceCreateOrUpdateOptionalParams	Дополнительные параметры.
IotHubResourceDeleteEventHubConsumerGroupOptionalParams	Дополнительные параметры.
IotHubResourceDeleteHeaders	Определяет заголовки для операции IotHubResource_delete.
IotHubResourceDeleteOptionalParams	Дополнительные параметры.
IotHubResourceExportDevicesOptionalParams	Дополнительные параметры.
IotHubResourceGetEndpointHealthNextOptionalParams	Дополнительные параметры.
IotHubResourceGetEndpointHealthOptionalParams	Дополнительные параметры.
IotHubResourceGetEventHubConsumerGroupOptionalParams	Дополнительные параметры.
IotHubResourceGetJobOptionalParams	Дополнительные параметры.
IotHubResourceGetKeysForKeyNameOptionalParams	Дополнительные параметры.
IotHubResourceGetOptionalParams	Дополнительные параметры.
IotHubResourceGetQuotaMetricsNextOptionalParams	Дополнительные параметры.
IotHubResourceGetQuotaMetricsOptionalParams	Дополнительные параметры.
IotHubResourceGetStatsOptionalParams	Дополнительные параметры.
IotHubResourceGetValidSkusNextOptionalParams	Дополнительные параметры.
IotHubResourceGetValidSkusOptionalParams	Дополнительные параметры.
IotHubResourceImportDevicesOptionalParams	Дополнительные параметры.
IotHubResourceListByResourceGroupNextOptionalParams	Дополнительные параметры.
IotHubResourceListByResourceGroupOptionalParams	Дополнительные параметры.
IotHubResourceListBySubscriptionNextOptionalParams	Дополнительные параметры.
IotHubResourceListBySubscriptionOptionalParams	Дополнительные параметры.
IotHubResourceListEventHubConsumerGroupsNextOptionalParams	Дополнительные параметры.
IotHubResourceListEventHubConsumerGroupsOptionalParams	Дополнительные параметры.
IotHubResourceListJobsNextOptionalParams	Дополнительные параметры.
IotHubResourceListJobsOptionalParams	Дополнительные параметры.
IotHubResourceListKeysNextOptionalParams	Дополнительные параметры.
IotHubResourceListKeysOptionalParams	Дополнительные параметры.
IotHubResourceTestAllRoutesOptionalParams	Дополнительные параметры.
IotHubResourceTestRouteOptionalParams	Дополнительные параметры.
IotHubResourceUpdateOptionalParams	Дополнительные параметры.
IotHubSkuDescription	Свойства SKU.
IotHubSkuDescriptionListResult	Сериализованный json массив объектов IotHubSkuDescription со следующей ссылкой.
IotHubSkuInfo	Сведения о номере SKU Центра Интернета вещей.
IpFilterRule	Правила фильтрации IP-адресов для Центра Интернета вещей.
JobResponse	Свойства объекта Job Response.
JobResponseListResult	Сериализованный json массив объектов JobResponse со следующей ссылкой.
ManagedIdentity	Свойства управляемого удостоверения.
MatchedRoute	Совпадающие маршруты
MessagingEndpointProperties	Свойства конечных точек обмена сообщениями, используемых этим Центром Интернета вещей.
Name	Имя типа Центра Интернета вещей
NetworkRuleSetIpRule	Правило IP, применяемое как часть набора сетевых правил
NetworkRuleSetProperties	Свойства набора правил сети в IotHub
Operation	операция ЦЕНТР ИНТЕРНЕТА ВЕЩЕЙ REST API
OperationDisplay	Объект , представляющий операцию.
OperationInputs	Входные значения.
OperationListResult	Результат запроса на перечисление Центр Интернета вещей операций. Он содержит список операций и URL-ссылку для получения следующего набора результатов.
Operations	Интерфейс, представляющий операции.
OperationsListNextOptionalParams	Дополнительные параметры.
OperationsListOptionalParams	Дополнительные параметры.
PrivateEndpoint	Свойство частной конечной точки подключения к частной конечной точке
PrivateEndpointConnection	Подключение к частной конечной точке центра Интернета вещей
PrivateEndpointConnectionProperties	Свойства подключения к частной конечной точке
PrivateEndpointConnections	Интерфейс, представляющий PrivateEndpointConnections.
PrivateEndpointConnectionsDeleteHeaders	Определяет заголовки для операции PrivateEndpointConnections_delete.
PrivateEndpointConnectionsDeleteOptionalParams	Дополнительные параметры.
PrivateEndpointConnectionsGetOptionalParams	Дополнительные параметры.
PrivateEndpointConnectionsListOptionalParams	Дополнительные параметры.
PrivateEndpointConnectionsUpdateOptionalParams	Дополнительные параметры.
PrivateLinkResources	Доступные ресурсы приватного канала для IotHub
PrivateLinkResourcesGetOptionalParams	Дополнительные параметры.
PrivateLinkResourcesListOptionalParams	Дополнительные параметры.
PrivateLinkResourcesOperations	Интерфейс, представляющий PrivateLinkResourcesOperations.
PrivateLinkServiceConnectionState	Текущее состояние подключения к частной конечной точке
RegistryStatistics	Статистика реестра удостоверений.
Resource	Общие свойства ресурса Azure.
ResourceProviderCommon	Интерфейс, представляющий ResourceProviderCommon.
ResourceProviderCommonGetSubscriptionQuotaOptionalParams	Дополнительные параметры.
RouteCompilationError	Ошибка компиляции при оценке маршрута
RouteErrorPosition	Позиция, в которой произошла ошибка маршрута
RouteErrorRange	Диапазон ошибок маршрута
RouteProperties	Свойства правила маршрутизации, которое центр Интернета вещей использует для маршрутизации сообщений в конечные точки.
RoutingCosmosDBSqlApiProperties	Свойства, связанные с конечной точкой контейнера SQL cosmos DB.
RoutingEndpoints	Свойства, связанные с пользовательскими конечными точками, в которые центр Интернета вещей направляет сообщения на основе правил маршрутизации. Для платных концентраторов разрешено не более 10 пользовательских конечных точек для всех типов конечных точек, а для бесплатных концентраторов — только 1 пользовательская конечная точка.
RoutingEventHubProperties	Свойства, связанные с конечной точкой концентратора событий.
RoutingMessage	Сообщение маршрутизации
RoutingProperties	Свойства, связанные с маршрутизацией Центра Интернета вещей. См. статью: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Свойства, связанные с типами конечных точек очереди служебной шины.
RoutingServiceBusTopicEndpointProperties	Свойства, связанные с типами конечных точек раздела служебной шины.
RoutingStorageContainerProperties	Свойства, связанные с конечной точкой контейнера хранилища.
RoutingTwin	Входной параметр ссылки на двойник. Это необязательный параметр
RoutingTwinProperties
SharedAccessSignatureAuthorizationRule	Свойства политики общего доступа к Центру Интернета вещей.
SharedAccessSignatureAuthorizationRuleListResult	Список политик общего доступа со следующей ссылкой.
StorageEndpointProperties	Свойства конечной точки службы хранилища Azure для отправки файлов.
SystemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
TagsResource	Контейнер, содержащий только теги для ресурса, что позволяет пользователю обновлять теги в экземпляре Центр Интернета вещей.
TestAllRoutesInput	Входные данные для тестирования всех маршрутов
TestAllRoutesResult	Результат тестирования всех маршрутов
TestRouteInput	Входные данные для тестирования маршрута
TestRouteResult	Результат тестирования одного маршрута
TestRouteResultDetails	Подробный результат тестирования маршрута
UserSubscriptionQuota	Ответ на квоту подписки пользователя
UserSubscriptionQuotaListResult	Сериализованный массив JSON ответа на квоту подписки пользователя

Псевдонимы типа

AccessRights	Определяет значения для AccessRights.
AuthenticationType	Определяет значения authenticationType. KnownAuthenticationType можно использовать взаимозаменяемо с AuthenticationType. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой keyBased identityBased
Capabilities	Определяет значения для возможностей. KnownCapabilities можно использовать взаимозаменяемо с возможностями. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой None DeviceManagement
CertificatesCreateOrUpdateResponse	Содержит данные ответа для операции createOrUpdate.
CertificatesGenerateVerificationCodeResponse	Содержит данные ответа для операции generateVerificationCode.
CertificatesGetResponse	Содержит данные ответа для операции получения.
CertificatesListByIotHubResponse	Содержит данные ответа для операции listByIotHub.
CertificatesVerifyResponse	Содержит данные ответа для операции проверки.
CreatedByType	Определяет значения для CreatedByType. KnownCreatedByType можно использовать взаимозаменяемо с CreatedByType. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Пользователь Приложение ManagedIdentity Key
DefaultAction	Определяет значения для DefaultAction. KnownDefaultAction можно использовать взаимозаменяемо с DefaultAction. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Запретить Разрешить
EndpointHealthStatus	Определяет значения для EndpointHealthStatus. KnownEndpointHealthStatus можно использовать взаимозаменяемо с EndpointHealthStatus. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Неизвестный Здорового Деградированных Нездоровой не действует
IotHubNameUnavailabilityReason	Определяет значения для IotHubNameUnavailabilityReason.
IotHubReplicaRoleType	Определяет значения для IotHubReplicaRoleType. KnownIotHubReplicaRoleType можно использовать взаимозаменяемо с IotHubReplicaRoleType. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Основной Вторичного
IotHubResourceCheckNameAvailabilityResponse	Содержит данные ответа для операции checkNameAvailability.
IotHubResourceCreateEventHubConsumerGroupResponse	Содержит данные ответа для операции createEventHubConsumerGroup.
IotHubResourceCreateOrUpdateResponse	Содержит данные ответа для операции createOrUpdate.
IotHubResourceDeleteResponse	Содержит данные ответа для операции удаления.
IotHubResourceExportDevicesResponse	Содержит данные ответа для операции exportDevices.
IotHubResourceGetEndpointHealthNextResponse	Содержит данные ответа для операции getEndpointHealthNext.
IotHubResourceGetEndpointHealthResponse	Содержит данные ответа для операции getEndpointHealth.
IotHubResourceGetEventHubConsumerGroupResponse	Содержит данные ответа для операции getEventHubConsumerGroup.
IotHubResourceGetJobResponse	Содержит данные ответа для операции getJob.
IotHubResourceGetKeysForKeyNameResponse	Содержит данные ответа для операции getKeysForKeyName.
IotHubResourceGetQuotaMetricsNextResponse	Содержит данные ответа для операции getQuotaMetricsNext.
IotHubResourceGetQuotaMetricsResponse	Содержит данные ответа для операции getQuotaMetrics.
IotHubResourceGetResponse	Содержит данные ответа для операции получения.
IotHubResourceGetStatsResponse	Содержит данные ответа для операции getStats.
IotHubResourceGetValidSkusNextResponse	Содержит данные ответа для операции getValidSkusNext.
IotHubResourceGetValidSkusResponse	Содержит данные ответа для операции getValidSkus.
IotHubResourceImportDevicesResponse	Содержит данные ответа для операции importDevices.
IotHubResourceListByResourceGroupNextResponse	Содержит данные ответа для операции listByResourceGroupNext.
IotHubResourceListByResourceGroupResponse	Содержит данные ответа для операции listByResourceGroup.
IotHubResourceListBySubscriptionNextResponse	Содержит данные ответа для операции listBySubscriptionNext.
IotHubResourceListBySubscriptionResponse	Содержит данные ответа для операции listBySubscription.
IotHubResourceListEventHubConsumerGroupsNextResponse	Содержит данные ответа для операции listEventHubConsumerGroupsNext.
IotHubResourceListEventHubConsumerGroupsResponse	Содержит данные ответа для операции listEventHubConsumerGroups.
IotHubResourceListJobsNextResponse	Содержит данные ответа для операции listJobsNext.
IotHubResourceListJobsResponse	Содержит данные ответа для операции listJobs.
IotHubResourceListKeysNextResponse	Содержит данные ответа для операции listKeysNext.
IotHubResourceListKeysResponse	Содержит данные ответа для операции listKeys.
IotHubResourceTestAllRoutesResponse	Содержит данные ответа для операции testAllRoutes.
IotHubResourceTestRouteResponse	Содержит данные ответа для операции testRoute.
IotHubResourceUpdateResponse	Содержит данные ответа для операции обновления.
IotHubScaleType	Определяет значения для IotHubScaleType.
IotHubSku	Определяет значения для IotHubSku. KnownIotHubSku можно использовать взаимозаменяемо с IotHubSku. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой F1 S1 S2 S3 B1 B2 B3
IotHubSkuTier	Определяет значения для IotHubSkuTier.
IpFilterActionType	Определяет значения для IpFilterActionType.
JobStatus	Определяет значения для JobStatus.
JobType	Определяет значения для JobType. KnownJobType можно использовать взаимозаменяемо с JobType. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Неизвестный export import Резервного копирования readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice FirmwareUpdate
NetworkRuleIPAction	Определяет значения для NetworkRuleIPAction. KnownNetworkRuleIPAction можно использовать взаимозаменяемо с NetworkRuleIPAction. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Разрешить
OperationsListNextResponse	Содержит данные ответа для операции listNext.
OperationsListResponse	Содержит данные ответа для операции со списком.
PrivateEndpointConnectionsDeleteResponse	Содержит данные ответа для операции удаления.
PrivateEndpointConnectionsGetResponse	Содержит данные ответа для операции получения.
PrivateEndpointConnectionsListResponse	Содержит данные ответа для операции со списком.
PrivateEndpointConnectionsUpdateResponse	Содержит данные ответа для операции обновления.
PrivateLinkResourcesGetResponse	Содержит данные ответа для операции получения.
PrivateLinkResourcesListResponse	Содержит данные ответа для операции со списком.
PrivateLinkServiceConnectionStatus	Определяет значения для PrivateLinkServiceConnectionStatus. KnownPrivateLinkServiceConnectionStatus можно использовать взаимозаменяемо с PrivateLinkServiceConnectionStatus. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Ожидание Approved Отклонено Отключена
PublicNetworkAccess	Определяет значения для PublicNetworkAccess. KnownPublicNetworkAccess можно использовать взаимозаменяемо с PublicNetworkAccess. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Enabled Отключено
ResourceIdentityType	Определяет значения для ResourceIdentityType.
ResourceProviderCommonGetSubscriptionQuotaResponse	Содержит данные ответа для операции getSubscriptionQuota.
RouteErrorSeverity	Определяет значения для RouteErrorSeverity. KnownRouteErrorSeverity можно использовать взаимозаменяемо с RouteErrorSeverity. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой error warning
RoutingSource	Определяет значения для RoutingSource. KnownRoutingSource можно использовать взаимозаменяемо с RoutingSource. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Недопустимо DeviceMessages TwinChangeEvents DeviceLifecycleEvents DeviceJobLifecycleEvents DeviceConnectionStateEvents
RoutingStorageContainerPropertiesEncoding	Определяет значения для RoutingStorageContainerPropertiesEncoding. KnownRoutingStorageContainerPropertiesEncoding можно использовать взаимозаменяемо с RoutingStorageContainerPropertiesEncoding. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Avro AvroDeflate JSON
TestResultStatus	Определяет значения для TestResultStatus. KnownTestResultStatus можно использовать взаимозаменяемо с TestResultStatus. Это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой неопределенный false true

Перечисления

KnownAuthenticationType	Известные значения AuthenticationType , которые принимает служба.
KnownCapabilities	Известные значения возможностей , которые принимает служба.
KnownCreatedByType	Известные значения CreatedByType , которые принимает служба.
KnownDefaultAction	Известные значения DefaultAction , которые принимает служба.
KnownEndpointHealthStatus	Известные значения EndpointHealthStatus , которые принимает служба.
KnownIotHubReplicaRoleType	Известные значения IotHubReplicaRoleType , которые принимает служба.
KnownIotHubSku	Известные значения IotHubSku , которые принимает служба.
KnownJobType	Известные значения JobType , которые принимает служба.
KnownNetworkRuleIPAction	Известные значения NetworkRuleIPAction , которые принимает служба.
KnownPrivateLinkServiceConnectionStatus	Известные значения PrivateLinkServiceConnectionStatus , которые принимает служба.
KnownPublicNetworkAccess	Известные значения PublicNetworkAccess , которые принимает служба.
KnownRouteErrorSeverity	Известные значения RouteErrorSeverity , которые принимает служба.
KnownRoutingSource	Известные значения RoutingSource , которые принимает служба.
KnownRoutingStorageContainerPropertiesEncoding	Известные значения RoutingStorageContainerPropertiesEncoding , которые принимает служба.
KnownTestResultStatus	Известные значения TestResultStatus , которые принимает служба.

Функции

getContinuationToken(unknown)

С учетом последнего .value , созданного итератором byPage , возвращает маркер продолжения, который можно использовать для начала разбиения по страницам с этого момента позже.

Сведения о функции

getContinuationToken(unknown)

С учетом последнего .value , созданного итератором byPage , возвращает маркер продолжения, который можно использовать для начала разбиения по страницам с этого момента позже.

function getContinuationToken(page: unknown): string | undefined

Параметры

page

unknown

Объект, который получает доступ к value IteratorResult из итератора byPage .

Возвращаемое значение

string | undefined

Маркер продолжения, который может быть передан в byPage() во время будущих вызовов.