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

Update Order Item - Update Order Item

服务:: Edge Hardware Center

API 版本:: 2021-12-01

更新现有订单项的属性。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}?api-version=2021-12-01

URI 参数

名称	在	必需	类型	说明
orderItemName	path	True	string	订单项的名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求头

名称	必需	类型	说明
If-Match		string	定义 If-Match 条件。仅当服务器上的订单 ETag 与此值匹配时，才会执行修补程序。

请求正文

名称	类型	说明
properties.forwardAddress	AddressProperties	更新转发寄送地址和联系人详细信息。
properties.notificationEmailList	string[]	其他通知电子邮件列表。
properties.preferences	Preferences	客户首选项。
tags	object	描述资源的键值对的列表。这些标记可用于查看和分组此资源（跨资源组）。

响应

名称	类型	说明
200 OK	OrderItemResource	订单项资源对象。
202 Accepted		已接受订单项更新请求。
Other Status Codes	ErrorResponse	描述作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

UpdateOrderItem

示例请求

HTTP

PATCH https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3?api-version=2021-12-01

{
  "properties": {
    "preferences": {
      "transportPreferences": {
        "preferredShipmentType": "CustomerManaged"
      }
    }
  }
}

示例响应

状态代码:: 200

{
  "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"
        },
        "count": 0,
        "productDoubleEncryptionStatus": "Disabled"
      },
      "orderItemType": "Purchase",
      "currentStage": {
        "stageStatus": "Succeeded",
        "stageName": "Placed",
        "startTime": "2022-03-04T11:30:31.5838042+05:30"
      },
      "orderItemStageHistory": [
        {
          "stageStatus": "Succeeded",
          "stageName": "Placed",
          "startTime": "2022-03-04T11:30:31.5838042+05:30"
        },
        {
          "stageStatus": "None",
          "stageName": "Confirmed"
        },
        {
          "stageStatus": "None",
          "stageName": "ReadyToShip"
        },
        {
          "stageStatus": "None",
          "stageName": "Shipped"
        },
        {
          "stageStatus": "None",
          "stageName": "Delivered"
        },
        {
          "stageStatus": "None",
          "stageName": "InUse"
        }
      ],
      "preferences": {
        "transportPreferences": {
          "preferredShipmentType": "CustomerManaged"
        }
      },
      "notificationEmailList": [],
      "cancellationStatus": "Cancellable",
      "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-04T11:29:47.3483197+05:30",
    "orderId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName3"
  },
  "systemData": {
    "createdAt": "0001-01-01T05:30:00+05:30",
    "lastModifiedAt": "0001-01-01T05:30:00+05:30"
  },
  "location": "eastus",
  "tags": {},
  "name": "TestOrderItemName3",
  "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3",
  "type": "Microsoft.EdgeOrder/orderItems"
}

状态代码:: 202

定义

名称	说明
ActionStatusEnum	描述订单项是否可取消删除。
AddressDetails	订单项的地址详细信息。
AddressProperties	地址属性
AddressType	地址类型。
AddressValidationStatus	地址验证的状态
ContactDetails	联系人详细信息。
createdByType	创建资源的标识的类型。
DeviceDetails	设备详细信息。
DisplayInfo	描述产品显示信息
DoubleEncryptionStatus	客户输入的双重加密状态。如果配置了“拒绝”或“禁用”策略，则强制为此参数提供此参数。
EncryptionPreferences	与双重加密相关的首选项
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ForwardShippingDetails	转发发货详细信息。
HierarchyInformation	保存有关产品层次结构信息的详细信息
ManagementResourcePreferences	用于链接设备的管理资源首选项
NotificationPreference	作业阶段的通知首选项。
NotificationStageName	阶段的名称。
OrderItemCancellationEnum	描述订单项是否可取消。
OrderItemDetails	订单项详细信息
OrderItemResource	表示订单项协定
OrderItemReturnEnum	描述订单项是否可返回。
OrderItemType	订单项类型。
OrderItemUpdateParameter	更新订单项参数。
Preferences	与订单相关的首选项
ProductDetails	表示产品详细信息
ResourceProviderDetails	管理 RP 详细信息
ReverseShippingDetails	反向发货详细信息。
ShippingAddress	客户希望接收设备的寄送地址。
StageDetails	资源阶段详细信息。
StageName	艺名
StageStatus	阶段状态。
systemData	与创建和上次修改资源相关的元数据。
TransportPreferences	与 SKU 的发货物流相关的首选项
TransportShipmentTypes	指示客户首选的发货物流类型。

ActionStatusEnum

枚举

描述订单项是否可取消删除。

值	说明
Allowed	允许的标志。
NotAllowed	不允许的标志。

AddressDetails

Object

订单项的地址详细信息。

名称	类型	说明
forwardAddress	AddressProperties	客户地址和联系人详细信息。它应该是地址资源
returnAddress	AddressProperties	寄件地址

