az iot hub

Управление центрами Интернета вещей Azure.

Команды

az iot hub certificate

Управление сертификатами Центра Интернета вещей.

az iot hub certificate create

Создание или отправка сертификата Центр Интернета вещей Azure.

az iot hub certificate delete

Удаляет сертификат Центр Интернета вещей Azure.

az iot hub certificate generate-verification-code

Создает код проверки для сертификата Центр Интернета вещей Azure.

az iot hub certificate list

Выводит список всех сертификатов, содержащихся в Центр Интернета вещей Azure.

az iot hub certificate show

Отображает сведения о конкретном сертификате Центр Интернета вещей Azure.

az iot hub certificate update

Обновление сертификата Центр Интернета вещей Azure.

az iot hub certificate verify

Проверяет сертификат Центр Интернета вещей Azure.

az iot hub configuration

Реализовано управление конфигурацией автоматического управления устройствами в центре Интернета вещей в большом масштабе.

az iot hub configuration create

Создайте конфигурацию автоматического управления устройствами Интернета вещей в целевом Центр Интернета вещей.

az iot hub configuration delete

Удаление конфигурации устройства Интернета вещей.

az iot hub configuration list

Вывод списка конфигураций автоматического управления устройствами Интернета вещей в Центр Интернета вещей.

az iot hub configuration show

Получение сведений о конфигурации автоматического управления устройствами Интернета вещей.

az iot hub configuration show-metric

Оцените целевой пользователь или системную метрику, определенную в конфигурации устройства Интернета вещей.

az iot hub configuration update

Обновление указанных свойств конфигурации автоматического управления устройствами Интернета вещей.

Используйте параметр --set, за которым следуют назначения свойств для обновления конфигурации.

Примечание. Содержимое конфигурации неизменяемо. Свойства конфигурации, которые можно обновить: "метки", "метрики", "приоритет" и "targetCondition".

az iot hub connection-string

Управление строками подключения Центр Интернета вещей.

az iot hub connection-string show

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

az iot hub consumer-group

Управление группами потребителей концентратора событий Центра Интернета вещей.

az iot hub consumer-group create

Создайте группу потребителей концентратора событий.

az iot hub consumer-group delete

Удаление группы потребителей концентратора событий.

az iot hub consumer-group list

Вывод списка групп потребителей концентратора событий.

az iot hub consumer-group show

Получите сведения о группе потребителей концентратора событий.

az iot hub create

Создайте Центр Интернета вещей Azure.

az iot hub delete

Удаление Центра Интернета вещей.

az iot hub device-identity

Управление устройствами Интернета вещей.

az iot hub device-identity children

Управление связями дочерних устройств для устройств IoT Edge.

az iot hub device-identity children add

Добавление устройств в качестве дочерних элементов в целевое пограничное устройство.

az iot hub device-identity children list

Выводит коллекцию назначенных дочерних устройств.

az iot hub device-identity children remove

Удаление дочерних устройств с целевого пограничного устройства.

az iot hub device-identity connection-string

Управление строкой подключения устройства Интернета вещей.

az iot hub device-identity connection-string show

Отображение заданной строки подключения устройства Центр Интернета вещей.

az iot hub device-identity create

Создайте устройство в Центр Интернета вещей.

az iot hub device-identity delete

Удаление устройства Центр Интернета вещей.

az iot hub device-identity export

Экспортируйте все удостоверения устройств из Центр Интернета вещей в контейнер BLOB-объектов службы хранилища Azure. Чтобы просмотреть встроенные входные данные URI контейнера BLOB-объектов, ознакомьтесь с правилами ввода в вашей среде.

az iot hub device-identity import

Импорт удостоверений устройств в Центр Интернета вещей из большого двоичного объекта. Чтобы просмотреть встроенные входные данные URI контейнера BLOB-объектов, ознакомьтесь с правилами ввода в вашей среде.

az iot hub device-identity list

Вывод списка устройств в Центр Интернета вещей.

az iot hub device-identity parent

Управление связями родительских устройств для устройств Интернета вещей.

az iot hub device-identity parent set

Задайте родительское устройство целевого устройства.

az iot hub device-identity parent show

Получение родительского устройства целевого устройства.

az iot hub device-identity renew-key

Продление целевых ключей Центр Интернета вещей устройства с проверкой подлинности SAS.

az iot hub device-identity show

Получение сведений об устройстве Центр Интернета вещей.

az iot hub device-identity update

Обновите устройство Центр Интернета вещей.

az iot hub devicestream

Управление потоками устройств Центра Интернета вещей.

az iot hub devicestream show

Получение конечных точек потоков устройств Центр Интернета вещей.

az iot hub device-twin

Управление конфигурацией двойника устройств Интернета вещей.

az iot hub device-twin replace

Замените определение двойника устройства целевым json.

az iot hub device-twin show

Получение определения двойника устройства.

az iot hub device-twin update

Обновите требуемые свойства и теги двойника устройства.

az iot hub digital-twin

Управление цифровым двойником устройства Центр Интернета вещей и взаимодействие с ним.

az iot hub digital-twin invoke-command

Вызов команды корневого или компонента на уровне устройства цифрового двойника.

