az iot ops mgmt-actions

Замечание

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

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

Команды

Имя Описание Тип Состояние
az iot ops mgmt-actions disable

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

 Расширение GA
az iot ops mgmt-actions enable

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

 Расширение GA
az iot ops mgmt-actions execute

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

 Расширение GA
az iot ops mgmt-actions show

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

 Расширение GA

az iot ops mgmt-actions disable

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

Удаляет ресурсы действий управления, связанные с экземпляром, включая граф потока данных, поток данных ответа, EG dataflow endpoint, пространство раздела EG, привязки разрешений и запись конечной точки управления пространством имен ADR.

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

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

az iot ops mgmt-actions disable --instance
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]
                                [--no-progress {false, true}]
                                [--yes {false, true}]

Примеры

Отключите действия управления для экземпляра.

az iot ops mgmt-actions disable --instance myinstance -g myresourcegroup

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

az iot ops mgmt-actions disable --instance myinstance -g myresourcegroup --yes

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

--instance -i -n

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

--resource-group -g

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

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

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

--acquire-policy-token

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

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

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

Свойство Значение
Группа параметров: Global Policy Arguments
--no-progress

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

Свойство Значение
Допустимые значения: false, true
--yes -y

Подтвердите [y]es без запроса. Полезно для сценариев CI и автоматизации.

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az iot ops mgmt-actions enable

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

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

Операция настраивает ресурсы в трех доменах:

  • Пространство имен сетки событий: пространство тем, шаблоны тем и привязки разрешений.
  • Пространство имен реестра устройств: включение управляемого удостоверения и конфигурация конечной точки управления.
  • Экземпляр операций Интернета вещей: EG конечная точка потока данных, граф потока данных и поток данных ответа.

Команда идемпотентна. Если ресурс уже существует, он пропускается. При частичном сбое повторно запустите команду, чтобы достичь требуемого состояния.

По умолчанию назначения ролей (Publisher и подписчика сетки событий) создаются как для пространства имен ADR, так и для расширения AIO для пространства имен EG. Используйте --skip-ra, чтобы пропустить создание назначения ролей или --adr-role-ids / --ops-role-ids для предоставления пользовательских идентификаторов ролей.

az iot ops mgmt-actions enable --eg-resource-id
                               --instance
                               --resource-group
                               [--acquire-policy-token]
                               [--adr-role-ids]
                               [--change-reference]
                               [--dataflow-profile]
                               [--eg-client-group]
                               [--mi-user-assigned]
                               [--no-progress {false, true}]
                               [--ops-role-ids]
                               [--registry-endpoint]
                               [--skip-ra {false, true}]

Примеры

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

az iot ops mgmt-actions enable --instance myinstance -g myresourcegroup --eg-resource-id $EG_NAMESPACE_RESOURCE_ID

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

az iot ops mgmt-actions enable --instance myinstance -g myresourcegroup --eg-resource-id $EG_NAMESPACE_RESOURCE_ID --mi-user-assigned $UA_MI_RESOURCE_ID

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

az iot ops mgmt-actions enable --instance myinstance -g myresourcegroup --eg-resource-id $EG_NAMESPACE_RESOURCE_ID --skip-ra

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

--eg-resource-id

Идентификатор ресурса ARM пространства имен сетки событий.

--instance -i -n

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

--resource-group -g

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

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

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

--acquire-policy-token

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

Свойство Значение
Группа параметров: Global Policy Arguments
--adr-role-ids

Пользовательские идентификаторы ролей для назначений ролей управляемого удостоверения пространства имен ADR в пространстве имен EG. По умолчанию: "Сетка событий TopicSpaces Publisher" и "Подписчик Сетки разделов событий".

Свойство Значение
Группа параметров: Role Assignment Arguments
--change-reference

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

Свойство Значение
Группа параметров: Global Policy Arguments
--dataflow-profile

Имя профиля потока данных для ресурсов графа и потока данных. Значение по умолчанию: "default".

