次の方法で共有

az edgeorder order-item

  • リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.15.0 以降) の edgeorder 拡張機能の一部です。 拡張機能は、az edgeorder order-item コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

edgeorder サブグループ order-item を使用して注文項目を管理します。

コマンド

名前 説明 型 Status
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

order-item の条件が満たされるまで、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

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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: 必須。 ユーザーの連絡先名。 phone: 必須。 連絡先の番号を電話します。 電話内線番号: 連絡先の内線番号を電話します。 mobile: 連絡先の携帯電話番号。 email-list: 必須。 ジョブの進行状況について通知する電子メール ID の一覧。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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 postal-code=XX zip-extended-code=XX company-name=XX address-type=XX

street-address1: 必須。 番地 1 行目。 street-address2: Street Address line 2. street-address3: 番地 3. city: 市区町村の名前。 都道府県: 州または都道府県の名前。 country: 必須。 国の名前。 郵便番号: 郵便番号。 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

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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: 必須。 ユーザーの連絡先名。 phone: 必須。 連絡先の番号を電話します。 電話内線番号: 連絡先の内線番号を電話します。 mobile: 連絡先の携帯電話番号。 email-list: 必須。 ジョブの進行状況について通知する電子メール ID の一覧。

--encryption-preferences

暗号化に関連する基本設定。

使用法: --encryption-preferences double-encryption-status=XX

double-encryption-status: 顧客が入力した二重暗号化の状態。 "拒否" または "無効" ポリシーが構成されている場合は、このパラメーターを指定することが必須です。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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 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: Street Address line 2. street-address3: 番地 3. city: 市区町村の名前。 都道府県: 州または都道府県の名前。 country: 必須。 国の名前。 郵便番号: 郵便番号。 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

order-item の条件が満たされるまで、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

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: 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 を使います。