az iot hub digital-twin show

Отображение цифрового двойника устройства Центр Интернета вещей.

az iot hub digital-twin update

Обновление свойств устройства цифрового двойника с помощью спецификации исправления JSON.

az iot hub distributed-tracing

Управление распределенными параметрами для каждого устройства.

az iot hub distributed-tracing show

Получение параметров распределенной трассировки для устройства.

az iot hub distributed-tracing update

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

az iot hub generate-sas-token

Создайте маркер SAS для целевого Центр Интернета вещей, устройства или модуля.

az iot hub identity

Управление удостоверениями Центра Интернета вещей Azure.

az iot hub identity assign

Назначение управляемых удостоверений Центр Интернета вещей.

az iot hub identity remove

Удалите управляемые удостоверения из Центр Интернета вещей.

az iot hub identity show

Отображение свойств идентификатора Центр Интернета вещей.

az iot hub invoke-device-method

Вызов метода устройства.

az iot hub invoke-module-method

Вызов метода модуля Edge.

az iot hub job

Управление заданиями Центр Интернета вещей (версия 2).

az iot hub job cancel

Отмена задания Центр Интернета вещей.

az iot hub job create

Создание и планирование задания Центр Интернета вещей для выполнения.

az iot hub job list

Перечисление исторических заданий Центр Интернета вещей.

az iot hub job show

Отображение сведений о существующем задании Центр Интернета вещей.

az iot hub list

Вывод списка центров Интернета вещей.

az iot hub list-skus

Перечисление доступных ценовых категорий.

az iot hub manual-failover

Инициация перехода на другой ресурс вручную для Центра Интернета вещей в связанный географический регион аварийного восстановления.

az iot hub message-enrichment

Управление обогащением сообщений для конечных точек Центра Интернета вещей.

az iot hub message-enrichment create

Создайте обогащение сообщений для выбранных конечных точек в Центр Интернета вещей.

az iot hub message-enrichment delete

Удаление обогащения сообщений в Центре Интернета вещей (по ключу).

az iot hub message-enrichment list

Получите сведения обо всех обогащениях сообщений для Центр Интернета вещей.

az iot hub message-enrichment update

Обновление обогащения сообщений в Центре Интернета вещей (по ключу).

az iot hub module-identity

Управление модулями устройств Интернета вещей.

az iot hub module-identity connection-string

Управление строкой подключения модуля устройства Интернета вещей.

az iot hub module-identity connection-string show

Отображение строки подключения к целевому модулю устройства Интернета вещей.

az iot hub module-identity create

Создайте модуль на целевом устройстве Интернета вещей в Центр Интернета вещей.

az iot hub module-identity delete

Удаление устройства в Центр Интернета вещей.

az iot hub module-identity list

Вывод списка модулей, расположенных на устройстве Интернета вещей в Центр Интернета вещей.

az iot hub module-identity renew-key

Обновите целевые ключи модуля устройства Центр Интернета вещей с проверкой подлинности sas.

az iot hub module-identity show

Получение сведений о модуле устройства Интернета вещей в Центр Интернета вещей.

az iot hub module-identity update

Обновите модуль устройства Центр Интернета вещей.

az iot hub module-twin

Управление конфигурацией двойников устройств Интернета вещей.

az iot hub module-twin replace

Замените определение двойника модуля целевым json.

az iot hub module-twin show

Отображение определения двойника модуля.

az iot hub module-twin update

Обновите требуемые свойства и теги двойника модуля.

az iot hub monitor-events

Мониторинг телеметрии устройства & сообщений, отправленных в Центр Интернета вещей.

az iot hub monitor-feedback

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

az iot hub policy

Управление политиками общего доступа Центра Интернета вещей.

az iot hub policy create

Создайте новую политику общего доступа в Центре Интернета вещей.

az iot hub policy delete

Удаление политики общего доступа из Центра Интернета вещей.

az iot hub policy list

Вывод списка политик общего доступа центра Интернета вещей.

az iot hub policy renew-key

Повторно создайте ключи политики общего доступа центра Интернета вещей.

az iot hub policy show

Получение сведений о политике общего доступа центра Интернета вещей.

az iot hub query

Запрашивание Центра Интернета вещей с использованием мощного языка, подобного SQL.

az iot hub route

Управление маршрутами Центра Интернета вещей.

az iot hub route create

Создайте маршрут в Центр Интернета вещей.

az iot hub route delete

Удалите все или упомянутые маршруты для Центр Интернета вещей.

az iot hub route list

Получите все маршруты в Центр Интернета вещей.

az iot hub route show

Получение сведений о маршруте в Центр Интернета вещей.

az iot hub route test

Протестируйте все маршруты или упомянутые маршруты в Центр Интернета вещей.

az iot hub route update

Обновите маршрут в Центр Интернета вещей.

az iot hub routing-endpoint

Управление пользовательскими конечными точками Центра Интернета вещей.

az iot hub routing-endpoint create

Добавьте конечную точку в Центр Интернета вещей.

az iot hub routing-endpoint delete

Удалите все или упомянутые конечные точки для Центр Интернета вещей.

az iot hub routing-endpoint list

