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

Order Items - Get

获取订单项。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}?api-version=2024-02-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}?api-version=2024-02-01&$expand={$expand}

URI 参数

名称 必需 类型 说明
orderItemName
path True

string

订单项的名称。

正则表达式模式: ^[A-Za-z0-9][-A-Za-z0-9]*[A-Za-z0-9]$|^[A-Za-z0-9]$

resourceGroupName
path True

string

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

subscriptionId
path True

string

uuid

目标订阅的 ID。 该值必须是 UUID。

api-version
query True

string

要用于此操作的 API 版本。

$expand
query

string

父设备详细信息、设备详细信息、转发发货详细信息和反向发货详细信息参数支持$expand。 其中每个列表都可以作为逗号分隔列表提供。 订单项的父设备详细信息提供有关产品设备的详细信息,订单项的设备详细信息提供有关产品子配置设备的详细信息,转发和反向发货详细信息分别提供转发和反向发货详细信息。

响应

名称 类型 说明
200 OK

OrderItemResource

Order item 对象。

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

GetOrderItemByName

示例请求

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

示例响应

{
  "properties": {
    "orderItemDetails": {
      "productDetails": {
        "displayInfo": {
          "productFamilyDisplayName": "Azure Stack Edge",
          "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU"
        },
        "hierarchyInformation": {
          "productFamilyName": "azurestackedge",
          "productLineName": "azurestackedge",
          "productName": "azurestackedgegpu",
          "configurationName": "edgep_base"
        },
        "productDoubleEncryptionStatus": "Disabled"
      },
      "orderItemType": "Purchase",
      "currentStage": {
        "stageStatus": "Succeeded",
        "stageName": "Confirmed",
        "startTime": "2022-03-04T11:05:00.3575338+05:30"
      },
      "orderItemStageHistory": [
        {
          "stageStatus": "Succeeded",
          "stageName": "Placed",
          "startTime": "2022-03-04T10:55:54.3427968+05:30"
        },
        {
          "stageStatus": "Succeeded",
          "stageName": "Confirmed",
          "startTime": "2022-03-04T11:05:00.3575338+05:30"
        },
        {
          "stageStatus": "None",
          "stageName": "ReadyToShip"
        },
        {
          "stageStatus": "None",
          "stageName": "Shipped"
        },
        {
          "stageStatus": "None",
          "stageName": "Delivered"
        },
        {
          "stageStatus": "None",
          "stageName": "InUse"
        }
      ],
      "preferences": {
        "transportPreferences": {
          "preferredShipmentType": "MicrosoftManaged"
        }
      },
      "notificationEmailList": [],
      "cancellationStatus": "NotCancellable",
      "deletionStatus": "NotAllowed",
      "returnStatus": "NotReturnable",
      "managementRpDetailsList": [
        {
          "resourceProviderNamespace": "Microsoft.DataBoxEdge"
        }
      ]
    },
    "addressDetails": {
      "forwardAddress": {
        "shippingAddress": {
          "streetAddress1": "16 TOWNSEND ST",
          "streetAddress2": "UNIT 1",
          "city": "San Francisco",
          "stateOrProvince": "CA",
          "country": "US",
          "postalCode": "94107",
          "companyName": "Microsoft",
          "addressType": "None"
        },
        "contactDetails": {
          "contactName": "XXXX XXXX",
          "phone": "0000000000",
          "phoneExtension": "",
          "emailList": [
            "xxxx@xxxx.xxx"
          ]
        },
        "addressValidationStatus": "Valid"
      }
    },
    "startTime": "2022-03-04T10:55:10.2820482+05:30",
    "orderId": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1"
  },
  "systemData": {
    "createdAt": "0001-01-01T05:30:00+05:30",
    "lastModifiedAt": "0001-01-01T05:30:00+05:30"
  },
  "location": "eastus",
  "tags": {},
  "name": "TestOrderItemName1",
  "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1",
  "type": "Microsoft.EdgeOrder/orderItems"
}

定义

名称 说明
ActionStatusEnum

描述订单项是否可删除。

AdditionalConfiguration

其他配置详细信息。

