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

Order Items - Update

更新现有订单项的属性。

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

URI 参数

Name In Required Type Description
orderItemName
path True
  • string

订单项的名称。

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

请求头

Name Required Type Description
If-Match
  • string

定义If-Match条件。 仅当服务器上的订单的 ETag 与此值匹配时,才会执行修补程序。

请求正文

Name Type Description
properties.forwardAddress

汇报转发寄送地址和联系人详细信息。

properties.notificationEmailList
  • string[]

其他通知电子邮件列表。

properties.preferences

客户首选项。

tags
  • object

描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。

响应

Name Type Description
200 OK

订单项资源对象。

202 Accepted

已接受订单项更新请求。

Other Status Codes

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

UpdateOrderItem

Sample Request

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

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

Sample Response

{
  "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": "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"
}

定义

ActionStatusEnum

描述订单项是否可取消。

AdditionalConfiguration

其他配置详细信息。

AddressDetails

订单项的地址详细信息。

AddressProperties

地址属性。

AddressType

地址类型。

AddressValidationStatus

地址验证的状态。

ConfigurationDeviceDetails

配置的设备详细信息。

ContactDetails

联系人详细信息。

createdByType

创建资源的标识的类型。

DeviceDetails

设备详细信息。

DisplayInfo

描述产品显示信息。

DoubleEncryptionStatus

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

EncryptionPreferences

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

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ForwardShippingDetails

转发发货详细信息。

HierarchyInformation

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

IdentificationType

配置的标识类型。

ManagementResourcePreferences

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

NotificationPreference

作业阶段的通知首选项。

NotificationStageName

阶段的名称。

OrderItemCancellationEnum

描述订单项是否可取消。

OrderItemDetails

订单项详细信息。

OrderItemResource

表示订单项资源。

OrderItemReturnEnum

描述订单项是否可返回。

OrderItemType

订单项类型。

OrderItemUpdateParameter

汇报订单项参数。

OrderMode

定义 Order 项的模式。

Preferences

与订单相关的首选项。

ProductDetails

表示产品详细信息。

ResourceProviderDetails

管理 RP 详细信息。

ReverseShippingDetails

反向发货详细信息。

ShippingAddress

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

StageDetails

资源阶段详细信息。

StageName

阶段名称。

StageStatus

阶段状态。

systemData

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

TransportPreferences

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

TransportShipmentTypes

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

ActionStatusEnum

描述订单项是否可取消。

Name Type Description
Allowed
  • string

允许的标志。

NotAllowed
  • string

不允许的标志。

AdditionalConfiguration

其他配置详细信息。

Name Type Description
hierarchyInformation

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

quantity
  • integer

产品的数量。

AddressDetails

订单项的地址详细信息。

Name Type Description
forwardAddress

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

returnAddress

寄件地址。

AddressProperties

地址属性。

Name Type Description
addressValidationStatus

地址验证的状态。

contactDetails

地址的联系人详细信息。

shippingAddress

地址的寄送详细信息。

AddressType

地址类型。

Name Type Description
Commercial
  • string

商业地址。

None
  • string

地址类型未知。

Residential
  • string

住宅地址。

AddressValidationStatus

地址验证的状态。

Name Type Description
Ambiguous
  • string

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

Invalid
  • string

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

Valid
  • string

提供的地址有效。

ConfigurationDeviceDetails

配置的设备详细信息。

Name Type Description
deviceDetails

设备详细信息列表。

displayInfo

显示产品的详细信息。

hierarchyInformation

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

identificationType

配置的标识类型。

quantity
  • integer

产品的数量。

ContactDetails

联系人详细信息。

Name Type Description
contactName
  • string

联系人姓名。

emailList
  • string[]

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

mobile
  • string

联系人的电话号码。

phone
  • string

联系人的电话号码。

phoneExtension
  • string

联系人的电话号码。

createdByType

创建资源的标识的类型。

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

DeviceDetails

设备详细信息。

Name Type Description
managementResourceId
  • string

管理资源 ID。

managementResourceTenantId
  • string

管理资源租户 ID。

serialNumber
  • string

设备序列号。

DisplayInfo

描述产品显示信息。

Name Type Description
configurationDisplayName
  • string

配置显示名称。

productFamilyDisplayName
  • string

产品系列显示名称。

DoubleEncryptionStatus

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

Name Type Description
Disabled
  • string

禁用双重加密。

Enabled
  • string

启用了双重加密。

EncryptionPreferences

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

Name Type Description
doubleEncryptionStatus

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

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

错误对象。

ForwardShippingDetails

转发发货详细信息。

Name Type Description
carrierDisplayName
  • string

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

carrierName
  • string

运营商的名称。

trackingId
  • string

包的 TrackingId。

trackingUrl
  • string

包的 TrackingUrl。

HierarchyInformation

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