Получите сведения обо всех конечных точках для Центр Интернета вещей.

az iot hub routing-endpoint show

Получите сведения об указанной конечной точке для Центр Интернета вещей.

az iot hub show

Получение сведений о Центре Интернета вещей.

az iot hub show-connection-string

Отображение строк подключения для Центра Интернета вещей.

az iot hub show-quota-metrics

Получение метрик квоты для Центра Интернета вещей.

az iot hub show-stats

Получение статистики для Центра Интернета вещей.

az iot hub update

Обновление метаданных центра Интернета вещей.

az iot hub create

Создайте Центр Интернета вещей Azure.

Общие сведения о Центр Интернета вещей Azure см. в разделе https://docs.microsoft.com/azure/iot-hub/.

az iot hub create --name
                  --resource-group
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--dds {false, true}]
                  [--disable-local-auth {false, true}]
                  [--disable-module-sas {false, true}]
                  [--edr {false, true}]
                  [--fc]
                  [--fcs]
                  [--fcu]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-lock-duration]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type {identityBased, keyBased}]
                  [--fileupload-storage-identity]
                  [--location]
                  [--mi-system-assigned {false, true}]
                  [--mi-user-assigned]
                  [--min-tls-version]
                  [--partition-count]
                  [--rd]
                  [--role]
                  [--scopes]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--tags]
                  [--unit]

Примеры

Создайте Центр Интернета вещей с бесплатной ценовой категорией F1 в регионе группы ресурсов.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --sku F1 --partition-count 2

Создайте Центр Интернета вещей со стандартной ценовой категорией S1 и 4 секциями в регионе "westus" с тегами.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --tags a=b c=d

Создайте Центр Интернета вещей с управляемым удостоверением, назначаемого системой, и назначьте роль и область учетной записи хранения для созданного удостоверения.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --mi-system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}

Создание Центр Интернета вещей с локальной проверкой подлинности, ключами SAS устройства и ключами SAS модуля все отключены

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --disable-local-auth --disable-device-sas --disable-module-sas

Создайте Центр Интернета вещей с принудительным размещением данных. Это приведет к отключению аварийного восстановления между регионами.

az iot hub create --resource-group MyResourceGroup --name MyIoTHub --edr

Обязательные параметры

--name -n

Центр Интернета вещей имя.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

--c2d-max-delivery-count --cdd

Количество попыток доставки сообщения из облака на устройство в Центр Интернета вещей в диапазоне от 1 до 100.

значение по умолчанию: 10
--c2d-ttl --ct

Время, в течение которого устройство будет потреблять сообщение до истечения срока действия Центр Интернета вещей в диапазоне от 1 до 48 часов.

значение по умолчанию: 1
--dds --disable-device-sas

Логическое значение, указывающее, следует ли отключить все устройства (включая пограничные устройства, но за исключением модулей) ключи SAS для проверки подлинности.

допустимые значения: false, true
--disable-local-auth --dla

Логическое значение, указывающее, следует ли отключить ключи SAS для центра Интернета вещей для проверки подлинности.

допустимые значения: false, true
--disable-module-sas --dms

Логическое значение, указывающее, следует ли отключить ключи SAS на уровне модуля для проверки подлинности.

допустимые значения: false, true
--edr --enforce-data-residency

Принудительное размещение данных для этого Центр Интернета вещей путем отключения аварийного восстановления между регионами. Это свойство является неизменяемым после установки в ресурсе. Доступно только в выбранных регионах. Подробная информация собрана на странице https://aka.ms/iothubdisabledr.

допустимые значения: false, true
--fc --fileupload-storage-container-name

Имя корневого контейнера, куда отправляются файлы. Контейнер не должен существовать, но должен быть создан с помощью указанного connectionString.

--fcs --fileupload-storage-connectionstring

Строка подключения для учетной записи хранения Azure, в которую отправляются файлы.

--fcu --fileupload-storage-container-uri

URI контейнера для учетной записи хранения Azure, в которую отправляются файлы.

--fd --feedback-max-delivery-count

Количество попыток доставки сообщения в очереди отзывов в Центре Интернета вещей в диапазоне от 1 до 100.

значение по умолчанию: 10
--feedback-lock-duration --fld

Длительность блокировки для очереди отзывов в диапазоне от 5 до 300 секунд.

значение по умолчанию: 5
--feedback-ttl --ft

Период времени, в течение которого Центр Интернета вещей будет поддерживать отзывы об истечении срока действия или доставке сообщений из облака на устройство в диапазоне от 1 до 48 часов.

значение по умолчанию: 1
--fileupload-notification-lock-duration --fnld

Длительность блокировки очереди уведомлений о отправке файла в диапазоне от 5 до 300 секунд.

значение по умолчанию: 5
--fileupload-notification-max-delivery-count --fnd

Количество попыток доставки уведомления о файле в Центре Интернета вещей в диапазоне от 1 до 100.

значение по умолчанию: 10
--fileupload-notification-ttl --fnt

Время, в течение которого служба будет получать уведомление о отправке файла, до истечения срока действия Центр Интернета вещей в диапазоне от 1 до 48 часов.

значение по умолчанию: 1
--fileupload-notifications --fn

