@azure/arm-iothub package
Классы
IotHubClient |
Интерфейсы
ArmIdentity | |
ArmUserIdentity | |
CertificateBodyDescription |
Сериализованный в ФОРМАТЕ JSON сертификат X509. |
CertificateDescription |
Сертификат X509. |
CertificateListDescription |
Сериализованный в ФОРМАТЕ JSON массив объектов Certificate. |
CertificateProperties |
Описание сертификата ЦС X509. |
CertificatePropertiesWithNonce |
Описание сертификата ЦС X509, включая запрос, выданный для потока proof-Of-Possession. |
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 |
Интерфейс, представляющий 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 |
Имя типа Iot Hub |
NetworkRuleSetIpRule |
Правило IP для применения в составе набора сетевых правил |
NetworkRuleSetProperties |
Свойства набора правил сети IotHub |
Operation |
Операция REST API Центра Интернета вещей |
OperationDisplay |
Объект, представляющий операцию. |
OperationInputs |
Входные значения. |
OperationListResult |
Результат запроса на перечисление операций Центра Интернета вещей. Он содержит список операций и URL-ссылку, чтобы получить следующий набор результатов. |
Operations |
Интерфейс, представляющий операции. |
OperationsListNextOptionalParams |
Необязательные параметры. |
OperationsListOptionalParams |
Необязательные параметры. |
PrivateEndpoint |
Свойство частной конечной точки подключения частной конечной точки |
PrivateEndpointConnection |
Подключение частной конечной точки iotHub |
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. Известные значения, поддерживаемые службой
keyBased |
Capabilities |
Определяет значения возможностей. Известные значения, поддерживаемые службой
Нет |
CertificatesCreateOrUpdateResponse |
Содержит данные ответа для операции createOrUpdate. |
CertificatesGenerateVerificationCodeResponse |
Содержит данные ответа для операции generateVerificationCode. |
CertificatesGetResponse |
Содержит данные ответа для операции получения. |
CertificatesListByIotHubResponse |
Содержит данные ответа для операции listByIotHub. |
CertificatesVerifyResponse |
Содержит данные ответа для операции проверки. |
CreatedByType |
Определяет значения для CreatedByType. Известные значения, поддерживаемые службой
user |
DefaultAction |
Определяет значения для DefaultAction. Известные значения, поддерживаемые службой
запретить |
EndpointHealthStatus |
Определяет значения для EndpointHealthStatus. Известные значения, поддерживаемые службойнеизвестный |
IotHubNameUnavailabilityReason |
Определяет значения для IotHubNameUnavailabilityReason. |
IotHubReplicaRoleType |
Определяет значения для 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. Известные значения, поддерживаемые службой
F1 |
IotHubSkuTier |
Определяет значения для IotHubSkuTier. |
IpFilterActionType |
Определяет значения для IpFilterActionType. |
JobStatus |
Определяет значения для JobStatus. |
JobType |
Определяет значения для JobType. Известные значения, поддерживаемые службойнеизвестный |
NetworkRuleIPAction |
Определяет значения для NetworkRuleIPAction. Известные значения, поддерживаемые службойразрешить |
OperationsListNextResponse |
Содержит данные ответа для операции listNext. |
OperationsListResponse |
Содержит данные ответа для операции списка. |
PrivateEndpointConnectionsDeleteResponse |
Содержит данные ответа для операции удаления. |
PrivateEndpointConnectionsGetResponse |
Содержит данные ответа для операции получения. |
PrivateEndpointConnectionsListResponse |
Содержит данные ответа для операции списка. |
PrivateEndpointConnectionsUpdateResponse |
Содержит данные ответа для операции обновления. |
PrivateLinkResourcesGetResponse |
Содержит данные ответа для операции получения. |
PrivateLinkResourcesListResponse |
Содержит данные ответа для операции списка. |
PrivateLinkServiceConnectionStatus |
Определяет значения для PrivateLinkServiceConnectionStatus. Известные значения, поддерживаемые службой
ожидающих |
PublicNetworkAccess |
Определяет значения для PublicNetworkAccess. Известные значения, поддерживаемые службой
включено |
ResourceIdentityType |
Определяет значения для ResourceIdentityType. |
ResourceProviderCommonGetSubscriptionQuotaResponse |
Содержит данные ответа для операции getSubscriptionQuota. |
RouteErrorSeverity |
Определяет значения для RouteErrorSeverity. Известные значения, поддерживаемые службойошибка |
RoutingSource |
Определяет значения для RoutingSource. Известные значения, поддерживаемые службой
недопустимые |
RoutingStorageContainerPropertiesEncoding |
Определяет значения для RoutingStorageContainerPropertiesEncoding. Известные значения, поддерживаемые службой
Avro |
TestResultStatus |
Определяет значения для TestResultStatus. Известные значения, поддерживаемые службой
неопределенный |
Перечисления
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, которые служба принимает. |
Функции
get |
Учитывая последний |
Сведения о функции
getContinuationToken(unknown)
Учитывая последний .value
, созданный byPage
итератором, возвращает маркер продолжения, который можно использовать для начала разбиения по страницам с этой точки позже.
function getContinuationToken(page: unknown): string | undefined
Параметры
- page
-
unknown
Объект от доступа к value
на итераторе IteratorResult из byPage
итератора.
Возвращаемое значение
string | undefined
Маркер продолжения, который можно передать в byPage() во время будущих вызовов.