Name Type Description
configurationName
  • string

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

productFamilyName
  • string

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

productLineName
  • string

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

productName
  • string

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

IdentificationType

配置的标识类型。

Name Type Description
NotSupported
  • string

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

SerialNumber
  • string

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

ManagementResourcePreferences

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

Name Type Description
preferredManagementResourceId
  • string

客户首选的管理资源 ARM ID。

NotificationPreference

作业阶段的通知首选项。

Name Type Description
sendNotification
  • boolean

需要通知。

stageName

阶段的名称。

NotificationStageName

阶段的名称。

Name Type Description
Delivered
  • string

发送到客户的订单项通知。

Shipped
  • string

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

OrderItemCancellationEnum

描述订单项是否可取消。

Name Type Description
Cancellable
  • string

无需费用即可取消订单项目。

CancellableWithFee
  • string

订单项目可以按费用取消。

NotCancellable
  • string

订单项不可取消。

OrderItemDetails

订单项详细信息。

Name Type Description
cancellationReason
  • string

取消原因。

cancellationStatus

描述订单项是否可取消。

currentStage

当前订单项状态。

deletionStatus

描述订单项是否可取消。

error

作业的顶级错误。

forwardShippingDetails

转发包裹寄送详细信息。

managementRpDetailsList

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

notificationEmailList
  • string[]

其他通知电子邮件列表。

orderItemMode

定义 Order 项的模式。

orderItemStageHistory

订单项状态历史记录。

orderItemType

订单项类型。

preferences

客户通知首选项。

productDetails

配置的唯一标识符。

returnReason
  • string

返回原因。

returnStatus

描述订单项是否可返回。

reverseShippingDetails

反向包裹寄送详细信息。

OrderItemResource

表示订单项资源。

Name Type Description
id
  • string

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

location
  • string

资源所在的地理位置

name
  • string

资源的名称

properties.addressDetails

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

properties.orderId
  • string

订单项所属的顺序的 ID。

properties.orderItemDetails

表示订单项详细信息。

properties.startTime
  • string

订单项的开始时间。

systemData

表示资源创建和更新时间。

tags
  • object

资源标记。

type
  • string

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

OrderItemReturnEnum

描述订单项是否可返回。

Name Type Description
NotReturnable
  • string

订单项不可返回。

Returnable
  • string

无需费用即可返回订单项目。

ReturnableWithFee
  • string

可以按费用返回订单项目。

OrderItemType

订单项类型。

Name Type Description
Purchase
  • string

Purchase OrderItem。

Rental
  • string

Rental OrderItem。

OrderItemUpdateParameter

汇报订单项参数。

Name Type Description
properties.forwardAddress

汇报转发寄送地址和联系人详细信息。

properties.notificationEmailList
  • string[]

其他通知电子邮件列表。

properties.preferences

客户首选项。

tags
  • object

描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。

OrderMode

定义 Order 项的模式。

Name Type Description
Default
  • string

默认顺序模式。

DoNotFulfill
  • string

订单将不履行的模式。

Preferences

与订单相关的首选项。

Name Type Description
encryptionPreferences

与加密相关的首选项。

managementResourcePreferences

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

notificationPreferences

通知首选项。

transportPreferences

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

ProductDetails

表示产品详细信息。

Name Type Description
childConfigurationDeviceDetails

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

displayInfo

显示产品的详细信息。

hierarchyInformation

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

identificationType

配置的标识类型。

optInAdditionalConfigurations

除了基本配置中包含的配置之外,客户希望在订单项中使用其他配置的列表。

parentDeviceDetails

父配置的设备详细信息。

productDoubleEncryptionStatus

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

ResourceProviderDetails

管理 RP 详细信息。

Name Type Description
resourceProviderNamespace
  • string

资源提供程序命名空间。

ReverseShippingDetails

反向发货详细信息。

Name Type Description
carrierDisplayName
  • string

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

carrierName
  • string

运营商的名称。

sasKeyForLabel
  • string

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

trackingId
  • string

包的 TrackingId。

trackingUrl
  • string

包的 TrackingUrl。

ShippingAddress

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

Name Type Description
addressType

地址类型。

city
  • string

City 的名称。

companyName
  • string

公司的名称。

country
  • string

国家/地区的名称。

postalCode
  • string

邮政编码。

stateOrProvince
  • string

州或省的名称。

streetAddress1
  • string

街道地址行 1.

streetAddress2
  • string

街道地址行 2.

streetAddress3
  • string

街道地址行 3.

zipExtendedCode
  • string

扩展邮政编码。

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

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

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

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

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

TransportPreferences

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

Name Type Description
preferredShipmentType

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

TransportShipmentTypes

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

Name Type Description
CustomerManaged
  • string

发货物流由客户处理。

MicrosoftManaged
  • string

发货物流由 Microsoft 处理。