Логическое значение, указывающее, следует ли регистрировать сведения о отправленных файлах в конечную точку сообщений,servicebound/filenotifications Центр Интернета вещей.

допустимые значения: false, true
--fileupload-sas-ttl --fst

Срок действия URI SAS, созданного Центр Интернета вещей, действителен до истечения срока действия в диапазоне от 1 до 24 часов.

значение по умолчанию: 1
--fileupload-storage-auth-type --fsa

Тип проверки подлинности для учетной записи хранения Azure, в которую отправляются файлы.

допустимые значения: identityBased, keyBased
--fileupload-storage-identity --fsi

Управляемое удостоверение, используемое для проверки подлинности отправки файлов. Используйте [system], чтобы ссылаться на управляемое удостоверение, назначаемое системой, или идентификатор ресурса, чтобы ссылаться на управляемое удостоверение, назначаемое пользователем.

--location -l

Расположение Центр Интернета вещей. По умолчанию используется расположение группы целевых ресурсов.

--mi-system-assigned

Включите управляемое удостоверение, назначаемое системой, для этого концентратора.

допустимые значения: false, true
--mi-user-assigned

Включите управляемые удостоверения, назначаемые пользователем, для этого концентратора. Примите идентификаторы ресурсов удостоверений, разделенные пробелами.

--min-tls-version --mintls

Укажите минимальную версию TLS для поддержки этого концентратора. Можно задать значение 1.2, чтобы клиенты, использующие версию TLS ниже 1.2, отклонялись.

--partition-count

Количество секций резервного концентратора событий для сообщений, передаваемых с устройства в облако.

значение по умолчанию: 4
--rd --retention-day

Указывает, как долго этот центр Интернета вещей будет поддерживать события между устройством и облаком в диапазоне от 1 до 7 дней.

значение по умолчанию: 1
--role

Роль для назначения управляемому удостоверению, назначаемого системой концентратора.

--scopes

Разделенный пробелами список областей для назначения роли (--role) управляемому удостоверению, назначаемого системой.

--sku

Ценовая категория для Центр Интернета вещей Azure. Обратите внимание, что в каждой подписке разрешен только один бесплатный экземпляр Центра Интернета вещей (F1). Исключение возникает, если бесплатные экземпляры превышают один.

допустимые значения: B1, B2, B3, F1, S1, S2, S3
значение по умолчанию: S1
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--unit

Единицы в Центр Интернета вещей.

значение по умолчанию: 1

az iot hub delete

Удаление Центра Интернета вещей.

az iot hub delete [--ids]
                  [--name]
                  [--resource-group]

Примеры

Удаление Центра Интернета вещей. (автоматически создано)

az iot hub delete --name MyIoTHub --resource-group MyResourceGroup

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать --ids или другие аргументы Resource Id.

--name -n

Центр Интернета вещей имя.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

az iot hub generate-sas-token

Создайте маркер SAS для целевого Центр Интернета вещей, устройства или модуля.

Для маркеров SAS устройства параметр политики используется только для доступа к реестру устройств. Поэтому политика должна иметь доступ на чтение к реестру. Для Центр Интернета вещей маркеров политика является частью SAS.

az iot hub generate-sas-token [--auth-type {key, login}]
                              [--connection-string]
                              [--device-id]
                              [--du]
                              [--hub-name]
                              [--key-type {primary, secondary}]
                              [--login]
                              [--module-id]
                              [--pn]
                              [--resource-group]

Примеры

Создайте маркер SAS Центр Интернета вещей с помощью политики iothubowner и первичного ключа.

az iot hub generate-sas-token -n {iothub_name}

Создайте маркер SAS Центр Интернета вещей с помощью политики реестра и вторичного ключа.

az iot hub generate-sas-token -n {iothub_name} --policy registryRead --key-type secondary

Создайте маркер SAS устройства с помощью политики iothubowner для доступа к реестру устройств {iothub_name}.

az iot hub generate-sas-token -d {device_id} -n {iothub_name}

Создание маркера SAS устройства с помощью строки подключения Центр Интернета вещей (с доступом к реестру)

az iot hub generate-sas-token -d {device_id} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Создание маркера SAS Центра Интернета вещей с помощью строки подключения Центр Интернета вещей

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Создание маркера SAS устройства с помощью строки подключения устройства

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Создание маркера SAS модуля с помощью строки подключения модуля

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;ModuleId=mymodule;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Необязательные параметры

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Вы можете настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type=<auth-type-value>.

допустимые значения: key, login
значение по умолчанию: key
--connection-string --cs

Целевая строка подключения. Это обходит реестр Центр Интернета вещей и создает маркер SAS непосредственно из предоставленного симметричного ключа без дополнительной проверки. Все остальные параметры команды, кроме длительности, будут игнорироваться. Поддерживаемые типы строк подключения: Центр Интернета вещей, устройство, модуль.

--device-id -d

Целевое устройство.

--du --duration

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

значение по умолчанию: 3600
--hub-name -n

Центр Интернета вещей имя. Требуется, если параметр --login не указан.

--key-type --kt

Тип ключа политики общего доступа для проверки подлинности.

допустимые значения: primary, secondary
значение по умолчанию: primary
--login -l

