Поделиться через


az iot hub

Примечание.

Эта группа команд содержит команды, определенные как в Azure CLI, так и в одном расширении. Установите каждое расширение, чтобы воспользоваться расширенными возможностями. Подробнее о расширениях.

Управление центрами Интернета вещей 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

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

Расширение ГА
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

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

Расширение ГА
az iot hub device-identity import

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

Расширение ГА
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 device-twin

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

Расширение ГА
az iot hub device-twin list

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

Расширение ГА
az iot hub device-twin replace

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

Расширение ГА
az iot hub device-twin show

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

Расширение ГА
az iot hub device-twin update

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

Расширение ГА
az iot hub devicestream

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

Ядро Предварительный просмотр
az iot hub devicestream show

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

Ядро Предварительный просмотр
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

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

Расширение ГА
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-endpoint

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

Расширение Предварительный просмотр
az iot hub message-endpoint create

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

Расширение Предварительный просмотр
az iot hub message-endpoint create cosmosdb-container

Добавьте конечную точку контейнера Cosmos DB для Центр Интернета вещей.

Расширение Предварительный просмотр
az iot hub message-endpoint create eventhub

Добавьте конечную точку Концентратора событий для Центр Интернета вещей.

Расширение Предварительный просмотр
az iot hub message-endpoint create servicebus-queue

Добавьте конечную точку очереди служебная шина для Центр Интернета вещей.

Расширение Предварительный просмотр
az iot hub message-endpoint create servicebus-topic

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

Расширение Предварительный просмотр
az iot hub message-endpoint create storage-container

Добавьте конечную точку контейнера хранилища для Центр Интернета вещей.

Расширение Предварительный просмотр
az iot hub message-endpoint delete

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

Расширение Предварительный просмотр
az iot hub message-endpoint list

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

Расширение Предварительный просмотр
az iot hub message-endpoint show

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

Расширение Предварительный просмотр
az iot hub message-endpoint update

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

Расширение Предварительный просмотр
az iot hub message-endpoint update cosmosdb-container

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

Расширение Предварительный просмотр
az iot hub message-endpoint update eventhub

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

Расширение Предварительный просмотр
az iot hub message-endpoint update servicebus-queue

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

Расширение Предварительный просмотр
az iot hub message-endpoint update servicebus-topic

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

Расширение Предварительный просмотр
az iot hub message-endpoint update storage-container

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

Расширение Предварительный просмотр
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 message-route

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

Расширение Предварительный просмотр
az iot hub message-route create

Добавьте маршрут для Центр Интернета вещей.

Расширение Предварительный просмотр
az iot hub message-route delete

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

Расширение Предварительный просмотр
az iot hub message-route fallback

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

Расширение Предварительный просмотр
az iot hub message-route fallback set

Включите или отключите резервный маршрут в Центр Интернета вещей.

Расширение Предварительный просмотр
az iot hub message-route fallback show

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

Расширение Предварительный просмотр
az iot hub message-route list

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

Расширение Предварительный просмотр
az iot hub message-route show

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

Расширение Предварительный просмотр
az iot hub message-route test

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

Расширение Предварительный просмотр
az iot hub message-route 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 show

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

Ядро ГА
az iot hub show-quota-metrics

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

Ядро ГА
az iot hub show-stats

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

Ядро ГА
az iot hub state

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

Расширение Экспериментальный
az iot hub state export

Экспорт состояния Центр Интернета вещей в файл.

Расширение Экспериментальный
az iot hub state import

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

Расширение Экспериментальный
az iot hub state migrate

Перенос состояния одного концентратора в другой, не сохраняя его в файл.

Расширение Экспериментальный
az iot hub update

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

Ядро ГА
az iot hub wait

Дождитесь завершения операции в экземпляре Центр Интернета вещей.

Ядро ГА

az iot hub create

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

