你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az edgeorder order-item

注意

此参考是 Azure CLI（版本 2.15.0 或更高版本）的 edgeorder 扩展的一部分。 该扩展将在首次运行 az edgeorder order-item 命令时自动安装。 详细了解扩展。

使用 edgeorder 子组订单项管理订单项。

命令

名称	说明	类型	状态
az edgeorder order-item cancel	取消订单项。	分机	GA
az edgeorder order-item create	创建订单项。 现有订单项不能使用此 API 进行更新，应改为使用更新订单项 API 进行更新。	扩展	GA
az edgeorder order-item delete	删除订单项。	扩展	GA
az edgeorder order-item list	在资源组级别列出订单项。 在订阅级别列出订单项。	扩展	GA
az edgeorder order-item return	返回订单项。	分机	GA
az edgeorder order-item show	获取订单项。	扩展	GA
az edgeorder order-item update	更新现有订单项的属性。	分机	GA
az edgeorder order-item wait	将 CLI 置于等待状态，直到满足订单项的条件。	分机	GA

az edgeorder order-item cancel

取消订单项。

az edgeorder order-item cancel --reason
                               [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]

示例

CancelOrderItem

az edgeorder order-item cancel --reason "Order cancelled" --name "TestOrderItemName1" --resource-group "TestRG"

必需参数

--reason

取消的原因。

可选参数

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name --order-item-name -n

订单项的名称。

--resource-group -g

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

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az edgeorder order-item create

创建订单项。 现有订单项不能使用此 API 进行更新，应改为使用更新订单项 API 进行更新。

az edgeorder order-item create --name
                               --order-item-resource
                               --resource-group
                               [--no-wait]

示例

CreateOrderItem

az edgeorder order-item create --name "TestOrderItemName01" --order-item-resource "{\"location\":\"eastus\",\"tags\":{\"carrot\":\"vegetable\",\"mango\":\"fruit\"},\"orderItemDetails\":{\"orderItemType\":\"Purchase\",\"preferences\":{\"transportPreferences\":{\"preferredShipmentType\":\"MicrosoftManaged\"}},\"productDetails\":{\"hierarchyInformation\":{\"configurationName\":\"edgep_base\",\"productFamilyName\":\"azurestackedge\",\"productLineName\":\"azurestackedge\",\"productName\":\"azurestackedgegpu\"}}},\"addressDetails\":{\"forwardAddress\":{\"contactDetails\":{\"contactName\":\"Petr Cech\",\"emailList\":[\"ssemmail@microsoft.com\",\"vishwamdir@microsoft.com\"],\"phone\":\"3213131190\",\"phoneExtension\":\"\"},\"shippingAddress\":{\"addressType\":\"None\",\"city\":\"San Francisco\",\"companyName\":\"Microsoft\",\"country\":\"US\",\"postalCode\":\"94107\",\"stateOrProvince\":\"CA\",\"streetAddress1\":\"16 TOWNSEND ST\",\"streetAddress2\":\"UNIT 1\"}}},\"orderId\":\"/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderItemName01\"}" --resource-group "TestRG"

必需参数

--name --order-item-name -n

订单项的名称。

--order-item-resource

来自请求正文的订单项详细信息。 预期值：json-string/json-file/@json-file。

--resource-group -g

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

可选参数

--no-wait

不等待长时间运行的操作完成。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az edgeorder order-item delete

删除订单项。

az edgeorder order-item delete [--ids]
                               [--name]
                               [--no-wait]
                               [--resource-group]
                               [--subscription]
                               [--yes]

示例

DeleteOrderItemByName

az edgeorder order-item delete --name "TestOrderItemName01" --resource-group "TestRG"

可选参数

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name --order-item-name -n

订单项的名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--resource-group -g

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

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az edgeorder order-item list

在资源组级别列出订单项。 在订阅级别列出订单项。

az edgeorder order-item list [--expand]
                             [--filter]
                             [--resource-group]
                             [--skip-token]

示例

ListOrderItemsAtResourceGroupLevel

az edgeorder order-item list --resource-group "TestRG"

ListOrderItemsAtSubscriptionLevel

az edgeorder order-item list

可选参数

--expand

设备详细信息、转发发货详细信息和反向发货详细信息参数支持$expand。 每个列表都可以以逗号分隔列表的形式提供。 订单项的设备详细信息提供有关产品设备的详细信息，转发和反向发货详细信息分别提供转发和反向发货详细信息。

--filter

支持$filter根据订单 ID 进行筛选。筛选器仅支持等于操作。

--resource-group -g

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

--skip-token

“获取订单项”列表支持$skipToken，该列表提供订单项列表中的下一页。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az edgeorder order-item return

返回订单项。

az edgeorder order-item return --return-reason
                               [--contact-details]
                               [--ids]
                               [--name]
                               [--no-wait]
                               [--resource-group]
                               [--service-tag]
                               [--shipping-address]
                               [--shipping-box-required {false, true}]
                               [--subscription]

示例

ReturnOrderItem

az edgeorder order-item return --name "TestOrderName1" --resource-group "TestRG" --return-reason "Order returned"

必需参数

--return-reason

返回原因。

可选参数

--contact-details

地址的联系人详细信息。

使用情况：--contact-details contact-name=XX phone=XX phone-extension=XX mobile=XX email-list=XX

contact-name：必需。 联系人的联系人姓名。 电话：必需。 电话联系人的号码。 电话分机：电话联系人的分机号码。 移动：联系人的移动电话号码。 email-list：必需。 要通知有关作业进度的电子邮件 ID 的列表。

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name --order-item-name -n

订单项的名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--resource-group -g

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

--service-tag

服务标记（位于设备的右下角）。

--shipping-address

地址的寄送详细信息。

用法：--shipping-address street-address1=XX street-address2=XX street-address3=XX city=XX state-or-province=XX country=XX 邮政编码=XX zip-extended-code=XX company-name=XX address-type=XX

street-address1：必需。 街道地址行 1。 street-address2：街道地址行 2。 street-address3：街道地址行 3。 city：City 的名称。 州或省：州或省的名称。 国家/地区：必需。 国家/地区的名称。 邮政编码：邮政编码。 zip-extended-code：扩展的邮政编码。 公司名称：公司名称。 address-type：地址类型。

--shipping-box-required

需要寄送箱。

接受的值: false, true

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az edgeorder order-item show

获取订单项。

az edgeorder order-item show [--expand]
                             [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]

示例

GetOrderItemByName

az edgeorder order-item show --name "TestOrderItemName01" --resource-group "TestRG"

可选参数

--expand

设备详细信息、转发发货详细信息和反向发货详细信息参数支持$expand。 每个列表都可以以逗号分隔列表的形式提供。 订单项的设备详细信息提供有关产品设备的详细信息，转发和反向发货详细信息分别提供转发和反向发货详细信息。

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name --order-item-name -n

订单项的名称。

--resource-group -g

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

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az edgeorder order-item update

更新现有订单项的属性。

az edgeorder order-item update [--contact-details]
                               [--encryption-preferences]
                               [--ids]
                               [--if-match]
                               [--mgmt-preferences]
                               [--name]
                               [--no-wait]
                               [--notif-email-list]
                               [--notif-preferences]
                               [--resource-group]
                               [--shipping-address]
                               [--subscription]
                               [--tags]
                               [--transport-preferences]

示例

UpdateOrderItem

az edgeorder order-item update --name "TestOrderItemName01" --contact-details contact-name="Updated contact name" email-list="testemail@microsoft.com" phone="2222200000" --transport-preferences preferred-shipment-type="CustomerManaged" --tags ant="insect" pigeon="bird" tiger="animal" --resource-group "TestRG"

可选参数

--contact-details

地址的联系人详细信息。

使用情况：--contact-details contact-name=XX phone=XX phone-extension=XX mobile=XX email-list=XX

contact-name：必需。 联系人的联系人姓名。 电话：必需。 电话联系人的号码。 电话分机：电话联系人的分机号码。 移动：联系人的移动电话号码。 email-list：必需。 要通知有关作业进度的电子邮件 ID 的列表。

--encryption-preferences

与加密相关的首选项。

用法：--encryption-preferences double-encryption-status=XX

double-encryption-status：客户输入的双重加密状态。 如果配置了“拒绝”或“禁用”策略，则强制为此参数提供此参数。

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--if-match

定义 If-Match 条件。 仅当服务器上的订单 ETag 与此值匹配时，才会执行修补程序。

--mgmt-preferences

与管理资源相关的首选项。

用法：--mgmt-preferences preferred-management-resource-id=XX

preferred-management-resource-id：客户首选管理资源 ARM ID。

--name --order-item-name -n

订单项的名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--notif-email-list

其他通知电子邮件列表。

--notif-preferences

通知首选项。

用法：--notif-preferences 阶段名称=XX send-notification=XX

stage-name：必需。 阶段的名称。 send-notification：必需。 需要通知。

可以使用多个 --notification-preferences 参数指定多个操作。

--resource-group -g

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

--shipping-address

地址的寄送详细信息。

用法：--shipping-address street-address1=XX street-address2=XX street-address3=XX city=XX state-or-province=XX country=XX 邮政编码=XX zip-extended-code=XX company-name=XX address-type=XX

street-address1：必需。 街道地址行 1。 street-address2：街道地址行 2。 street-address3：街道地址行 3。 city：City 的名称。 州或省：州或省的名称。 国家/地区：必需。 国家/地区的名称。 邮政编码：邮政编码。 zip-extended-code：扩展的邮政编码。 公司名称：公司名称。 address-type：地址类型。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--transport-preferences

与订单的发货物流相关的首选项。

用法：--transport-preferences preferred-shipment-type=XX

preferred-shipment-type：必需。 指示客户首选的发货物流类型。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az edgeorder order-item wait

将 CLI 置于等待状态，直到满足订单项的条件。

az edgeorder order-item wait --order-item-name
                             --resource-group
                             [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--expand]
                             [--interval]
                             [--timeout]
                             [--updated]

必需参数

--order-item-name

订单项的名称。

--resource-group -g

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

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--expand

设备详细信息、转发发货详细信息和反向发货详细信息参数支持$expand。

--interval

轮询间隔（以秒为单位）。

默认值: 30

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。