Эта команда поддерживает строку подключения сущности с правами на выполнение действия. Используйте, чтобы избежать входа в сеанс с помощью az login. Если строка подключения сущности и имя предоставляются, строка подключения имеет приоритет. Требуется, если --hub-name не указано.

--module-id -m

Целевой модуль.

--pn --policy-name

Политика общего доступа с разрешениями операции для целевой сущности Центр Интернета вещей.

значение по умолчанию: iothubowner
--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

az iot hub invoke-device-method

Вызов метода устройства.

az iot hub invoke-device-method --device-id
                                --method-name
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--method-payload]
                                [--resource-group]
                                [--timeout]

Примеры

Вызов прямого метода на устройстве из облака.

az iot hub invoke-device-method --hub-name {iothub_name} --device-id {device_id} --method-name Reboot --method-payload '{"version":"1.0"}'

Обязательные параметры

--device-id -d

Целевое устройство.

--method-name --mn

Целевой метод для вызова.

Необязательные параметры

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Вы можете настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type=<auth-type-value>.

допустимые значения: key, login
значение по умолчанию: key
--hub-name -n

Центр Интернета вещей имя. Требуется, если параметр --login не указан.

--login -l

Эта команда поддерживает строку подключения сущности с правами на выполнение действия. Используйте, чтобы избежать входа в сеанс с помощью az login. Если указана строка подключения сущности и имя, строка подключения имеет приоритет. Требуется, если параметр --hub-name не указан.

--method-payload --mp

Полезные данные Json для передачи в метод. Должен быть путь к файлу или необработанный json.

значение по умолчанию: {}
--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--timeout --to

Максимальное количество секунд ожидания результата метода устройства.

значение по умолчанию: 30

az iot hub invoke-module-method

Вызов метода модуля Edge.

az iot hub invoke-module-method --device-id
                                --method-name
                                --module-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--method-payload]
                                [--resource-group]
                                [--timeout]

Примеры

Вызов прямого метода на пограничном устройстве с помощью модуля из облака.

az iot hub invoke-module-method -n {iothub_name} -d {device_id} -m '$edgeAgent' --method-name 'RestartModule' --method-payload '{"schemaVersion": "1.0"}'

Обязательные параметры

--device-id -d

Целевое устройство.

--method-name --mn

Целевой метод для вызова.

--module-id -m

Целевой модуль.

Необязательные параметры

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Вы можете настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type=<auth-type-value>.

допустимые значения: key, login
значение по умолчанию: key
--hub-name -n

Центр Интернета вещей имя. Требуется, если параметр --login не указан.

--login -l

Эта команда поддерживает строку подключения сущности с правами на выполнение действия. Используйте, чтобы избежать входа в сеанс с помощью az login. Если указана строка подключения сущности и имя, строка подключения имеет приоритет. Требуется, если параметр --hub-name не указан.

--method-payload --mp

Полезные данные Json для передачи в метод. Должен быть путь к файлу или необработанный json.

значение по умолчанию: {}
--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--timeout --to

Максимальное количество секунд ожидания результата метода устройства.

значение по умолчанию: 30

az iot hub list

Вывод списка центров Интернета вещей.

az iot hub list [--resource-group]

Примеры

Вывод списка всех центров Интернета вещей в подписке.

az iot hub list

Вывод списка всех центров Интернета вещей в группе ресурсов MyGroup

az iot hub list --resource-group MyGroup

Необязательные параметры

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

az iot hub list-skus

Перечисление доступных ценовых категорий.

az iot hub list-skus [--ids]
                     [--name]
                     [--resource-group]

Примеры

Перечисление доступных ценовых категорий. (автоматически сформировано)

az iot hub list-skus --name MyIoTHub

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать либо --ids, либо другие аргументы Resource Id.

--name -n

Центр Интернета вещей имя.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

az iot hub manual-failover

Инициация перехода на другой ресурс вручную для Центра Интернета вещей в связанный географический регион аварийного восстановления.

az iot hub manual-failover [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]

Примеры

Инициируйте отработку отказа myhub из основного в дополнительный регион.

az iot hub manual-failover -n myhub

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать либо --ids, либо другие аргументы Resource Id.

--name -n

Центр Интернета вещей имя.

--no-wait

Не ожидать завершения длительной операции.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

az iot hub monitor-events

Мониторинг телеметрии устройства & сообщений, отправленных в Центр Интернета вещей.

Эта команда используется и может устанавливать зависимый пакет Cython (uamqp) при первом выполнении. https://github.com/Azure/azure-uamqp-python.

az iot hub monitor-events [--cg]
                          [--content-type]
                          [--device-id]
                          [--device-query]
                          [--enqueued-time]
                          [--hub-name]
                          [--interface]
                          [--login]
                          [--module-id]
                          [--properties {all, anno, app, sys}]
                          [--repair {false, true}]
                          [--resource-group]
                          [--timeout]
                          [--yes {false, true}]

Примеры

Основное использование

az iot hub monitor-events -n {iothub_name}

Базовое использование со строкой подключения Центр Интернета вещей

az iot hub monitor-events -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Базовое использование при фильтрации на целевом устройстве

