Orders - List By Subscription

リファレンス

Service:: Edge Hardware Center

API Version:: 2024-02-01

サブスクリプションレベルで注文を一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orders?api-version=2024-02-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orders?api-version=2024-02-01&$skipToken={$skipToken}&$top={$top}

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string uuid	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string	この操作に使用する API バージョン。
$skipToken	query		string	$skipTokenは、注文の一覧の次のページを提供する [注文の一覧を取得する] でサポートされています。
$top	query		integer int32	$topは、リソースの一覧のフェッチでサポートされています。 $top=10 は、リスト内の最初の 10 個の項目が API 呼び出し元に返されることを意味します。

応答

名前	型	説明
200 OK	OrderResourceList	サブスクリプションで利用可能な注文の一覧。
Other Status Codes	ErrorResponse	操作エラーの理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

ListOrderAtSubscriptionLevel

Sample Request

HTTP

GET https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/orders?api-version=2024-02-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "orderItemIds": [
          "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1"
        ],
        "currentStage": {
          "stageStatus": "Succeeded",
          "stageName": "Placed",
          "startTime": "2022-03-04T10:55:46.9437439+05:30"
        },
        "orderStageHistory": [
          {
            "stageStatus": "Succeeded",
            "stageName": "Placed",
            "startTime": "2022-03-04T10:55:46.9437439+05:30"
          },
          {
            "stageStatus": "None",
            "stageName": "InReview"
          }
        ]
      },
      "systemData": {
        "createdAt": "0001-01-01T05:30:00+05:30",
        "lastModifiedAt": "0001-01-01T05:30:00+05:30"
      },
      "name": "TestOrderItemName1",
      "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1",
      "type": "Microsoft.EdgeOrder/orders"
    },
    {
      "properties": {
        "orderItemIds": [
          "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName2"
        ],
        "currentStage": {
          "stageStatus": "InProgress",
          "stageName": "Placed",
          "startTime": "2022-03-04T10:58:46.5241979+05:30"
        },
        "orderStageHistory": [
          {
            "stageStatus": "None",
            "stageName": "Placed"
          },
          {
            "stageStatus": "None",
            "stageName": "InReview"
          }
        ]
      },
      "systemData": {
        "createdAt": "0001-01-01T05:30:00+05:30",
        "lastModifiedAt": "0001-01-01T05:30:00+05:30"
      },
      "name": "TestOrderItemName2",
      "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2",
      "type": "Microsoft.EdgeOrder/orders"
    }
  ]
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
OrderMode	Order アイテムのモードを定義します。
OrderResource	注文のプロパティまたはパラメーターを指定します。 Order は、1 つ以上の注文アイテムのグループ化です。
OrderResourceList	注文の一覧。
StageDetails	リソースステージの詳細。
StageName	ステージ名。
StageStatus	ステージの状態。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

OrderMode

Order アイテムのモードを定義します。

名前	型	説明
Default	string	既定の注文モード。
DoNotFulfill	string	注文が満たされないモード。

OrderResource

注文のプロパティまたはパラメーターを指定します。 Order は、1 つ以上の注文アイテムのグループ化です。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.currentStage	StageDetails	注文の現在の状態。
properties.orderItemIds	string[]	注文の一部である注文項目 ARM ID の一覧。
properties.orderMode	OrderMode	注文モード。
properties.orderStageHistory	StageDetails[]	注文の状態履歴。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

OrderResourceList

注文の一覧。

名前	型	説明
nextLink	string	注文リソースの次のセットへのリンク。
value	OrderResource[]	注文リソースの一覧。

StageDetails

リソースステージの詳細。

名前	型	説明
displayName	string	リソースステージの表示名。
stageName	StageName	ステージ名。
stageStatus	StageStatus	ステージの状態。
startTime	string	ステージの開始時刻。

StageName

ステージ名。

名前	型	説明
Cancelled	string	注文は取り消されました。
Confirmed	string	注文が確定しました。
Delivered	string	注文は顧客に配信されます。
InReview	string	注文は現在下書きモードであり、引き続きキャンセルできます。
InUse	string	注文は顧客サイトで使用されています。
Placed	string	現在下書きモードであり、引き続き取り消すことができます。
ReadyToSetup	string	Order はクラウドに接続する準備ができています。
ReadyToShip	string	注文は発送する準備ができています。
ReturnCompleted	string	戻り値が完了しました。
ReturnInitiated	string	返品は顧客によって開始されました。
ReturnPickedUp	string	注文は顧客から Microsoft に転送中です。
ReturnedToMicrosoft	string	注文は Microsoft に返送されました。
Shipped	string	注文は顧客に転送中です。

StageStatus

ステージの状態。

名前	型	説明
Cancelled	string	ステージが取り消されました。
Cancelling	string	ステージが取り消されています。
Failed	string	ステージが失敗しました。
InProgress	string	ステージは進行中です。
None	string	使用可能な状態はまだありません。
Succeeded	string	ステージは成功しました。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。