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

az iot edge deployment

Note

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

Управление развертываниями IoT Edge в большом масштабе.

Команды

Имя Описание Тип Состояние
az iot edge deployment create

Создайте развертывание IoT Edge в целевом Центр Интернета вещей.

 Extension GA
az iot edge deployment delete

Удаление развертывания IoT Edge.

 Extension GA
az iot edge deployment list

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

 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 в целевом Центр Интернета вещей.

Содержимое развертывания — json и в виде {"modulesContent":{...}} или {"content":{"modulesContent":{...}}.

По умолчанию свойства системных модулей $edgeAgent и $edgeHub проверяются на соответствие схемам, установленным с расширением IoT. Эта проверка предназначена для базовых развертываний. Если соответствующая схема недоступна или базовый формат развертывания не обнаружен, этот шаг будет пропущен. Проверка схемы может быть отключена с помощью переключателя --no-validation.

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

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

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

az iot edge deployment create --content
                              --deployment-id
                              [--auth-type {key, login}]
                              [--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 *"

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

--content -k

Содержимое развертывания IoT Edge. Укажите путь к файлу или необработанный json.

--deployment-id -d

Имя целевого развертывания. Строчные регистры и следующие специальные символы: [-+%_*!'].

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

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

Свойство Значение
Parameter group: Access Control Arguments
Default value: key
Допустимые значения: key, login
--cl --custom-labels

Альтернативный стиль входных данных (пары key=value пробела) для меток --labels и предназначен для его замены в будущем. Пример формата: key1=value1 key2="это мое значение".

--cmq --custom-metric-queries

Альтернативный стиль ввода (пары "ключ=значение" пробела) для метрик --metrics и предназначен для замены его в будущем. Пример формата: metric1="select deviceId from devices where tags.location='US'" metric2="select *".

--hub-name -n

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

Свойство Значение
Parameter group: IoT Hub Identifier Arguments
--lab --labels

Сопоставление меток, применяемых к целевому развертыванию. Используйте следующий формат: "{"key0":"value0", "key1":"value1"}. Рекомендуется использовать метки --custom-, а не --labels.

--layered

Многоуровневые развертывания позволяют определять требуемые свойства в $edgeAgent, $edgeHub и пользовательских модулях, которые будут развертываться поверх базового развертывания. Свойства, указанные в многоуровневом развертывании, будут объединяться со свойствами базового развертывания. Свойства с тем же путем будут перезаписаны на основе приоритета развертывания. Этот параметр является псевдонимом для --no-validation.

Свойство Значение
Default value: False
Допустимые значения: false, true
--login -l

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

Свойство Значение
Parameter group: IoT Hub Identifier Arguments
--metrics -m

Определения метрик развертывания IoT Edge. Укажите путь к файлу или необработанный json. Метрики пользователей находятся в виде {"запросов":{...}} или {"метрики":{"запросы":{...}}. Рекомендуется использовать запросы --custom-metric-queries вместо --metrics.

--no-validation

Отключает проверку схемы на стороне клиента для создания пограничного развертывания.

Свойство Значение
Default value: False
Допустимые значения: false, true
--pri --priority

Вес развертывания в случае конкурирующих правил (самые высокие выигрыши).

Свойство Значение
Default value: 0
--resource-group -g

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

--target-condition --tc -t

Целевое условие, к которому применяется пограничное развертывание. Развертывания без целевого условия не предназначены для устройства. Используйте следующий формат: "tags.environment='test".

Глобальные параметры
--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 edge deployment delete

Удаление развертывания IoT Edge.

az iot edge deployment delete --deployment-id
                              [--auth-type {key, login}]
                              [--etag]
                              [--hub-name]
                              [--login]
                              [--resource-group]

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

--deployment-id -d

Имя целевого развертывания. Строчные регистры и следующие специальные символы: [-+%_*!'].

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

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

Свойство Значение
Parameter group: Access Control Arguments
Default value: key
Допустимые значения: key, login
--etag -e

Тег Etag или сущности, соответствующий последнему состоянию ресурса. Если etag не указан, используется значение "*".

--hub-name -n

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

Свойство Значение
Parameter group: IoT Hub Identifier Arguments
--login -l

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

Свойство Значение
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

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

Глобальные параметры
--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 edge deployment list

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

az iot edge deployment list [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]
                            [--top]

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

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

Свойство Значение
Parameter group: Access Control Arguments
Default value: key
Допустимые значения: key, login
--hub-name -n

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

Свойство Значение
Parameter group: IoT Hub Identifier Arguments
--login -l

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

Свойство Значение
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

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

--top

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

Глобальные параметры
--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 edge deployment show

Получение сведений о развертывании IoT Edge.

az iot edge deployment show --deployment-id
                            [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]

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

--deployment-id -d

Имя целевого развертывания. Строчные регистры и следующие специальные символы: [-+%_*!'].

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

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

Свойство Значение
Parameter group: Access Control Arguments
Default value: key
Допустимые значения: key, login
--hub-name -n

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

Свойство Значение
Parameter group: IoT Hub Identifier Arguments
--login -l

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

Свойство Значение
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

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

Глобальные параметры
--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 edge deployment show-metric

Оцените целевую системную метрику, определенную в развертывании IoT Edge.

az iot edge deployment show-metric --deployment-id
                                   --metric-id
                                   [--auth-type {key, login}]
                                   [--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}

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

--deployment-id -d

Имя целевого развертывания. Строчные регистры и следующие специальные символы: [-+%_*!'].

--metric-id -m

Целевая метрика для оценки.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

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

Свойство Значение
Parameter group: Access Control Arguments
Default value: key
Допустимые значения: key, login
--hub-name -n

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

Свойство Значение
Parameter group: IoT Hub Identifier Arguments
--login -l

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

Свойство Значение
Parameter group: IoT Hub Identifier Arguments
--metric-type --mt

Указывает, какая коллекция метрик должна использоваться для поиска метрик.

Свойство Значение
Default value: user
Допустимые значения: system, user
--resource-group -g

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

Глобальные параметры
--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 edge deployment update

Обновите указанные свойства развертывания IoT Edge.

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

Примечание. Содержимое развертывания IoT Edge неизменяемо. Свойства развертывания, которые можно обновить, — метки, метрики, приоритет и targetCondition.

az iot edge deployment update --deployment-id
                              [--add]
                              [--auth-type {key, login}]
                              [--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'

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

--deployment-id -d

Имя целевого развертывания. Строчные регистры и следующие специальные символы: [-+%_*!'].

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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

Свойство Значение
Parameter group: Generic Update Arguments
Default value: []
--auth-type

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

Свойство Значение
Parameter group: Access Control Arguments
Default value: key
Допустимые значения: key, login
--etag -e

Тег Etag или сущности, соответствующий последнему состоянию ресурса. Если etag не указан, используется значение "*".

--force-string

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

Свойство Значение
Parameter group: Generic Update Arguments
Default value: False
--hub-name -n

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

Свойство Значение
Parameter group: IoT Hub Identifier Arguments
--login -l

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

Свойство Значение
Parameter group: IoT Hub Identifier Arguments
--remove

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

Свойство Значение
Parameter group: Generic Update Arguments
Default value: []
--resource-group -g

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

--set

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

Свойство Значение
Parameter group: Generic Update Arguments
Default value: []
Глобальные параметры
--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