--eg-client-group

Группа клиентов для привязок разрешений EG. По умолчанию: $all.

--mi-user-assigned

Идентификатор ресурса управляемого удостоверения, назначаемого пользователем, для проверки подлинности конечной точки потока данных EG. По умолчанию: управляемое системой удостоверение.

--no-progress

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

Свойство Значение
Допустимые значения: false, true
--ops-role-ids

Пользовательские идентификаторы ролей для назначений ролей управляемого удостоверения расширения AIO для пространства имен EG. По умолчанию: "Сетка событий TopicSpaces Publisher" и "Подписчик Сетки разделов событий".

Свойство Значение
Группа параметров: Role Assignment Arguments
--registry-endpoint

Имя конечной точки реестра для графа потока данных. Значение по умолчанию: "default".

--skip-ra

При использовании шага назначения ролей операция будет пропущена.

Свойство Значение
Группа параметров: Role Assignment Arguments
Допустимые значения: false, true
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az iot ops mgmt-actions execute

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

Вызывает действие управления, определенное для ресурса пространства имен с помощью операции executeAction реестра устройств. Инфраструктура действий управления должна быть включена (az iot ops mgmt-actions enable) перед выполнением действий.

Команда разрешает пространство имен ADR из экземпляра операций Интернета вещей и отправляет действие в качестве длительной операции. Результат включает состояние действия, любой ответ от ресурса и сведения об ошибке, если действие завершилось сбоем.

При предоставлении полезных данных интерфейс командной строки проверяет его на соответствие схеме запроса действия (если доступно) перед отправкой запроса. Используйте --no-validate, чтобы пропустить эту проверку. Используйте схему --show-show для просмотра схемы запроса действия без выполнения.

az iot ops mgmt-actions execute --action
                                --asset
                                --group
                                --instance
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]
                                [--no-validate]
                                [--payload]
                                [--show-schema]

Примеры

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

az iot ops mgmt-actions execute --instance myinstance -g myresourcegroup --asset myasset --group mygroup --action reboot

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

az iot ops mgmt-actions execute --instance myinstance -g myresourcegroup --asset myasset --group mygroup --action configure -p '{"temperature": {"setpoint": 72}}'

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

az iot ops mgmt-actions execute --instance myinstance -g myresourcegroup --asset myasset --group mygroup --action configure -p payload.json

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

az iot ops mgmt-actions execute --instance myinstance -g myresourcegroup --asset myasset --group mygroup --action configure --show-schema

Выполнение с полезными данными, пропуск проверки схемы.

az iot ops mgmt-actions execute --instance myinstance -g myresourcegroup --asset myasset --group mygroup --action configure -p '{"temperature": {"setpoint": 72}}' --no-validate

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

--action

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

--asset

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

--group

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

--instance -i -n

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

--resource-group -g

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

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

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

--acquire-policy-token

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

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

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

Свойство Значение
Группа параметров: Global Policy Arguments
--no-validate

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

Свойство Значение
Default value: False
--payload -p

Полезные данные JSON для действия управления. Встроенная строка JSON или путь к файлу (например, payload.json).

--show-schema

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

Свойство Значение
Default value: False
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az iot ops mgmt-actions show

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

Проверяет состояние ресурсов действий управления в трех областях: пространство имен реестра устройств (ADR), ресурсы сетки событий и ресурсы потока данных AIO.

Возвращает структурированную сводку с общим включенным флагом и разделами сведений о домене. Домен, который не может быть проверен (например, отсутствует ссылка пространства имен ADR), возвращает значение NULL для этого раздела без блокировки проверки других доменов.

az iot ops mgmt-actions show --instance
                             --resource-group
                             [--no-progress {false, true}]

Примеры

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

az iot ops mgmt-actions show --instance myinstance -g myresourcegroup

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

--instance -i -n

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

--resource-group -g

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

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

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

--no-progress

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

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False