az iot ops

Примечание.

Эта ссылка является частью расширения azure-iot-ops для Azure CLI (версия 2.46.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az iot ops . Подробнее о расширениях.

Эта группа команд находится в предварительной версии и в процессе разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

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

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

По умолчанию команды CLI Операций Интернета вещей периодически проверка, чтобы узнать, доступна ли новая версия расширения. Это поведение можно отключить с az config set iotops.check_latest=falseпомощью .

Команды

Имя Описание Тип Состояние
az iot ops asset

Управление ресурсами.

Расширение Предварительный просмотр
az iot ops asset create

Создайте ресурс.

Расширение Предварительный просмотр
az iot ops asset data-point

Управление точками данных в ресурсе.

Расширение Предварительный просмотр
az iot ops asset data-point add

Добавьте точку данных в ресурс.

Расширение Предварительный просмотр
az iot ops asset data-point export

Экспорт точек данных в ресурсе.

Расширение Предварительный просмотр
az iot ops asset data-point import

Импорт точек данных в ресурсе.

Расширение Предварительный просмотр
az iot ops asset data-point list

Вывод списка точек данных в ресурсе.

Расширение Предварительный просмотр
az iot ops asset data-point remove

Удалите точку данных в ресурсе.

Расширение Предварительный просмотр
az iot ops asset delete

Удаление ресурса.

Расширение Предварительный просмотр
az iot ops asset endpoint

Управление профилями конечных точек активов.

Расширение Предварительный просмотр
az iot ops asset endpoint certificate

Управление собственными сертификатами в конечной точке ресурса.

Расширение Предварительный просмотр
az iot ops asset endpoint certificate add

Добавьте собственный сертификат в конечную точку ресурса.

Расширение Предварительный просмотр
az iot ops asset endpoint certificate list

Вывод списка принадлежащих сертификатов в конечной точке ресурса.

Расширение Предварительный просмотр
az iot ops asset endpoint certificate remove

Удалите принадлежащий сертификат в конечной точке ресурса.

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

Создайте конечную точку ресурса.

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

Удаление конечной точки ресурса.

Расширение Предварительный просмотр
az iot ops asset endpoint query

Запрос графа ресурсов для конечных точек активов.

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

Отображение конечной точки ресурса.

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

Обновите конечную точку ресурса.

Расширение Предварительный просмотр
az iot ops asset event

Управление событиями в ресурсе.

Расширение Предварительный просмотр
az iot ops asset event add

Добавление события в ресурс.

Расширение Предварительный просмотр
az iot ops asset event export

Экспорт событий в ресурсе.

Расширение Предварительный просмотр
az iot ops asset event import

Импорт событий в ресурсе.

Расширение Предварительный просмотр
az iot ops asset event list

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

Расширение Предварительный просмотр
az iot ops asset event remove

Удаление события в ресурсе.

Расширение Предварительный просмотр
az iot ops asset query

Запрос графа ресурсов для ресурсов.

Расширение Предварительный просмотр
az iot ops asset show

Отображение ресурса.

Расширение Предварительный просмотр
az iot ops asset update

Обновление ресурса.

Расширение Предварительный просмотр
az iot ops check

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

Расширение Предварительный просмотр
az iot ops init

Начальная загрузка, настройка и развертывание операций Интернета вещей в целевом кластере с поддержкой arc.

Расширение Предварительный просмотр
az iot ops mq

Специальные средства MQ.

Расширение Предварительный просмотр
az iot ops mq get-password-hash

Создает хэш PBKDF2 парольной фразы, применяющей PBKDF2-HMAC-SHA512. 128-разрядная соль используется из os.urandom.

Расширение Предварительный просмотр
az iot ops mq stats

Отображение статистики выполнения dmqtt.

Расширение Предварительный просмотр
az iot ops support

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

Расширение Предварительный просмотр
az iot ops support create-bundle

Создает zip-архив пакета поддержки стандартного пакета поддержки для устранения неполадок и диагностика.

Расширение Предварительный просмотр
az iot ops verify-host

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

Расширение Предварительный просмотр

az iot ops check

Предварительный просмотр

Группа команд iot ops находится в предварительной версии и в процессе разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

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

Команда по умолчанию показывает понятное представление сводки выбранной службы. Дополнительные сведения можно запросить с помощью --detail-level.

{Поддерживаемые API службы}

  • akri.sh/[v0]
  • dataprocessor.iotoperations.azure.com/[v1]
  • deviceregistry.microsoft.com/[v1beta1]
  • layerednetworkmgmt.iotoperations.azure.com/[v1beta1]
  • mq.iotoperations.azure.com/[v1beta1]
  • opcuabroker.iotoperations.azure.com/[v1beta1].
az iot ops check [--as-object {false, true}]
                 [--context]
                 [--detail-level {0, 1, 2}]
                 [--ops-service {akri, dataprocessor, deviceregistry, lnm, mq, opcua}]
                 [--post {false, true}]
                 [--pre {false, true}]
                 [--resource-name]
                 [--resources {asset, assetendpointprofile, assettype, broker, brokerlistener, configuration, datalakeconnector, dataset, diagnosticservice, instance, kafkaconnector, lnm, mqttbridgeconnector, pipeline}]

Примеры

Базовое использование. Проверяет работоспособности mq с сводными выходными данными.

az iot ops check

Оценивает mq, как и в предыдущем примере, однако выходные данные оптимизированы для CI.

az iot ops check --as-object

Проверяет работоспособности и конфигурации dataprocessor с подробными выходными данными.

az iot ops check --svc dataprocessor --detail-level 1

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

az iot ops check --svc dataprocessor --detail-level 1 --resources pipeline

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

az iot ops check --svc dataprocessor  --resources pipeline --resource-name pipeline

Используйте имя ресурса, чтобы ограничить результаты именами ресурсов, начинающимися с "pipeline-name".

az iot ops check --svc dataprocessor --detail-level 1 --resource-name pipeline-name*

Используйте шаблон glOB-объектов "?", чтобы ограничить результаты именами ресурсов, содержащими "конвейер" и заканчивающимися одним символом.

az iot ops check --svc dataprocessor --detail-level 1 --resource-name pipeline?

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

--as-object

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

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

Имя контекста Kubeconfig для взаимодействия с кластером k8s. Если контекст не указан, current_context используется.

--detail-level

Управляет уровнем детализации, отображаемым в выходных данных проверка. Выберите 0 для представления сводки (минимальные выходные данные), 1 для подробного представления (более подробные сведения) или 2 для подробного представления (все доступные сведения).

допустимые значения: 0, 1, 2
значение по умолчанию: 0
--ops-service --svc

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

допустимые значения: akri, dataprocessor, deviceregistry, lnm, mq, opcua
значение по умолчанию: mq
--post

Запустите проверка после развертывания.

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

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

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

Для конкретного имени ресурса выполняются только проверка. Имя не учитывает регистр. Поддерживаются шаблоны GLOB-объектов "" и "?". Примечание. Допускаются только буквенно-цифровые символы, дефисы, "?" и "".

--resources

Запуск проверка только для определенных типов ресурсов. Используйте разделенные пробелами значения.

допустимые значения: asset, assetendpointprofile, assettype, broker, brokerlistener, configuration, datalakeconnector, dataset, diagnosticservice, instance, kafkaconnector, lnm, mqttbridgeconnector, pipeline
Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az iot ops init

Предварительный просмотр

Группа команд iot ops находится в предварительной версии и в процессе разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

Начальная загрузка, настройка и развертывание операций Интернета вещей в целевом кластере с поддержкой arc.

Дополнительные ресурсы, включая включение arc-включения кластера https://learn.microsoft.com/en-us/azure/iot-operations/deploy-iot-ops/howto-prepare-cluster.

az iot ops init --cluster
                --resource-group
                [--ca-dir]
                [--ca-file]
                [--ca-key-file]
                [--ca-valid-days]
                [--cluster-namespace]
                [--context]
                [--csi-driver-ver]
                [--custom-location]
                [--disable-rotation {false, true}]
                [--disable-rsync-rules {false, true}]
                [--dp-instance]
                [--ensure-latest {false, true}]
                [--kubernetes-distro {k3s, k8s, microk8s}]
                [--kv-id]
                [--kv-spc-secret-name]
                [--location]
                [--mq-authn]
                [--mq-backend-part]
                [--mq-backend-rf]
                [--mq-backend-workers]
                [--mq-broker]
                [--mq-frontend-replicas]
                [--mq-frontend-server]
                [--mq-frontend-workers]
                [--mq-insecure {false, true}]
                [--mq-instance]
                [--mq-listener]
                [--mq-mem-profile {high, low, medium, tiny}]
                [--mq-mode {auto, distributed}]
                [--mq-service-type {clusterIp, loadBalancer, nodePort}]
                [--no-block {false, true}]
                [--no-deploy {false, true}]
                [--no-progress {false, true}]
                [--no-tls {false, true}]
                [--opcua-discovery-url]
                [--rotation-int]
                [--runtime-socket]
                [--show-template {false, true}]
                [--simulate-plc {false, true}]
                [--sp-app-id]
                [--sp-object-id]
                [--sp-secret]
                [--sp-secret-valid-days]
                [--target]

Примеры

Минимальные входные данные для полной настройки. Это включает в себя конфигурацию Key Vault, развертывание драйвера CSI, конфигурацию TLS и развертывание операций Интернета вещей.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id /subscriptions/2cb3a427-1abc-48d0-9d03-dd240819742a/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/mykeyvault

Такая же настройка, как и в предыдущем примере, за исключением использования существующего идентификатора приложения и флага для включения имитированного сервера PLC в рамках развертывания. Включение идентификатора приложения не позволит "init" создать регистрацию приложения.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --simulate-plc

Чтобы пропустить развертывание и сосредоточиться только на драйвере CSI Key Vault и рабочих процессах конфигурации TLS, простой проход в "--no-deploy". Это может быть полезно при переходе к развертыванию из другого средства, например портала.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --no-deploy

Чтобы развернуть только операции Интернета вещей в кластере, который уже подготовлен, просто опустите "--kv-id" и включите "-no-tls".

az iot ops init --cluster mycluster -g myresourcegroup --no-tls

Используйте "--no-block" для выполнения других действий во время развертывания и ожидания завершения развертывания перед началом другой работы.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --no-block

Чтобы избежать вызова MS Graph, например для сценариев CI, в которых разрешения субъекта-службы az cli вошедшие в систему ограничены или существующий субъект-служба следует повторно использовать, укажите все значения "-sp-app-id", "-sp-object-id" и "-sp-sp-secret". Эти значения должны отражать нужный субъект-службу, который будет использоваться для установки драйвера CSI Key Vault.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --sp-object-id 224a7a3f-c63d-4923-8950-c4a85f0d2f29 --sp-secret $SP_SECRET

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

--cluster

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

--resource-group -g

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

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

--ca-dir

Локальный каталог, в который будет помещен созданный тестовый ЦС и закрытый ключ. Если каталог не указан, файлы записываются на диск. Применимо, если не предоставляется файл --ca-file и --ca-key-file.

--ca-file

Путь к требуемому файлу ЦС в формате PEM.

--ca-key-file

Путь к файлу закрытого ключа ЦС в формате PEM. ! Обязательно! Если указан файл --ca-file.

--ca-valid-days

Параметр управления длительностью в днях созданного ЦС x509. Применимо, если файл --ca-file и --ca-key-file не указан.

значение по умолчанию: 365
--cluster-namespace

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

значение по умолчанию: azure-iot-operations
--context

Имя контекста Kubeconfig для взаимодействия с кластером k8s. Если контекст не указан, current_context используется.

--csi-driver-ver

Версия драйвера CSI.

значение по умолчанию: 1.5.2
--custom-location

Имя настраиваемого расположения, соответствующее развертыванию Операций Интернета вещей. По умолчанию используется форма "{cluster_name}-ops-init-cl".

--disable-rotation

Пометка, чтобы отключить смену секретов.

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

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

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

Имя экземпляра обработчика данных. По умолчанию используется форма "{cluster_name}-ops-init-processor".

--ensure-latest

Убедитесь, что установлен последний интерфейс командной строки Ops IoT, вызывая ошибку, если обновление доступно.

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

Дистрибутив Kubernetes, используемый для конфигурации Akri. Выбранный дистрибутив подразумевает путь сокета среды выполнения контейнера по умолчанию при отсутствии значения сокета --runtime-socket.

допустимые значения: k3s, k8s, microk8s
значение по умолчанию: k8s
--kv-id

Идентификатор ресурса ARM Key Vault. Предоставление этого идентификатора ресурса позволит клиенту настроить все необходимые ресурсы и конфигурацию на стороне кластера, чтобы включить драйвер CSI Key Vault для операций Интернета вещей.

--kv-spc-secret-name

Имя секрета Key Vault, используемое в качестве секрета SPC по умолчанию. Если секрет не существует, он будет создан с криптографически безопасным значением заполнителя.

значение по умолчанию: azure-iot-operations
--location

Расположение ARM, которое будет использоваться для подготовленного обеспечения RPSaaS. Если не указано расположение подключенного кластера, будет использоваться.

--mq-authn

Имя проверки подлинности mq. Значение по умолчанию — "authn".

--mq-backend-part

Внутренние секции MQ.

значение по умолчанию: 2
--mq-backend-rf

Фактор избыточности серверной части MQ.

значение по умолчанию: 2
--mq-backend-workers

Сотрудники серверной части MQ.

значение по умолчанию: 2
--mq-broker

Имя брокера mq. Значение по умолчанию — broker.

--mq-frontend-replicas

Интерфейсные реплика MQ.

значение по умолчанию: 2
--mq-frontend-server

Имя внешнего сервера mq. Значение по умолчанию — mq-dmqtt-frontend.

--mq-frontend-workers

Интерфейсные сотрудники MQ.

значение по умолчанию: 2
--mq-insecure

Если включено развертывание mq, будет включать прослушиватель, привязанный к порту 1883 без проверки подлинности или проверки подлинности. Параметр broker encryptInternalTraffic будет иметь значение false. Только для рабочих нагрузок, отличных от рабочей среды.

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

Имя экземпляра mq. По умолчанию используется форма init-{hash}-mq-instance.

--mq-listener

Имя прослушивателя mq. Значение по умолчанию — прослушиватель.

--mq-mem-profile

Профиль памяти MQ.

допустимые значения: high, low, medium, tiny
значение по умолчанию: medium
--mq-mode

Режим работы MQ.

допустимые значения: auto, distributed
значение по умолчанию: distributed
--mq-service-type

Тип службы MQ.

допустимые значения: clusterIp, loadBalancer, nodePort
значение по умолчанию: clusterIp
--no-block

Вернитесь сразу после запуска развертывания операций Интернета вещей.

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

Рабочий процесс развертывания операций Интернета вещей будет пропущен.

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

Отключите индикатор выполнения инициализации.

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

Рабочий процесс конфигурации TLS будет пропущен.

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

Настраивает конечную точку сервера OPC-UA для обработчиков обнаружения Akri. Если параметр не указан и --simulate-plc задан, это значение становится opc.tcp://opcplc-000000. {cluster_namespace}:50000'.

--rotation-int

Интервал опроса поворота.

значение по умолчанию: 1h
--runtime-socket

Путь к узлу по умолчанию сокета среды выполнения контейнера. Если он не указан (по умолчанию), путь сокета определяется методом --kubernetes-distro.

--show-template

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

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

Пометка при настройке установит установщик брокера OPC-UA для спин-up сервера PLC.

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

Идентификатор приложения субъекта-службы. Если указано, будет использоваться для установки драйвера CSI. В противном случае будет создана регистрация приложения. Требуется, если вошедший в систему субъект не имеет разрешений на запрос графа.

--sp-object-id

Идентификатор объекта субъекта-службы (sp). Если указано, будет использоваться для установки драйвера CSI. В противном случае идентификатор объекта будет запрашиваться из идентификатора приложения— создание sp, если он не существует. Требуется, если вошедший в систему субъект не имеет разрешений на запрос графа. Используйте az ad sp show --id <app Id> --query id -o tsv для создания соответствующего идентификатора объекта. Кроме того, с помощью портала можно перейти к корпоративным приложениям в клиенте Entra Id.

--sp-secret

Секрет, соответствующий предоставленному идентификатору приложения субъекта-службы. Если указано, будет использоваться для установки драйвера CSI. В противном случае будет создан новый секрет. Требуется, если вошедший в систему субъект не имеет разрешений на запрос графа.

--sp-secret-valid-days

Параметр управления длительностью в днях созданного секрета субъекта-службы. Применимо, если --sp-secret не предоставляется.

значение по умолчанию: 365
--target

Целевое имя оркестратора ops. По умолчанию используется форма "{cluster_name}-ops-init-target".

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az iot ops verify-host

Предварительный просмотр

Группа команд iot ops находится в предварительной версии и в процессе разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

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

Предназначено для запуска непосредственно на целевом узле кластера. Команда может заставить применить набор привилегированных действий, например установку зависимости. В этом случае интерфейс командной строки должен выполняться с повышенными разрешениями. Например, sudo AZURE_EXTENSION_DIR=~/.azure/cliextensions az iot ops verify-host.

az iot ops verify-host [--no-progress {false, true}]

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

--no-progress

Отключите визуальное представление работы.

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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