AddressClassification

基于其使用上下文的地址类型。

AddressDetails

订单项的地址详细信息。

AddressProperties

地址属性。

AddressType

地址类型。

AddressValidationStatus

地址验证的状态。

AutoProvisioningStatus

自动预配详细信息。

ConfigurationDeviceDetails

配置的设备详细信息。

ContactDetails

联系人详细信息。

createdByType

创建资源的标识类型。

DeviceDetails

设备详细信息。

DevicePresenceVerificationDetails

所有权证明详细信息。

DevicePresenceVerificationStatus

所有权状态的证明。

DisplayInfo

描述产品显示信息。

DoubleEncryptionStatus

客户输入的双重加密状态。 如果配置了“拒绝”或“禁用”策略,则必须提供此参数。

EncryptionPreferences

与双重加密相关的首选项。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ForwardShippingDetails

转发发货详细信息。

HierarchyInformation

保存有关产品层次结构信息的详细信息。

IdentificationType

配置的标识类型。

ManagementResourcePreferences

用于链接设备的管理资源首选项。

NotificationPreference

作业阶段的通知首选项。

NotificationStageName

阶段的名称。

OrderItemCancellationEnum

描述订单项是否可取消。

OrderItemDetails

订单项详细信息。

OrderItemResource

表示订单项资源。

OrderItemReturnEnum

描述订单项是否可返回。

OrderItemType

订单项类型。

OrderMode

定义 Order 项的模式。

Preferences

与订单相关的首选项。

ProductDetails

表示产品详细信息。

ProvisioningDetails

与预配资源相关的详细信息。

ProvisioningState

正在设置状态

ProvisioningSupport

确定配置支持的预配的性质。

ResourceIdentity

资源的 Msi 标识详细信息

ResourceProviderDetails

管理 RP 详细信息。

ReverseShippingDetails

反向发货详细信息。

ShippingAddress

客户希望接收设备的送货地址。

SiteDetails

表示网站相关详细信息。

StageDetails

资源阶段详细信息。

StageName

阶段名称。

StageStatus

阶段状态。

systemData

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

TermCommitmentInformation

期限承诺信息。

TermCommitmentPreferences

从客户收到的期限承诺首选项。

TermCommitmentType

期限承诺类型

TransportPreferences

与 SKU 的发货物流相关的首选项。

TransportShipmentTypes

指示客户首选的“发货物流”类型。

UserAssignedIdentity

用户分配的标识属性

ActionStatusEnum

描述订单项是否可删除。

名称 类型 说明
Allowed

string

允许的标志。

NotAllowed

string

“不允许”标志。

AdditionalConfiguration

其他配置详细信息。

名称 类型 说明
hierarchyInformation

HierarchyInformation

唯一标识配置的产品层次结构。

provisioningDetails

ProvisioningDetails[]

在“其他配置”中列出设备的预配详细信息。

quantity

integer

产品的数量。

AddressClassification

基于其使用上下文的地址类型。

名称 类型 说明
Shipping

string

订单的送货地址。

Site

string

站点地址:

AddressDetails

订单项的地址详细信息。

名称 类型 说明
forwardAddress

AddressProperties

客户地址和联系人详细信息。

returnAddress

AddressProperties

退货送货地址。

AddressProperties

地址属性。

名称 类型 说明
addressClassification

AddressClassification

基于其使用上下文的地址类型。

addressValidationStatus

AddressValidationStatus

地址验证的状态。

contactDetails

ContactDetails

地址的联系人详细信息。

provisioningState

ProvisioningState

正在设置状态

shippingAddress

ShippingAddress

地址的寄送详细信息。

AddressType

地址类型。

名称 类型 说明
Commercial

string

商业地址。

None

string

地址类型未知。

Residential

string

住宅地址。

AddressValidationStatus

地址验证的状态。

名称 类型 说明
Ambiguous

string

提供的地址不明确,请选择返回的备用地址之一。

Invalid

string

提供的地址无效或不受支持。

Valid

string

提供的地址有效。

AutoProvisioningStatus

自动预配详细信息。

名称 类型 说明
Disabled

