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

Get Order By Name - Get Order By Name

获取订单。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/locations/{location}/orders/{orderName}?api-version=2021-12-01

URI 参数

名称 必需 类型 说明
location
path True

string

Azure 区域的名称。

orderName
path True

string

订单的名称

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

OrderResource

Order 对象

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

GetOrderByName

示例请求

GET https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName3?api-version=2021-12-01

示例响应

{
  "properties": {
    "orderItemIds": [
      "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3"
    ],
    "currentStage": {
      "stageStatus": "Succeeded",
      "stageName": "InReview",
      "startTime": "2022-03-04T11:35:20.8521455+05:30"
    },
    "orderStageHistory": [
      {
        "stageStatus": "Succeeded",
        "stageName": "Placed",
        "startTime": "2022-03-04T11:30:30.2717243+05:30"
      },
      {
        "stageStatus": "Succeeded",
        "stageName": "InReview",
        "startTime": "2022-03-04T11:35:20.8521455+05:30"
      }
    ]
  },
  "systemData": {
    "createdAt": "0001-01-01T05:30:00+05:30",
    "lastModifiedAt": "0001-01-01T05:30:00+05:30"
  },
  "name": "TestOrderName3",
  "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName3",
  "type": "Microsoft.EdgeOrder/orders"
}

定义

名称 说明
createdByType

创建资源的标识类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

OrderResource

指定订单的属性或参数。 订单是一个或多个订单项的分组。

StageDetails

资源阶段详细信息。

StageName

阶段名称

StageStatus

阶段状态。

systemData

与资源的创建和上次修改相关的元数据。

createdByType

创建资源的标识类型。

名称 类型 说明
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

错误对象。

OrderResource

指定订单的属性或参数。 订单是一个或多个订单项的分组。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.currentStage

StageDetails

订单的当前状态。

properties.orderItemIds

string[]

属于订单的订单项 ARM ID 的列表。

properties.orderStageHistory

StageDetails[]

订单状态历史记录。

systemData

systemData

表示资源创建和更新时间

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

StageDetails

资源阶段详细信息。

名称 类型 说明
displayName

string

资源阶段的显示名称。

stageName

StageName

阶段名称

stageStatus

StageStatus

阶段状态。

startTime

string

阶段开始时间

StageName

阶段名称

名称 类型 说明
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

阶段状态。

名称 类型 说明
Cancelled

string

阶段已取消。

Cancelling

string

阶段正在取消。

Failed

string

阶段失败。

InProgress

string

阶段正在进行中。

None

string

目前还没有可用的状态。

Succeeded

string

阶段已成功。

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源的创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。