Общие сведения о Центр Интернета вещей Azure см. в статье https://learn.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]
                  [--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]
                  [--no-wait]
                  [--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.

Default value: 10
--c2d-ttl --ct

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

Default value: 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, в которую отправляются файлы.

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

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

Default value: 10
--feedback-lock-duration --fld

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

Default value: 5
--feedback-ttl --ft

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

Default value: 1
--fileupload-notification-lock-duration --fnld

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

Default value: 5
--fileupload-notification-max-delivery-count --fnd

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

Default value: 10
--fileupload-notification-ttl --fnt

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

Default value: 1
--fileupload-notifications --fn

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

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

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

Default value: 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.0" или "1.2". Например, минимальная версия TLS с значением "1.2" приводит к отклонению клиентов, использующих версию TLS ниже 1.2.

--no-wait

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

Default value: False
--partition-count

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

Default value: 4
--rd --retention-day

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

Default value: 1
--role

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

--scopes

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

--sku

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

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

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

--unit

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

Default value: 1
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

az iot hub delete

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

az iot hub delete [--ids]
                  [--name]
                  [--no-wait]
                  [--resource-group]
                  [--subscription]

Примеры

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

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

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

--ids

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

--name -n

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

--no-wait

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

Default value: False
--resource-group -g

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

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

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 Центра Интернета вещей с помощью политики реестраRead и дополнительного ключа.

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
Default value: key
--connection-string --cs

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

--device-id -d

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

--du --duration

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

Default value: 3600
--hub-name -n

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

--key-type --kt

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

Допустимые значения: primary, secondary
Default value: primary
--login -l

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

--module-id -m

Идентификатор целевого модуля.

--pn --policy-name

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

Default value: iothubowner
--resource-group -g

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

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

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
Default value: key
--hub-name -n

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

--login -l

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

--method-payload --mp

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

Default value: {}
--resource-group -g

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

--timeout --to

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

Default value: 30
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

az iot hub invoke-module-method

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

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

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
Default value: key
--hub-name -n

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

--login -l

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

--method-payload --mp

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

Default value: {}
--resource-group -g

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

--timeout --to

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

Default value: 30
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

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>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

az iot hub list-skus

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

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

Примеры

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

az iot hub list-skus --name MyIoTHub

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

--ids

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

--name -n

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

--resource-group -g

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

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

az iot hub manual-failover

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

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

Примеры

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

az iot hub manual-failover -n myhub

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

--ids

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

--name -n

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

--no-wait

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

Default value: False
--resource-group -g

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

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

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]
                          [--mc]
                          [--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

Получите указанное количество сообщений из концентратора, а затем завершите работу.

az iot hub monitor-events -n {iothub_name} --message-count {message_count}

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

--cg --consumer-group -c

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

Default value: $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 не указано.

--mc --message-count

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

--module-id -m

Идентификатор целевого модуля.

--properties --props -p

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

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

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

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

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

--timeout --to -t

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

Default value: 300
--yes -y

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

Допустимые значения: false, true
Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

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
Default value: key
--device-id -d

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

--hub-name -n

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

--login -l

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

--repair -r

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

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

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

--wait-on-msg -w

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

--yes -y

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

Допустимые значения: false, true
Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

az iot hub query

Запрос к Центру Интернета вещей с помощью мощного языка SQL.

Получение сведений о двойниках устройств и модулях, заданиях и маршрутизации сообщений. См. https://learn.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
Default value: key
--hub-name -n

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

--login -l

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

--resource-group -g

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

--top

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

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

az iot hub show

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

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

Примеры

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

az iot hub show --name MyIoTHub

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

--ids

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

--name -n

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

--resource-group -g

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

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

az iot hub show-quota-metrics

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

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

Примеры

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

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>.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

az iot hub show-stats

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

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

Примеры

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

az iot hub show-stats --name MyIoTHub

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

--ids

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

--name -n

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

--resource-group -g

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

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

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]
                  [--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]
                  [--min-tls-version]
                  [--name]
                  [--rd]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--subscription]
                  [--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 устройства и модуля 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 or JSON string>.

Default value: []
--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, в которую отправляются файлы.

--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.

Default value: False
--ids

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

--min-tls-version --mintls

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

--name -n

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

--rd --retention-day

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

--remove

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

Default value: []
--resource-group -g

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

--set

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

Default value: []
--sku

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

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

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--tags

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

--unit

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

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

az iot hub wait

Дождитесь завершения операции в экземпляре Центр Интернета вещей.

az iot hub wait [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--ids]
                [--interval]
                [--name]
                [--resource-group]
                [--subscription]
                [--timeout]
                [--updated]

Примеры

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

az iot hub wait -n MyIoTHub --created

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

az iot hub wait -n MyIoTHub --deleted

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

az iot hub wait -n MyIoTHub --custom "properties.state=='Active'"

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

--created

Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".

Default value: False
--custom

Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].

--deleted

Дождитесь удаления.

Default value: False
--exists

Подождите, пока ресурс не существует.

Default value: False
--ids

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

--interval

Интервал опроса в секундах.

Default value: 30
--name -n

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

--resource-group -g

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

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--timeout

Максимальное ожидание в секундах.

Default value: 3600
--updated

Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".

Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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