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	Идентификатор целевой подписки.
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

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: 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[]	Список идентификаторов электронной почты для уведомления о ходе выполнения задания.
mobile	string	Номер мобильного телефона контактного лица.
phone	string	Номер телефона контактного лица.
phoneExtension	string	Номер расширения телефона контактного лица.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DeviceDetails

Object

Сведения об устройстве.

Имя	Тип	Описание
managementResourceId	string	Идентификатор ресурса управления
managementResourceTenantId	string	Идентификатор клиента ресурса управления
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	Предпочтительный идентификатор ресурса управления клиентом

NotificationPreference

Object

Предпочтения уведомления для этапа задания.

Имя	Тип	Описание
sendNotification	boolean	Уведомление является обязательным или нет.
stageName	NotificationStageName	Имя этапа.

NotificationStageName

Перечисление

Имя этапа.

Значение	Описание
Shipped	Уведомление по элементу заказа, отправленное из центра обработки данных Майкрософт.
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	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.addressDetails	AddressDetails	Представляет адрес доставки и возврата для элемента заказа
properties.orderId	string	Идентификатор заказа, к которому принадлежит элемент заказа
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	Заказ на покупку.
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	Имя города.
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	Заказ передается от клиента в корпорацию Майкрософт.
ReturnedToMicrosoft	Заказ был получен обратно в корпорацию Майкрософт.
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	Логистика доставки обрабатывается корпорацией Майкрософт.

Поделиться через

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