string

预配已禁用。

Enabled

string

预配已启用。 将充当预先批准的设备,并在验证设备位于右边缘位置后立即启用 arc 扩展。

ConfigurationDeviceDetails

配置的设备详细信息。

名称 类型 说明
deviceDetails

DeviceDetails[]

设备详细信息列表。

displayInfo

DisplayInfo

显示产品的详细信息。

hierarchyInformation

HierarchyInformation

唯一标识配置的产品层次结构。

identificationType

IdentificationType

配置的标识类型。

quantity

integer

产品的数量。

termCommitmentInformation

TermCommitmentInformation

设备的期限承诺信息。

ContactDetails

联系人详细信息。

名称 类型 说明
contactName

string

此人的联系人姓名。

emailList

string[]

要通知作业进度的Email ID 列表。

mobile

string

联系人的移动电话号码。

phone

string

联系人的电话号码。

phoneExtension

string

联系人的电话分机号。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

DeviceDetails

设备详细信息。

名称 类型 说明
displaySerialNumber

string

要显示的设备序列号。

managementResourceId

string

管理资源 ID。

managementResourceTenantId

string

管理资源租户 ID。

provisioningDetails

ProvisioningDetails

设备的预配详细信息。

provisioningSupport

ProvisioningSupport

确定配置支持的预配的性质。

serialNumber

string

设备序列号。

DevicePresenceVerificationDetails

所有权证明详细信息。

名称 类型 说明
message

string

有关当前状态的见解。

status

DevicePresenceVerificationStatus

所有权状态的证明。

DevicePresenceVerificationStatus

所有权状态的证明。

名称 类型 说明
Completed

string

确认设备已验证为使用右边缘操作员或位于正确的位置。

NotInitiated

string

尚未验证设备是否使用右边缘操作员或位于正确的位置。

DisplayInfo

描述产品显示信息。

名称 类型 说明
configurationDisplayName

string

配置显示名称。

productFamilyDisplayName

string

产品系列显示名称。

DoubleEncryptionStatus

客户输入的双重加密状态。 如果配置了“拒绝”或“禁用”策略,则必须提供此参数。

名称 类型 说明
Disabled

string

双重加密已禁用。

Enabled

string

启用了双重加密。

EncryptionPreferences

与双重加密相关的首选项。

名称 类型 说明
doubleEncryptionStatus

DoubleEncryptionStatus

客户输入的双重加密状态。 如果配置了“拒绝”或“禁用”策略,则必须提供此参数。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ForwardShippingDetails

转发发货详细信息。

名称 类型 说明
carrierDisplayName

string

用于显示目的的运营商名称。 不用于任何处理。

carrierName

string

运营商的名称。

trackingId

string

包的 TrackingId。

trackingUrl

string

包的 TrackingUrl。

HierarchyInformation

保存有关产品层次结构信息的详细信息。

名称 类型 说明
configurationIdDisplayName

string

表示模型显示名称。

configurationName

string

表示唯一标识配置的配置名称。

productFamilyName

string

表示唯一标识产品系列的产品系列名称。

productLineName

string

表示唯一标识产品系列的产品系列名称。

productName

string

表示唯一标识产品的产品名称。

IdentificationType

配置的标识类型。

名称 类型 说明
NotSupported

string

产品没有任何显式标识符。

SerialNumber

string

产品可通过序列号进行标识。

ManagementResourcePreferences

用于链接设备的管理资源首选项。

名称 类型 说明
preferredManagementResourceId

string

客户首选管理资源 ARM ID。

NotificationPreference

作业阶段的通知首选项。

名称 类型 说明
sendNotification

boolean

是否需要通知。

stageName

NotificationStageName

阶段的名称。

NotificationStageName

阶段的名称。

名称 类型 说明
Delivered

string

订单项交付给客户的通知。

Shipped

string

从 Microsoft 数据中心发货的订单项通知。

OrderItemCancellationEnum

描述订单项是否可取消。

名称 类型 说明
Cancellable

string

订单项可以取消,不收取任何费用。

CancellableWithFee

string

订单项可以取消并收取费用。