AddressProperties

Object

地址属性

名称	类型	说明
addressValidationStatus	AddressValidationStatus	地址验证的状态
contactDetails	ContactDetails	地址的联系人详细信息
shippingAddress	ShippingAddress	地址的寄送详细信息

AddressType

枚举

地址类型。

值	说明
None	地址类型未知。
Residential	住宅地址。
Commercial	商业地址。

AddressValidationStatus

枚举

地址验证的状态

值	说明
Valid	提供的地址有效。
Invalid	提供的地址无效或不受支持。
Ambiguous	提供的地址不明确，请选择返回的备用地址之一。

ContactDetails

Object

联系人详细信息。

名称	类型	说明
contactName	string	联系人的联系人姓名。
emailList	string[]	要通知有关作业进度的电子邮件 ID 的列表。
mobile	string	联系人的手机号码。
phone	string	联系人的电话号码。
phoneExtension	string	联系人的电话号码。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DeviceDetails

Object

设备详细信息。

名称	类型	说明
managementResourceId	string	管理资源 ID
managementResourceTenantId	string	管理资源租户 ID
serialNumber	string	设备序列号

DisplayInfo

Object

描述产品显示信息

名称	类型	说明
configurationDisplayName	string	配置显示名称
productFamilyDisplayName	string	产品系列显示名称

DoubleEncryptionStatus

枚举

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

值	说明
Disabled	禁用双重加密
Enabled	启用了双重加密

EncryptionPreferences

Object

与双重加密相关的首选项

名称	类型	说明
doubleEncryptionStatus	DoubleEncryptionStatus	客户输入的双重加密状态。如果配置了“拒绝”或“禁用”策略，则强制为此参数提供此参数。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ForwardShippingDetails

Object

转发发货详细信息。

名称	类型	说明
carrierDisplayName	string	用于显示目的的运营商名称。不用于任何处理。
carrierName	string	运营商的名称。
trackingId	string	包的 TrackingId
trackingUrl	string	包的 TrackingUrl。

HierarchyInformation

Object

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

名称	类型	说明
configurationName	string	表示唯一标识配置的配置名称
productFamilyName	string	表示唯一标识产品系列的产品名称
productLineName	string	表示唯一标识生产线的产品名称
productName	string	表示唯一标识产品的产品名称

ManagementResourcePreferences

Object

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

名称	类型	说明
preferredManagementResourceId	string	客户首选管理资源 ARM ID

NotificationPreference

Object

作业阶段的通知首选项。

名称	类型	说明
sendNotification	boolean	需要通知。
stageName	NotificationStageName	阶段的名称。

NotificationStageName

枚举

阶段的名称。

值	说明
Shipped	从 Microsoft 数据中心发货的订单项通知。
Delivered	发送到客户的订单项通知。

OrderItemCancellationEnum

枚举

描述订单项是否可取消。

值	说明
Cancellable	可以不收取费用取消订单项目。
CancellableWithFee	订单项目可以按费用取消。
NotCancellable	订单项不可取消。

OrderItemDetails

Object

订单项详细信息

名称	类型	说明
cancellationReason	string	取消原因。
cancellationStatus	OrderItemCancellationEnum	描述订单项是否可取消。
currentStage	StageDetails	当前订单项状态
deletionStatus	ActionStatusEnum	描述订单项是否可取消删除。
error	ErrorDetail	作业的顶级错误。
forwardShippingDetails	ForwardShippingDetails	转发包裹寄送详细信息
managementRpDetails	ResourceProviderDetails	父 RP 详细信息 - 仅返回整个列表中的第一个或默认父 RP
managementRpDetailsList	ResourceProviderDetails[]	配置支持的父 RP 详细信息列表。
notificationEmailList	string[]	其他通知电子邮件列表
orderItemStageHistory	StageDetails[]	订单项状态历史记录
orderItemType	OrderItemType	订单项类型。
preferences	Preferences	客户通知首选项
productDetails	ProductDetails	配置的唯一标识符。
returnReason	string	返回原因。
returnStatus	OrderItemReturnEnum	描述订单项是否可返回。
reverseShippingDetails	ReverseShippingDetails	反向包裹寄送详细信息

OrderItemResource

Object

表示订单项协定

名称	类型	说明
id	string	资源的完全限定资源 ID。示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	资源所在的地理位置
name	string	资源的名称
properties.addressDetails	AddressDetails	表示订单项的发货和退货地址
properties.orderId	string	订单项所属顺序的 ID
properties.orderItemDetails	OrderItemDetails	表示订单项详细信息。
properties.startTime	string (date-time)	订单项的开始时间
systemData	systemData	表示资源创建和更新时间
tags	object	资源标记。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

OrderItemReturnEnum

枚举

描述订单项是否可返回。