az iot hub monitor-events -n {iothub_name} -d {device_id}

Базовое использование при фильтрации целевых устройств с подстановочным знаком в идентификаторе

az iot hub monitor-events -n {iothub_name} -d Device*

Фильтрация устройств с помощью языка запросов Центр Интернета вещей

az iot hub monitor-events -n {iothub_name} -q "select * from devices where tags.location.region = 'US'"

Отфильтруйте устройство и укажите группу потребителей концентратора событий для привязки.

az iot hub monitor-events -n {iothub_name} -d {device_id} --cg {consumer_group_name}

Получение заметок к сообщениям (заголовки сообщений)

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno

Получение заметок сообщения + системных свойств. Никогда не истекает время ожидания.

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno sys --timeout 0

Получение всех атрибутов сообщений из всех сообщений устройства

az iot hub monitor-events -n {iothub_name} --props all

Получение всех сообщений и анализ полезных данных сообщений в формате JSON

az iot hub monitor-events -n {iothub_name} --content-type application/json

Необязательные параметры

--cg --consumer-group -c

Укажите группу потребителей, используемую при подключении к конечной точке концентратора событий.

значение по умолчанию: $Default
--content-type --ct

Укажите тип содержимого полезных данных сообщения, чтобы автоматически отформатировать выходные данные для этого типа.

--device-id -d

Целевое устройство.

--device-query -q

Укажите пользовательский запрос для фильтрации устройств.

--enqueued-time --et -e

Указывает время, которое следует использовать в качестве отправной точки для чтения сообщений из секций. Единицы измерения являются миллисекундами с эпохи UNIX. Если время не указано "сейчас", используется.

--hub-name -n

Центр Интернета вещей имя. Требуется, если параметр --login не указан.

--interface -i

Идентификатор целевого интерфейса для фильтрации. Например: dtmi:com:example:TemperatureController;1.

--login -l

Эта команда поддерживает строку подключения сущности с правами на выполнение действия. Используйте, чтобы избежать входа в сеанс с помощью az login. Если указана строка подключения сущности и имя, строка подключения имеет приоритет. Требуется, если параметр --hub-name не указан.

--module-id -m

Целевой модуль.

--properties --props -p

Укажите ключевые свойства сообщения для вывода. sys = системные свойства, приложение = свойства приложения, анно = заметки.

допустимые значения: all, anno, app, sys
--repair -r

Переустановите зависимость uamqp, совместимую с версией расширения. По умолчанию: false.

допустимые значения: false, true
--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--timeout --to -t

Максимальное количество секунд для поддержания подключения без получения сообщения. Используйте 0 для бесконечности.

значение по умолчанию: 300
--yes -y

Пропустите запросы пользователей. Указывает принятие установки зависимостей (при необходимости). Используется в основном для сценариев автоматизации. По умолчанию: false.

допустимые значения: false, true

az iot hub monitor-feedback

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

Эта команда используется и может устанавливать зависимый пакет Cython (uamqp) при первом выполнении. https://github.com/Azure/azure-uamqp-python.

az iot hub monitor-feedback [--auth-type {key, login}]
                            [--device-id]
                            [--hub-name]
                            [--login]
                            [--repair {false, true}]
                            [--resource-group]
                            [--wait-on-msg]
                            [--yes {false, true}]

Примеры

Основное использование

az iot hub monitor-feedback -n {iothub_name}

Базовое использование со строкой подключения Центр Интернета вещей

az iot hub monitor-feedback -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Базовое использование при фильтрации на целевом устройстве

az iot hub monitor-feedback -n {iothub_name} -d {device_id}

Выход из монитора обратной связи после получения сообщения с определенным идентификатором (uuid)

az iot hub monitor-feedback -n {iothub_name} -d {device_id} -w {message_id}

Необязательные параметры

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Вы можете настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type=<auth-type-value>.

допустимые значения: key, login
значение по умолчанию: key
--device-id -d

Целевое устройство.

--hub-name -n

Центр Интернета вещей имя. Требуется, если параметр --login не указан.

--login -l

Эта команда поддерживает строку подключения сущности с правами на выполнение действия. Используйте, чтобы избежать входа в сеанс с помощью az login. Если строка подключения сущности и имя предоставляются, строка подключения имеет приоритет. Требуется, если --hub-name не указано.

--repair -r

Переустановите зависимость uamqp, совместимую с версией расширения. По умолчанию: false.

допустимые значения: false, true
--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--wait-on-msg -w

Монитор отзывов блокируется до получения сообщения с определенным идентификатором (uuid).

--yes -y

Пропустите запросы пользователя. Указывает принятие установки зависимостей (при необходимости). Используется в основном для сценариев автоматизации. По умолчанию: false.

допустимые значения: false, true

az iot hub query

Запрашивание Центра Интернета вещей с использованием мощного языка, подобного SQL.

Запросите Центр Интернета вещей с помощью мощного языка SQL для получения сведений об двойниках устройств и модулей, заданиях и маршрутизации сообщений. Подробнее см. в разделе https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

az iot hub query --query-command
                 [--auth-type {key, login}]
                 [--hub-name]
                 [--login]
                 [--resource-group]
                 [--top]