NotCancellable

string

订单项不可取消。

OrderItemDetails

订单项详细信息。

名称 类型 说明
cancellationReason

string

取消原因。

cancellationStatus

OrderItemCancellationEnum

描述订单项是否可取消。

currentStage

StageDetails

当前订单项状态。

deletionStatus

ActionStatusEnum

描述订单项是否可删除。

error

ErrorDetail

作业的顶级错误。

forwardShippingDetails

ForwardShippingDetails

转发包裹寄送详细信息。

managementRpDetailsList

ResourceProviderDetails[]

支持配置的父 RP 详细信息列表。

notificationEmailList

string[]

其他通知电子邮件列表。

orderItemMode

OrderMode

定义 Order 项的模式。

orderItemStageHistory

StageDetails[]

订单项状态历史记录。

orderItemType

OrderItemType

订单项类型。

preferences

Preferences

客户通知首选项。

productDetails

ProductDetails

表示产品详细信息。

returnReason

string

返回原因。

returnStatus

OrderItemReturnEnum

描述订单项是否可返回。

reverseShippingDetails

ReverseShippingDetails

反向包裹寄送详细信息。

siteDetails

SiteDetails

网站相关详细信息。

OrderItemResource

表示订单项资源。

名称 类型 说明
id

string

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

identity

ResourceIdentity

资源的 Msi 标识

location

string

资源所在的地理位置

name

string

资源的名称

properties.addressDetails

AddressDetails

表示订单项的发货和退货地址。

properties.orderId

string

订单项所属订单的 ID。

properties.orderItemDetails

OrderItemDetails

表示订单项详细信息。

properties.provisioningState

ProvisioningState

正在设置状态

properties.startTime

string

订单项的开始时间。

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

tags

object

资源标记。

type

string

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

OrderItemReturnEnum

描述订单项是否可返回。

名称 类型 说明
NotReturnable

string

订单项不可退回。

Returnable

string

可以不收取任何费用退回订单项。

ReturnableWithFee

string

订单项可以退回并收取费用。

OrderItemType

订单项类型。

名称 类型 说明
External

string

在 Azure 外部下达的订单。

Purchase

string

Purchase OrderItem。

Rental

string

Rental OrderItem。

OrderMode

定义 Order 项的模式。

名称 类型 说明
Default

string

默认订单模式。

DoNotFulfill

string

订单将不履行的模式。

Preferences

与订单相关的首选项。

名称 类型 说明
encryptionPreferences

EncryptionPreferences

与加密相关的首选项。

managementResourcePreferences

ManagementResourcePreferences

与管理资源相关的首选项。

notificationPreferences

NotificationPreference[]

通知首选项。

termCommitmentPreferences

TermCommitmentPreferences

与期限承诺相关的首选项。

transportPreferences

TransportPreferences

与订单的发货物流相关的首选项。

ProductDetails

表示产品详细信息。

名称 类型 说明
childConfigurationDeviceDetails

ConfigurationDeviceDetails[]

属于订单项的所有子配置的详细信息。

displayInfo

DisplayInfo

显示产品的详细信息。

hierarchyInformation

HierarchyInformation

唯一标识产品的产品的层次结构。

identificationType

IdentificationType

配置的标识类型。

optInAdditionalConfigurations

AdditionalConfiguration[]

除基本配置中包含的配置外,订单项中客户需要的其他配置列表。

parentDeviceDetails

DeviceDetails

父配置的设备详细信息。

parentProvisioningDetails

ProvisioningDetails

父级的设备预配详细信息。

productDoubleEncryptionStatus

DoubleEncryptionStatus

配置的双重加密状态。 只读字段。

termCommitmentInformation

TermCommitmentInformation

设备的期限承诺信息。

ProvisioningDetails

与预配资源相关的详细信息。

名称 类型 默认值 说明
autoProvisioningStatus

AutoProvisioningStatus

自动预配详细信息。

devicePresenceVerification

DevicePresenceVerificationDetails

所有权证明详细信息。

managementResourceArmId

string

管理资源 ArmId。

provisioningArmId

string

预配资源 Arm ID。