值	说明
Returnable	可以不收取费用返回订单项目。
ReturnableWithFee	订单项目可以按费用返回。
NotReturnable	订单项不可返回。

OrderItemType

枚举

订单项类型。

值	说明
Purchase	Purchase OrderItem。
Rental	Rental OrderItem。

OrderItemUpdateParameter

Object

更新订单项参数。

名称	类型	说明
properties.forwardAddress	AddressProperties	更新转发寄送地址和联系人详细信息。
properties.notificationEmailList	string[]	其他通知电子邮件列表。
properties.preferences	Preferences	客户首选项。
tags	object	描述资源的键值对的列表。这些标记可用于查看和分组此资源（跨资源组）。

Preferences

Object

与订单相关的首选项

名称	类型	说明
encryptionPreferences	EncryptionPreferences	与加密相关的首选项。
managementResourcePreferences	ManagementResourcePreferences	与管理资源相关的首选项。
notificationPreferences	NotificationPreference[]	通知首选项。
transportPreferences	TransportPreferences	与订单的发货物流相关的首选项。

ProductDetails

Object

表示产品详细信息

名称	类型	说明
count	integer (int32)	产品数量
deviceDetails	DeviceDetails[]	设备详细信息列表
displayInfo	DisplayInfo	显示产品的详细信息
hierarchyInformation	HierarchyInformation	唯一标识产品的产品的层次结构
productDoubleEncryptionStatus	DoubleEncryptionStatus	配置的双重加密状态。只读字段。

ResourceProviderDetails

Object

管理 RP 详细信息

名称	类型	说明
resourceProviderNamespace	string	资源提供程序命名空间

ReverseShippingDetails

Object

反向发货详细信息。

名称	类型	说明
carrierDisplayName	string	用于显示目的的运营商名称。不用于任何处理。
carrierName	string	运营商的名称。
sasKeyForLabel	string	用于下载包裹的反向发货标签的 SAS 密钥。
trackingId	string	包的 TrackingId
trackingUrl	string	包的 TrackingUrl。

ShippingAddress

Object

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

名称	类型	说明
addressType	AddressType	地址类型。
city	string	City 的名称。
companyName	string	公司的名称。
country	string	国家/地区的名称。
postalCode	string	邮政编码。
stateOrProvince	string	州或省的名称。
streetAddress1	string	街道地址行 1。
streetAddress2	string	街道地址行 2。
streetAddress3	string	街道地址行 3。
zipExtendedCode	string	扩展的邮政编码。

StageDetails

Object

资源阶段详细信息。

名称	类型	说明
displayName	string	资源阶段的显示名称。
stageName	StageName	艺名
stageStatus	StageStatus	阶段状态。
startTime	string (date-time)	阶段开始时间

StageName

枚举

艺名

值	说明
Placed	当前处于草稿模式，仍可取消
InReview	订单当前处于草稿模式，仍可取消
Confirmed	订单已确认
ReadyToShip	订单已准备好发货
Shipped	订单正在传输到客户
Delivered	订单将交付给客户
InUse	订单在客户站点使用
ReturnInitiated	返回已由客户启动。
ReturnPickedUp	订单从客户传输到 Microsoft。
ReturnedToMicrosoft	订单已收到回 Microsoft。
ReturnCompleted	返回现已完成。
Cancelled	订单已取消。

StageStatus

枚举

阶段状态。

值	说明
None	目前没有可用状态。
InProgress	阶段正在进行中。
Succeeded	阶段已成功。
Failed	阶段失败。
Cancelled	阶段已取消。
Cancelling	阶段正在取消。

systemData

Object

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

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

TransportPreferences

Object

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

名称	类型	说明
preferredShipmentType	TransportShipmentTypes	指示客户首选的发货物流类型。

TransportShipmentTypes

枚举

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

值	说明
CustomerManaged	货物物流由客户处理。
MicrosoftManaged	运输物流由Microsoft处理。

通过

Update Order Item - Update Order Item

URI 参数

请求头

请求正文

响应

安全性

azure_auth

作用域

示例

UpdateOrderItem

示例请求

示例响应

定义

ActionStatusEnum

AddressDetails

AddressProperties

AddressType

AddressValidationStatus

ContactDetails

createdByType

DeviceDetails

DisplayInfo

DoubleEncryptionStatus

EncryptionPreferences

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ForwardShippingDetails

HierarchyInformation

ManagementResourcePreferences

NotificationPreference

NotificationStageName

OrderItemCancellationEnum

OrderItemDetails

OrderItemResource

OrderItemReturnEnum

OrderItemType

OrderItemUpdateParameter

Preferences

ProductDetails

ResourceProviderDetails

ReverseShippingDetails

ShippingAddress

StageDetails

StageName

StageStatus

systemData

TransportPreferences

TransportShipmentTypes