您现在访问的是微软AZURE全睃版技术文档网站,若需覝访问由世纪互蝔违蝥的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

az iot edge deployment

备注

此引用是适用于 Azure CLI 的 azure-iot 扩展的一部分,需要 2.17.1 或更高版本。 首次运行 az iot edge deployment 命令时,扩展将自动安装。 详细了解扩展。

大规模IoT Edge部署。

命令

az iot edge deployment create

在IoT Edge IoT 中心创建一个部署。

az iot edge deployment delete

删除IoT Edge部署。

az iot edge deployment list

列出IoT Edge IoT 中心的部署。

az iot edge deployment show

获取部署IoT Edge的详细信息。

az iot edge deployment show-metric

评估在部署部署中定义IoT Edge指标。

az iot edge deployment update

更新部署IoT Edge属性。

使用 --set,后跟属性分配来更新部署。

注意:IoT Edge内容是不可变的。 可以更新的部署属性为"labels"、"metrics"、"priority"和"targetCondition"。

az iot edge deployment create

在IoT Edge IoT 中心创建一个部署。

部署内容为 json,格式为 {"modulesContent":{...}} 或 {"content":{"modulesContent":{...}}}。

默认情况下,系统模块$edgeAgent$edgeHub针对随 IoT 扩展一起安装的架构进行验证。 可以使用 --no-validation 开关禁用此功能。

可以使用用户定义的指标创建边缘部署,进行按需评估。 用户指标为 json,格式为 {"queries":{...}} 或 {"metrics":{"queries":{...}}}。

az iot edge deployment create --content
                              --deployment-id
                              [--auth-type {key, login}]
                              [--hub-name]
                              [--lab]
                              [--layered {false, true}]
                              [--login]
                              [--metrics]
                              [--no-validation {false, true}]
                              [--pri]
                              [--resource-group]
                              [--target-condition]

示例

使用 bash 语法示例 (标签创建) ,该示例适用于"building 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 语法示例) 。

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'}}" --layered

创建适用于"building 9"中的设备和环境"test"的分层部署。 内联定义的用户指标和模块内容 (bash 语法示例) 。

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"}}' --layered

创建适用于"building 9"中的设备和环境"test"的分层部署。 从文件定义的用户指标和模块内容。

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content layered_modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics metrics_content.json --layered

必需参数

--content -k

IoT Edge部署内容。 提供文件路径或原始 json。

--deployment-id -d

目标部署名称。

可选参数

--auth-type

指示操作是应自动派生策略密钥还是使用当前Azure AD会话。 可以使用 配置默认值 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
默认值: key
--hub-name -n

IoT 中心名称。

--lab --labels

要应用于目标部署的标签映射。 使用以下格式:"{"key0":"value0","key1":"value1"}'。

--layered

分层部署允许你在基于基本部署$edgeAgent层$edgeHub和用户模块中定义所需的属性。 例如,分层部署中指定的路由将与基本部署的路由合并。 将基于部署优先级覆盖同名的路由。

接受的值: false, true
--login -l

此命令支持具有操作权限的实体连接字符串。 使用 可避免通过"az login"进行会话登录。 如果同时提供实体连接字符串和名称,则连接字符串优先。

--metrics -m

IoT Edge部署指标定义。 提供文件路径或原始 json。

--no-validation

禁用客户端架构验证以创建边缘部署。

接受的值: false, true
--pri --priority

在竞争规则中,部署的权重 (最高) 。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--target-condition --tc -t

应用 Edge 部署的目标条件。

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

目标部署名称。

可选参数

--auth-type

指示操作是应自动派生策略密钥还是使用当前Azure AD会话。 可以使用 配置默认值 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
默认值: key
--etag -e

与资源的最后一个状态对应的 Etag 或实体标记。 如果未提供 etag,则使用 * 值'' 。

--hub-name -n

IoT 中心名称。

--login -l

此命令支持具有操作权限的实体连接字符串。 使用 可避免通过"az login"进行会话登录。 如果同时提供实体连接字符串和名称,则连接字符串优先。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

az iot edge deployment list

列出IoT Edge IoT 中心的部署。

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

可选参数

--auth-type

指示操作是应自动派生策略密钥还是使用当前Azure AD会话。 可以使用 配置默认值 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
默认值: key
--hub-name -n

IoT 中心名称。

--login -l

此命令支持具有操作权限的实体连接字符串。 使用 可避免通过"az login"进行会话登录。 如果同时提供实体连接字符串和名称,则连接字符串优先。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--top

要返回的最大部署数。 默认情况下,将返回所有部署。

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

目标部署名称。

可选参数

--auth-type

指示操作是应自动派生策略密钥还是使用当前Azure AD会话。 可以使用 配置默认值 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
默认值: key
--hub-name -n

IoT 中心名称。

--login -l

此命令支持具有操作权限的实体连接字符串。 使用 可避免通过"az login"进行会话登录。 如果同时提供实体连接字符串和名称,则连接字符串优先。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

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

用于评估的目标指标。

可选参数

--auth-type

指示操作是应自动派生策略密钥还是使用当前Azure AD会话。 可以使用 配置默认值 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
默认值: key
--hub-name -n

IoT 中心名称。

--login -l

此命令支持具有操作权限的实体连接字符串。 使用 可避免通过"az login"进行会话登录。 如果同时提供实体连接字符串和名称,则连接字符串优先。

--metric-type --mt

指示应该使用哪个指标集合来查找指标。

接受的值: system, user
默认值: user
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

az iot edge deployment update

更新部署IoT Edge属性。

使用 --set,后跟属性分配来更新部署。

注意:IoT Edge内容是不可变的。 可以更新的部署属性为"labels"、"metrics"、"priority"和"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

目标部署名称。

可选参数

--add

通过指定路径和键值对,将 对象添加到 对象列表。 示例:--add property.listProperty <key=value,字符串或 JSON 字符串>。

--auth-type

指示操作是应自动派生策略密钥还是使用当前Azure AD会话。 可以使用 配置默认值 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
默认值: key
--etag -e

与资源的最后一个状态对应的 Etag 或实体标记。 如果未提供 etag,则使用 * 值'' 。

--force-string

使用 "set" 或 "add" 时,保留字符串文本,而不是尝试转换为 JSON。

--hub-name -n

IoT 中心名称。

--login -l

此命令支持具有执行操作的权限的实体连接字符串。 使用通过 "az login" 避免会话登录。 如果提供了实体连接字符串和名称,则连接字符串优先。

--remove

从列表中删除属性或元素。 示例:--remove property. list 或--Remove propertyToRemove。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--set

通过指定要设置的属性路径和值来更新对象。 示例:--set property1. property2 =.