Примеры

Запрос всех данных двойника устройства в Центр Интернета вещей Azure.

az iot hub query -n {iothub_name} -q "select * from devices"

Запрос всех данных двойника модуля на целевом устройстве.

az iot hub query -n {iothub_name} -q "select * from devices.modules where devices.deviceId = '{device_id}'"

Обязательные параметры

--query-command -q

Выполняемый пользовательский запрос.

Необязательные параметры

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Вы можете настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type=<auth-type-value>.

допустимые значения: key, login
значение по умолчанию: key
--hub-name -n

Центр Интернета вещей имя. Требуется, если параметр --login не указан.

--login -l

Эта команда поддерживает строку подключения сущности с правами на выполнение действия. Используйте, чтобы избежать входа в сеанс с помощью az login. Если строка подключения сущности и имя предоставляются, строка подключения имеет приоритет. Требуется, если --hub-name не указано.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--top

Максимальное количество возвращаемых элементов. По умолчанию запрос не имеет ограничения.

az iot hub show

Получение сведений о Центре Интернета вещей.

az iot hub show [--ids]
                [--name]
                [--resource-group]

Примеры

Получение сведений о Центре Интернета вещей. (автоматически создано)

az iot hub show --name MyIoTHub

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать --ids или другие аргументы Resource Id.

--name -n

Центр Интернета вещей имя.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

az iot hub show-connection-string

Отображение строк подключения для Центра Интернета вещей.

az iot hub show-connection-string [--all]
                                  [--hub-name]
                                  [--ids]
                                  [--key {primary, secondary}]
                                  [--policy-name]
                                  [--resource-group]

Примеры

Отображение строки подключения центра Интернета вещей с помощью политики по умолчанию и первичного ключа.

az iot hub show-connection-string --name MyIotHub

Отображение строки подключения Центр Интернета вещей с помощью политики service и дополнительного ключа.

az iot hub show-connection-string --name MyIotHub --policy-name service --key secondary

Отображение строк подключения для всех центров Интернета вещей в группе ресурсов.

az iot hub show-connection-string --resource-group MyResourceGroup

Отображение строк подключения для всех центров Интернета вещей в подписке.

az iot hub show-connection-string

Отображение строк подключения для Центра Интернета вещей. (автоматически создано)

az iot hub show-connection-string --key primary --policy-name MyPolicy

Необязательные параметры

--all

Разрешить отображение всех политик общего доступа.

--hub-name --name -n

Центр Интернета вещей имя.

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать --ids или другие аргументы Resource Id.

--key

Используемый ключ.

допустимые значения: primary, secondary
значение по умолчанию: primary
--policy-name

Политика общего доступа для использования.

значение по умолчанию: iothubowner
--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

az iot hub show-quota-metrics

Получение метрик квоты для Центра Интернета вещей.

az iot hub show-quota-metrics [--ids]
                              [--name]
                              [--resource-group]

Примеры

Получение метрик квоты для Центра Интернета вещей. (автоматически создано)

az iot hub show-quota-metrics --ids {ids}

Получение метрик квоты для Центра Интернета вещей. (автоматически создано)

az iot hub show-quota-metrics --name MyIoTHub

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать --ids или другие аргументы Resource Id.

--name -n

Центр Интернета вещей имя.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

az iot hub show-stats

Получение статистики для Центра Интернета вещей.

az iot hub show-stats [--ids]
                      [--name]
                      [--resource-group]

Примеры

Получение статистики для Центра Интернета вещей. (автоматически создано)

az iot hub show-stats --name MyIoTHub

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать --ids или другие аргументы Resource Id.

--name -n

Центр Интернета вещей имя.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

az iot hub update

Обновление метаданных центра Интернета вещей.

az iot hub update [--add]
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--dds {false, true}]
                  [--disable-local-auth {false, true}]
                  [--disable-module-sas {false, true}]
                  [--fc]
                  [--fcs]
                  [--fcu]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-lock-duration]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type {identityBased, keyBased}]
                  [--fileupload-storage-identity]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--rd]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--tags]
                  [--unit]

Примеры

Добавление параметров контейнера хранилища для отправки файлов

az iot hub update --name MyIotHub --fileupload-storage-connectionstring "connection-string" \ --fileupload-storage-container-name "container_name"

Добавьте правило фильтра брандмауэра для приема трафика из ip-маски 127.0.0.0/31.

az iot hub update --name MyIotHub --add properties.ipFilterRules filter_name=test-rule action=Accept ip_mask=127.0.0.0/31

Обновление метаданных центра Интернета вещей. (автоматически создано)

az iot hub update --name MyIotHub --set properties.allocationPolicy="GeoLatency"

Обновление единиц Центр Интернета вещей до 2 и добавление тегов

az iot hub update -n MyIotHub --unit 2 --tags a=b c=d

Обновление ценовой категории для Центр Интернета вещей как S2

az iot hub update -n MyIotHub --sku S2

Обновление дней хранения событий Центр Интернета вещей устройства в облако за 3 дня

az iot hub update -n MyIotHub --retention-day 3

Обновление Центр Интернета вещей параметров обмена сообщениями из облака на устройство