provisioningEndPoint

string

预配终结点。

quantity

integer

0

设备的数量。

readyToConnectArmId

string

已启用 Arc 的资源 Arm ID。

serialNumber

string

设备的序列号。

uniqueDeviceIdentifier

string

设备的唯一标识。

vendorName

string

设备的供应商名称 ,1P 设备的 (- Microsoft) 。

ProvisioningState

正在设置状态

名称 类型 说明
Canceled

string

已取消状态。

Creating

string

正在创建状态。

Failed

string

失败状态。

Succeeded

string

成功状态。

ProvisioningSupport

确定配置支持的预配的性质。

名称 类型 说明
CloudBased

string

可以从云预配配置。

Manual

string

配置需要由最终用户手动预配。

ResourceIdentity

资源的 Msi 标识详细信息

名称 类型 默认值 说明
principalId

string

支持 Msi 的服务主体 ID

tenantId

string

家庭租户 ID

type

string

None

标识类型

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned 标识
用户分配的标识

ResourceProviderDetails

管理 RP 详细信息。

名称 类型 说明
resourceProviderNamespace

string

资源提供程序命名空间。

ReverseShippingDetails

反向发货详细信息。

名称 类型 说明
carrierDisplayName

string

用于显示目的的运营商名称。 不用于任何处理。

carrierName

string

运营商的名称。

sasKeyForLabel

string

用于下载包裹的反向发货标签的 SAS 密钥。

trackingId

string

包的 TrackingId。

trackingUrl

string

包的 TrackingUrl。

ShippingAddress

客户希望接收设备的送货地址。

名称 类型 说明
addressType

AddressType

地址类型。

city

string

城市的名称。

companyName

string

公司名称。

country

string

国家/地区的名称。

postalCode

string

邮政编码。

stateOrProvince

string

省/自治区/直辖市或省的名称。

streetAddress1

string

街道地址行 1。

streetAddress2

string

街道地址行 2。

streetAddress3

string

街道地址行 3。

zipExtendedCode

string

扩展邮政编码。

SiteDetails

表示网站相关详细信息。

名称 类型 说明
siteId

string

唯一 ID,标识站点。

StageDetails

资源阶段详细信息。

名称 类型 说明
displayName

string

资源阶段的显示名称。

stageName

StageName

阶段名称。

stageStatus

StageStatus

阶段状态。

startTime

string

阶段开始时间。

StageName

阶段名称。

名称 类型 说明
Cancelled

string

订单已取消。

Confirmed

string

订单已确认。

Delivered

string

订单将交付给客户。

InReview

string

订单当前处于草稿模式,仍可取消。

InUse

string

订单在客户站点使用。

Placed

string

当前处于草稿模式,仍可取消。

ReadyToSetup

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

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

TermCommitmentInformation

期限承诺信息。

名称 类型 默认值 说明
pendingDaysForTerm

integer

0

期限承诺的待定天数

termCommitmentType

TermCommitmentType

期限承诺类型

termCommitmentTypeDuration

string

期限承诺持续时间。 当前支持 P365D、P1095D

TermCommitmentPreferences

从客户收到的期限承诺首选项。

名称 类型 说明
preferredTermCommitmentDuration

string

客户首选的期限持续时间。

preferredTermCommitmentType

TermCommitmentType

期限承诺类型

TermCommitmentType

期限承诺类型

名称 类型 说明
None

string

即用即付期限承诺模型。

Timed

string

基于时间的期限承诺模型。

Trial

string

试用期限承诺模型。

TransportPreferences

与 SKU 的发货物流相关的首选项。

名称 类型 说明
preferredShipmentType

TransportShipmentTypes

指示客户首选的“发货物流”类型。

TransportShipmentTypes

指示客户首选的“发货物流”类型。

名称 类型 说明
CustomerManaged

string

发货物流由客户处理。

MicrosoftManaged

string

发货物流由 Microsoft 处理。

UserAssignedIdentity

用户分配的标识属性

名称 类型 说明
clientId

string

分配的标识的客户端 ID。

principalId

string

已分配标识的主体 ID。