Orders - List By Subscription

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

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

URI パラメーター

Name In Required Type Description
subscriptionId
path True
  • string

ターゲット サブスクリプションの ID。

api-version
query True
  • string

この操作に使用する API バージョン。

$skipToken
query
  • string

$skipTokenは、注文の一覧の取得でサポートされており、注文の一覧の次のページが表示されます。

$top
query
  • integer
int32

$topは、リソースの一覧をフェッチする場合にサポートされます。 $top=10 は、リスト内の最初の 10 個の項目が API 呼び出し元に返されることを意味します。

応答

Name Type Description
200 OK

サブスクリプションで利用可能な注文の一覧。

Other Status Codes

操作エラーの理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

ListOrderAtSubscriptionLevel

Sample Request

GET https://management.azure.com/subscriptions/YourSubscriptionId/providers/Microsoft.EdgeOrder/orders?api-version=2022-05-01-preview

Sample Response

{
  "value": [
    {
      "properties": {
        "orderItemIds": [
          "/subscriptions/YourSubscriptionId/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/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1",
      "type": "Microsoft.EdgeOrder/orders"
    },
    {
      "properties": {
        "orderItemIds": [
          "/subscriptions/YourSubscriptionId/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/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2",
      "type": "Microsoft.EdgeOrder/orders"
    }
  ]
}

定義

createdByType

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

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

OrderMode

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

OrderResource

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

OrderResourceList

注文の一覧。

StageDetails

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

StageName

ステージ名。

StageStatus

ステージの状態。

systemData

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

createdByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

追加情報。

type
  • string

追加情報の種類。

ErrorDetail

エラーの詳細。

Name Type Description
additionalInfo

エラーの追加情報。

code
  • string

エラー コード。

details

エラーの詳細です。

message
  • string

エラー メッセージ。

target
  • string

エラーターゲット。

ErrorResponse

エラー応答

Name Type Description
error

エラー オブジェクト。

OrderMode

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

Name Type Description
Default
  • string

既定の注文モード。

DoNotFulfill
  • string

注文が満たされないモード。

OrderResource

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

Name Type Description
id
  • string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

リソースの名前

properties.currentStage

注文の現在の状態。

properties.orderItemIds
  • string[]

注文の一部である注文項目 ARM ID の一覧。

properties.orderMode

注文モード。

properties.orderStageHistory

注文の状態の履歴。

systemData

リソースの作成と更新の時刻を表します。

type
  • string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

OrderResourceList

注文の一覧。

Name Type Description
nextLink
  • string

注文リソースの次のセットへのリンク。

value

注文リソースの一覧。

StageDetails

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

Name Type Description
displayName
  • string

リソース ステージの表示名。

stageName

ステージ名。

stageStatus

ステージの状態。

startTime
  • string

ステージの開始時刻。

StageName

ステージ名。

Name Type Description
Cancelled
  • string

注文は取り消されました。

Confirmed
  • string

注文が確定しました。

Delivered
  • string

注文は顧客に配信されます。

InReview
  • string

注文は現在下書きモードであり、引き続きキャンセルできます。

InUse
  • string

注文は顧客サイトで使用されています。

Placed
  • string

現在下書きモードであり、引き続き取り消すことができます。

ReadyToShip
  • string

注文は出荷する準備ができています。

ReturnCompleted
  • string

戻り値が完了しました。

ReturnInitiated
  • string

返品は顧客によって開始されました。

ReturnPickedUp
  • string

注文は顧客から Microsoft に転送中です。

ReturnedToMicrosoft
  • string

注文は Microsoft に返送されました。

Shipped
  • string

注文は顧客に転送中です。

StageStatus

ステージの状態。

Name Type Description
Cancelled
  • string

ステージは取り消されました。

Cancelling
  • string

ステージが取り消されています。

Failed
  • string

ステージが失敗しました。

InProgress
  • string

ステージは進行中です。

None
  • string

利用可能な状態はまだありません。

Succeeded
  • string

ステージが成功しました。

systemData

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

Name Type Description
createdAt
  • string

リソース作成のタイムスタンプ (UTC)。

createdBy
  • string

リソースを作成した ID。

createdByType

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

lastModifiedAt
  • string

リソースの最終変更 (UTC) のタイムスタンプ

lastModifiedBy
  • string

リソースを最後に変更した ID。

lastModifiedByType

リソースを最後に変更した ID の種類。