az iot hub update --name MyIotHub --c2d-max-delivery-count 30 --c2d-ttl 5

Обновление параметров очереди отзывов Центр Интернета вещей

az iot hub update --name MyIoTHub --feedback-max-delivery-count 20 --feedback-lock-duration 100 --feedback-ttl 4

Обновите параметры отправки файла Центр Интернета вещей и назначьте управляемое удостоверение пользователю для отправки файлов.

az iot hub update -n MyIoTHub --fileupload-sas-ttl 5 --fileupload-storage-auth-type identityBased --fileupload-storage-identity [system]

Обновление параметров уведомлений о отправке файла Центр Интернета вещей и длительность блокировки очереди

az iot hub update -n MyIoTHub --fileupload-notification-max-delivery-count 50 --fileupload-notification-ttl 48 --fileupload-notifications --fileupload-notification-lock-duration 10

Обновление параметров Центр Интернета вещей локальной проверки подлинности, SAS устройства и SAS модуля

az iot hub update -n MyIoTHub --disable-local-auth --disable-device-sas false --disable-module-sas true

Необязательные параметры

--add

Добавьте объект в список объектов, указав пары "путь" и "значение ключа". Пример: --add property.listProperty <key=value, string или JSON string>.

--c2d-max-delivery-count --cdd

Количество попыток доставки сообщения из облака на устройство в Центр Интернета вещей в диапазоне от 1 до 100.

--c2d-ttl --ct

Время, в течение которого устройство будет потреблять сообщение до истечения срока действия Центр Интернета вещей в диапазоне от 1 до 48 часов.

--dds --disable-device-sas

Логическое значение, указывающее, следует ли отключить все устройства (включая пограничные устройства, но за исключением модулей) ключи SAS для проверки подлинности.

допустимые значения: false, true
--disable-local-auth --dla

Логическое значение, указывающее, следует ли отключить ключи SAS для центра Интернета вещей для проверки подлинности.

допустимые значения: false, true
--disable-module-sas --dms

Логическое значение, указывающее, следует ли отключить ключи SAS на уровне модуля для проверки подлинности.

допустимые значения: false, true
--fc --fileupload-storage-container-name

Имя корневого контейнера, куда отправляются файлы. Контейнер не должен существовать, но должен быть создан с помощью указанного connectionString.

--fcs --fileupload-storage-connectionstring

Строка подключения для учетной записи хранения Azure, в которую отправляются файлы.

--fcu --fileupload-storage-container-uri

URI контейнера для учетной записи хранения Azure, в которую отправляются файлы.

--fd --feedback-max-delivery-count

Количество попыток доставки сообщения в очереди отзывов в Центре Интернета вещей в диапазоне от 1 до 100.

--feedback-lock-duration --fld

Длительность блокировки для очереди отзывов составляет от 5 до 300 секунд.

--feedback-ttl --ft

Период времени, в течение которого Центр Интернета вещей будет поддерживать обратную связь об истечении срока действия или доставке сообщений из облака на устройство в период от 1 до 48 часов.

--fileupload-notification-lock-duration --fnld

Длительность блокировки очереди уведомлений о отправке файлов составляет от 5 до 300 секунд.

--fileupload-notification-max-delivery-count --fnd

Количество попыток доставки уведомления о файле в центре Интернета вещей в диапазоне от 1 до 100.

--fileupload-notification-ttl --fnt

Время, в течение которого служба получает уведомление о отправке файла, до истечения срока действия Центр Интернета вещей от 1 до 48 часов.

--fileupload-notifications --fn

Логическое значение, указывающее, следует ли регистрировать сведения о отправленных файлах в конечную точку сообщений, служб и файлов Центр Интернета вещей.

допустимые значения: false, true
--fileupload-sas-ttl --fst

Срок действия URI SAS, созданного Центр Интернета вещей, действителен до истечения срока его действия в диапазоне от 1 до 24 часов.

--fileupload-storage-auth-type --fsa

Тип проверки подлинности для учетной записи хранения Azure, в которую отправляются файлы.

допустимые значения: identityBased, keyBased
--fileupload-storage-identity --fsi

Управляемое удостоверение, используемое для проверки подлинности отправки файлов. Используйте "[system]" для ссылки на управляемое удостоверение, назначаемое системой, или идентификатор ресурса, чтобы ссылаться на управляемое удостоверение, назначаемое пользователем.

--force-string

При использовании set или add сохраните строковые литералы вместо попытки преобразовать в JSON.

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать либо --ids, либо другие аргументы Resource Id.

--name -n

Центр Интернета вещей имя.

--rd --retention-day

Указывает, как долго этот Центр Интернета вещей будет обслуживать события между устройством и облаком в диапазоне от 1 до 7 дней.

--remove

Удаление свойства или элемента из списка. Пример: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=.

--sku

Ценовая категория для Центр Интернета вещей Azure. Обратите внимание, что в каждой подписке разрешен только один бесплатный экземпляр Центра Интернета вещей (F1). Исключение возникает, если количество свободных экземпляров превышает один.

допустимые значения: B1, B2, B3, F1, S1, S2, S3
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--unit

Единицы в Центр Интернета вещей.