az iot edge deployment
Note
Эта ссылка является частью расширения Azure-iot для Azure CLI (версия 2.67.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az iot edge deployment. Подробнее о расширениях.
Управление развертываниями IoT Edge в масштабе.
Команды
| Имя | Описание | Тип | Состояние |
|---|---|---|---|
| az iot edge deployment create |
Создайте развертывание IoT Edge в целевой IoT Hub. |
Extension | GA |
| az iot edge deployment delete |
Удаление развертывания IoT Edge. |
Extension | GA |
| az iot edge deployment list |
Вывод списка развертываний IoT Edge в IoT Hub. |
Extension | GA |
| az iot edge deployment show |
Получение сведений о развертывании IoT Edge. |
Extension | GA |
| az iot edge deployment show-metric |
Оцените целевую системную метрику, определенную в развертывании IoT Edge. |
Extension | GA |
| az iot edge deployment update |
Обновите указанные свойства развертывания IoT Edge. |
Extension | GA |
az iot edge deployment create
Создайте развертывание IoT Edge в целевой IoT Hub.
Содержимое развертывания — json и в виде {"modulesContent":{...}} или {"content":{"modulesContent":{...}}.
По умолчанию свойства системных модулей $edgeAgent и $edgeHub проверяются на соответствие схемам, установленным с расширением IoT. Эта проверка предназначена для базовых развертываний. Если соответствующая схема недоступна или базовый формат развертывания не обнаружен, этот шаг будет пропущен. Проверка схемы может быть отключена с помощью переключателя --no-validation.
Пограничное развертывание классифицируется как многоуровневое, если модуль имеет свойства.desired.*. Для любого пограничного устройства, предназначенного для многоуровневого развертывания, сначала требуется базовое развертывание, примененное к нему.
Все многоуровневые развертывания, предназначенные для устройства, должны иметь более высокий приоритет, чем базовое развертывание для этого устройства.
Примечание. Если поле properties.desired двойника модуля задано в многоуровневом развертывании, properties.desired перезапишет требуемые свойства для этого модуля в любом более низком приоритете развертывания.
az iot edge deployment create --content
--deployment-id
[--acquire-policy-token]
[--auth-type {key, login}]
[--change-reference]
[--cl --custom-labels]
[--cmq --custom-metric-queries]
[--hub-name]
[--lab --labels]
[--layered {false, true}]
[--login]
[--metrics]
[--no-validation {false, true}]
[--pri --priority]
[--resource-group]
[--target-condition --tc]
Примеры
Создайте развертывание с метками (пример синтаксиса bash), которое применяется для устройств в сборке 9, а среда — test.
az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels '{"key0":"value0", "key1":"value1"}' --target-condition "tags.building=9 and tags.environment='test'" --priority 3
Создайте развертывание с метками (пример синтаксиса PowerShell), которое применяется для устройств, помеченных средой dev.
az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels "{'key':'value'}" --target-condition "tags.environment='dev'"
Создайте многоуровневое развертывание, которое применяется для устройств, помеченных средой dev. Метрики пользователей и модули, определенные встроенным образом (пример синтаксиса PowerShell). Обратите внимание, что это в формате многоуровневого развертывания как properties.desired.* было определено.
az iot edge deployment create -d {deployment_name} -n {iothub_name} --content "{'modulesContent':{'`$edgeAgent':{
'properties.desired.modules.mymodule0':{ }},'`$edgeHub':{'properties.desired.routes.myroute0':'FROM /messages/* INTO `$upstream'}}}"
--target-condition "tags.environment='dev'" --priority 10 --metrics "{'queries':{'mymetrik':'SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200'}}"
Создайте многоуровневое развертывание, которое применяется для устройств в сборке 9 и среде test. Метрики пользователей и модули, определенные встроенным (пример синтаксиса bash). Обратите внимание, что это в формате многоуровневого развертывания как properties.desired.* было определено.
az iot edge deployment create -d {deployment_name} -n {iothub_name} --content '{"modulesContent":{"$edgeAgent":{"properties.desired.modules.mymodule0":{ }},"$edgeHub":{"properties.desired.routes.myroute0":"FROM /messages/* INTO $upstream"}}}' --target-condition "tags.building=9 and tags.environment='test'" --metrics '{"queries":{"mymetrik":"SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200"}}'
Создайте развертывание, которое применяется для устройств в сборке 9 и среде test. Метрики пользователей и модули, определенные из файла.
az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics ./metrics_content.json
Создайте развертывание, определение которого состоит из файла с не зависящими от оболочки входными данными меток и метрик.
az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --custom-labels key0=value0 key1=value1 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"
Обязательные параметры
IoT Edge содержимое развертывания. Укажите путь к файлу или необработанный json.
Имя целевого развертывания. Строчные регистры и следующие специальные символы: [-+%_*!'].
Необязательные параметры
Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.
Автоматическое получение маркера Azure Policy для этой операции ресурса.
| Свойство | Значение |
|---|---|
| Группа параметров: | Global Policy Arguments |
Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.
| Свойство | Значение |
|---|---|
| Группа параметров: | Access Control Arguments |
| Default value: | key |
| Допустимые значения: | key, login |
Связанный идентификатор ссылки на изменение для этой операции ресурса.
| Свойство | Значение |
|---|---|
| Группа параметров: | Global Policy Arguments |
Альтернативный стиль входных данных (пары key=value пробела) для меток --labels и предназначен для его замены в будущем. Пример формата: key1=value1 key2="это мое значение".
Альтернативный стиль ввода (пары "ключ=значение" пробела) для метрик --metrics и предназначен для замены его в будущем. Пример формата: metric1="select deviceId from devices where tags.location='US'" metric2="select *".
IoT Hub имя или имя узла. Требуется, если --login не указан.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Сопоставление меток, применяемых к целевому развертыванию. Используйте следующий формат: "{"key0":"value0", "key1":"value1"}. Рекомендуется использовать метки --custom-, а не --labels.
Многоуровневые развертывания позволяют определять требуемые свойства в $edgeAgent, $edgeHub и пользовательских модулях, которые будут развертываться поверх базового развертывания. Свойства, указанные в многоуровневом развертывании, будут объединяться со свойствами базового развертывания. Свойства с тем же путем будут перезаписаны на основе приоритета развертывания. Этот параметр является псевдонимом для --no-validation.
| Свойство | Значение |
|---|---|
| Default value: | False |
| Допустимые значения: | false, true |
Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
IoT Edge определения пользовательских метрик развертывания. Укажите путь к файлу или необработанный json. Метрики пользователей находятся в виде {"запросов":{...}} или {"метрики":{"запросы":{...}}. Рекомендуется использовать запросы --custom-metric-queries вместо --metrics.
Отключает проверку схемы на стороне клиента для создания пограничного развертывания.
| Свойство | Значение |
|---|---|
| Default value: | False |
| Допустимые значения: | false, true |
Вес развертывания в случае конкурирующих правил (самые высокие выигрыши).
| Свойство | Значение |
|---|---|
| Default value: | 0 |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.
Целевое условие, к которому применяется пограничное развертывание. Развертывания без целевого условия не предназначены для устройства. Используйте следующий формат: "tags.environment='test".
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az iot edge deployment delete
Удаление развертывания IoT Edge.
az iot edge deployment delete --deployment-id
[--acquire-policy-token]
[--auth-type {key, login}]
[--change-reference]
[--etag]
[--hub-name]
[--login]
[--resource-group]
Обязательные параметры
Имя целевого развертывания. Строчные регистры и следующие специальные символы: [-+%_*!'].
Необязательные параметры
Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.
Автоматическое получение маркера Azure Policy для этой операции ресурса.
| Свойство | Значение |
|---|---|
| Группа параметров: | Global Policy Arguments |
Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.
| Свойство | Значение |
|---|---|
| Группа параметров: | Access Control Arguments |
| Default value: | key |
| Допустимые значения: | key, login |
Связанный идентификатор ссылки на изменение для этой операции ресурса.
| Свойство | Значение |
|---|---|
| Группа параметров: | Global Policy Arguments |
Тег Etag или сущности, соответствующий последнему состоянию ресурса. Если etag не указан, используется значение "*".
IoT Hub имя или имя узла. Требуется, если --login не указан.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az iot edge deployment list
Вывод списка развертываний IoT Edge в IoT Hub.
az iot edge deployment list [--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
[--top]
Необязательные параметры
Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.
Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.
| Свойство | Значение |
|---|---|
| Группа параметров: | Access Control Arguments |
| Default value: | key |
| Допустимые значения: | key, login |
IoT Hub имя или имя узла. Требуется, если --login не указан.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.
Максимальное количество возвращаемых развертываний. По умолчанию возвращаются все развертывания.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az iot edge deployment show
Получение сведений о развертывании IoT Edge.
az iot edge deployment show --deployment-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
Обязательные параметры
Имя целевого развертывания. Строчные регистры и следующие специальные символы: [-+%_*!'].
Необязательные параметры
Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.
Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.
| Свойство | Значение |
|---|---|
| Группа параметров: | Access Control Arguments |
| Default value: | key |
| Допустимые значения: | key, login |
IoT Hub имя или имя узла. Требуется, если --login не указан.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az iot edge deployment show-metric
Оцените целевую системную метрику, определенную в развертывании IoT Edge.
az iot edge deployment show-metric --deployment-id
--metric-id
[--acquire-policy-token]
[--auth-type {key, login}]
[--change-reference]
[--hub-name]
[--login]
[--metric-type --mt {system, user}]
[--resource-group]
Примеры
Оценка системной метрики "appliedCount"
az iot edge deployment show-metric -m appliedCount -d {deployment_name} -n {iothub_name} --mt system
Оценка метрики пользователя myCustomMetric
az iot edge deployment show-metric -m myCustomMetric -d {deployment_name} -n {iothub_name}
Обязательные параметры
Имя целевого развертывания. Строчные регистры и следующие специальные символы: [-+%_*!'].
Целевая метрика для оценки.
Необязательные параметры
Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.
Автоматическое получение маркера Azure Policy для этой операции ресурса.
| Свойство | Значение |
|---|---|
| Группа параметров: | Global Policy Arguments |
Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.
| Свойство | Значение |
|---|---|
| Группа параметров: | Access Control Arguments |
| Default value: | key |
| Допустимые значения: | key, login |
Связанный идентификатор ссылки на изменение для этой операции ресурса.
| Свойство | Значение |
|---|---|
| Группа параметров: | Global Policy Arguments |
IoT Hub имя или имя узла. Требуется, если --login не указан.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Указывает, какая коллекция метрик должна использоваться для поиска метрик.
| Свойство | Значение |
|---|---|
| Default value: | user |
| Допустимые значения: | system, user |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az iot edge deployment update
Обновите указанные свойства развертывания IoT Edge.
Используйте --set, за которым следует назначения свойств для обновления развертывания.
Примечание. IoT Edge содержимое развертывания неизменяемо. Свойства развертывания, которые можно обновить, — метки, метрики, приоритет и targetCondition.
az iot edge deployment update --deployment-id
[--acquire-policy-token]
[--add]
[--auth-type {key, login}]
[--change-reference]
[--etag]
[--force-string]
[--hub-name]
[--login]
[--remove]
[--resource-group]
[--set]
Примеры
Изменение меток и целевого условия существующего пограничного развертывания
az iot edge deployment update -d {deployment_name} -n {iothub_name} --set labels='{"purpose":"dev", "owners":"IoTEngineering"}' targetCondition='tags.building=9'
Обязательные параметры
Имя целевого развертывания. Строчные регистры и следующие специальные символы: [-+%_*!'].
Необязательные параметры
Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.
Автоматическое получение маркера Azure Policy для этой операции ресурса.
| Свойство | Значение |
|---|---|
| Группа параметров: | Global Policy Arguments |
Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.
| Свойство | Значение |
|---|---|
| Группа параметров: | Generic Update Arguments |
| Default value: | [] |
Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.
| Свойство | Значение |
|---|---|
| Группа параметров: | Access Control Arguments |
| Default value: | key |
| Допустимые значения: | key, login |
Связанный идентификатор ссылки на изменение для этой операции ресурса.
| Свойство | Значение |
|---|---|
| Группа параметров: | Global Policy Arguments |
Тег Etag или сущности, соответствующий последнему состоянию ресурса. Если etag не указан, используется значение "*".
При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.
| Свойство | Значение |
|---|---|
| Группа параметров: | Generic Update Arguments |
| Default value: | False |
IoT Hub имя или имя узла. Требуется, если --login не указан.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| Свойство | Значение |
|---|---|
| Группа параметров: | Generic Update Arguments |
| Default value: | [] |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.
Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.
| Свойство | Значение |
|---|---|
| Группа параметров: | Generic Update Arguments |
| Default value: | [] |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |