azure-iothub package

Классы

Client

Клиент службы Центр Интернета вещей используется для взаимодействия с устройствами через Центр Интернета вещей Azure. Это позволяет пользователю пакета SDK:

  • отправка из облака на устройство (также известные как команды) на устройства: команды помещаются в очередь на Центр Интернета вещей и доставляются асинхронно только при подключении устройства. Для каждого устройства можно поместить в очередь только 50 команд.
  • вызов прямых методов на устройствах (которые будут работать только в том случае, если устройство подключено в данный момент: это синхронный способ взаимодействия с устройством).
  • прослушивать сообщения обратной связи, отправленные устройствами для предыдущих команд.
  • прослушивание уведомлений об отправке файлов с устройств.

Пользователи должны создавать новые Client экземпляры, вызывая один из методов фабрики изConnectionString или ИзSharedAccessSignature, чтобы создать клиент службы Центр Интернета вещей.

Device

Создает представление устройства для использования с API реестра удостоверений устройств .

Этот класс является устаревшим , так как реестр удостоверений устройств может работать непосредственно с объектами JSON, содержащими частичное описание устройства, не обязательно полный объект. Кроме того, изначально этот класс поставлялся с опечаткой на symmetricKey имени свойства (он был с регистром pascal вместо верблюда). Пакет SDK сохраняет этот класс, чтобы не нарушать существующий код, но он будет удален в будущем обновлении основной версии, и клиенты должны вместо этого использовать обычные объекты JSON.

JobClient

Предоставляет методы для создания, обновления, мониторинга и отмены длительных заданий в экземпляре Центр Интернета вещей, а также для запроса существующих заданий. API заданий в Центр Интернета вещей Azure позволяет планировать прямые вызовы методов и обновления двойников на нескольких устройствах.

Пользователи пакета SDK должны создавать JobClient экземпляры с помощью фабричного метода fromConnectionString(string) и fromSharedAccessSignature(string).

Registry

Класс Registry предоставляет доступ к Центр Интернета вещей службе удостоверений устройств. Пользователи пакета SDK должны создать экземпляр этого класса с помощью одного из фабричного метода: fromConnectionString или fromSharedAccessSignature.

Для операций с реестром удостоверений устройств используется протокол HTTPS.

Amqp

Класс транспорта, используемый клиентом службы для подключения к Центру Интернета вещей Azure по протоколу AMQP через безопасный сокет (TLS). Этот класс не следует использовать напрямую и передавать в один из Client фабричного метода: fromConnectionString или fromSharedAccessSignature.

AmqpWs

Класс транспорта, используемый клиентом службы для подключения к Центру Интернета вещей Azure по протоколу AMQP через безопасные веб-сокеты. Этот класс не следует использовать напрямую и передавать в один из Client фабричного метода: fromConnectionString или fromSharedAccessSignature.

DigitalTwinClient
IoTHubTokenCredentials

Создает подписанные URL-адреса на основе строки подключения, переданной конструктору. Этот класс используется протокольным уровнем пакета SDK для добавления заголовков проверки подлинности в каждый запрос.

Twin

Двойник устройства — это документ, описывающий состояние устройства, которое хранится в Центре Интернета вещей Azure и доступно, даже если устройство находится в автономном режиме. Он состоит из 3 разделов:

  • Теги: пары "ключ-значение", доступные только на стороне службы
  • Требуемые свойства: обновлены службой и получены устройством.
  • Сообщаемые свойства: обновлены устройством и получены службой.

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

Дополнительные сведения см. в разделе Основные сведения о двойниках устройств.

Рекомендуемый Twin способ получения для конкретного устройства — использовать getTwin(string, HttpResponseCallback<Twin>) метод .

Интерфейсы

ServiceReceiver
Transport
TransportConfigOptions
Authentication
Capabilities
X509Thumbprints
BulkRegistryOperationResult
DeviceDescription
DeviceRegistryOperationError
JobStatus
QueryDescription
RegistryStatistics
TransportConfig
Configuration

Объект Configuration представляет конфигурацию одного устройства или может представлять развертывание, которое можно применить в качестве конфигурации к устройствам на основе targetCondition.

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

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

Module

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

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback