az edgeorder order-item

備註

此參考是 Azure CLI edgeorder 延伸模組的一部分（2.15.0 版或更高版本）。 擴充功能會在您第一次執行 az edgeorder order-item 命令時，自動安裝。 深入瞭解擴充功能。

使用edgeorder子群組順序專案來管理訂單專案。

命令

名稱	Description	類型	狀態
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

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

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

訂單項目的名稱。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 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

訂用帳戶的名稱或標識碼。 您可以使用 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

訂用帳戶的名稱或標識碼。 您可以使用 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

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

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

訂單項目的名稱。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 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

訂用帳戶的名稱或標識碼。 您可以使用 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根據訂單標識符進行篩選。篩選僅支援等於作業。

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

訂用帳戶的名稱或標識碼。 您可以使用 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：必要。 聯繫人的聯繫人名稱。 電話：必要。 聯繫人的電話號碼。 電話分機：聯繫人的電話號碼。 mobile：聯繫人的行動電話號碼。 email-list：必要專案。 要通知作業進度的電子郵件標識碼清單。

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--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 postal-code=XX zip-extended-code=XX company-name=XX address-type=XX

street-address1：必要。 街道地址行 1。 street-address2：街道位址第 2 行。 street-address3：街道地址行 3。 city：城市的名稱。 州或省：州或省的名稱。 國家/地區：必要。 國家/地區名稱。 郵遞區號：郵遞區號。 zip-extended-code：延伸的郵遞區號。 company-name：公司名稱。 address-type：位址的類型。

--shipping-box-required

需要出貨箱。

接受的值: false, true

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 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

訂用帳戶的名稱或標識碼。 您可以使用 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

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

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

訂單項目的名稱。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 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

訂用帳戶的名稱或標識碼。 您可以使用 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：必要。 聯繫人的聯繫人名稱。 電話：必要。 聯繫人的電話號碼。 電話分機：聯繫人的電話號碼。 mobile：聯繫人的行動電話號碼。 email-list：必要專案。 要通知作業進度的電子郵件標識碼清單。

--encryption-preferences

與加密相關的喜好設定。

使用方式：--encryption-preferences double-encryption-status=XX

double-encryption-status：客戶輸入的雙重加密狀態。 如果已設定 『Deny』 或 'Disabled' 原則，則強制提供此參數。

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--if-match

定義 If-Match 條件。 只有在伺服器上的 ETag 符合此值時，才會執行修補程式。

--mgmt-preferences

與管理資源相關的喜好設定。

使用量：--mgmt-preferences preferred-management-resource-id=XX

preferred-management-resource-id：客戶慣用的管理資源 ARM 標識符。

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

訂單項目的名稱。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--notif-email-list

其他通知電子郵件清單。

--notif-preferences

通知喜好設定。

使用量：--notif-preferences stage-name=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 postal-code=XX zip-extended-code=XX company-name=XX address-type=XX

street-address1：必要。 街道地址行 1。 street-address2：街道位址第 2 行。 street-address3：街道地址行 3。 city：城市的名稱。 州或省：州或省的名稱。 國家/地區：必要。 國家/地區名稱。 郵遞區號：郵遞區號。 zip-extended-code：延伸的郵遞區號。 company-name：公司名稱。 address-type：位址的類型。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 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

訂用帳戶的名稱或標識碼。 您可以使用 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

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。