Update Order Item - Update Order Item

Servicio:: Edge Hardware Center

Versión de la API:: 2021-12-01

Actualiza las propiedades de un elemento de pedido existente.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
orderItemName	path	True	string	Nombre del elemento de pedido
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
If-Match		string	Define la condición If-Match. La revisión solo se realizará si el ETag del pedido en el servidor coincide con este valor.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.forwardAddress	AddressProperties	Actualiza la dirección de envío de reenvío y los detalles de contacto.
properties.notificationEmailList	string[]	Lista de correo electrónico de notificación adicional.
properties.preferences	Preferences	Preferencia del cliente.
tags	object	Lista de pares clave-valor que describen el recurso. Estas etiquetas se pueden usar para ver y agrupar este recurso (entre grupos de recursos).

Respuestas

Nombre	Tipo	Description
200 OK	OrderItemResource	Objeto de recurso order item.
202 Accepted		Solicitud aceptada para la actualización del elemento de pedido.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

UpdateOrderItem

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
}

status code:: 202

Definiciones

Nombre	Description
ActionStatusEnum	Describe si el elemento de pedido es deletable o no.
AddressDetails	Detalles de la dirección de un elemento de pedido.
AddressProperties	Propiedades de dirección
AddressType	Tipo de dirección.
AddressValidationStatus	Estado de la validación de direcciones
ContactDetails	Detalles de contacto.
createdByType	Tipo de identidad que creó el recurso.
DeviceDetails	Detalles del dispositivo.
DisplayInfo	Describe la información de presentación del producto.
DoubleEncryptionStatus	Estado de cifrado doble especificado por el cliente. Es obligatorio proporcionar este parámetro si se configura la directiva "Denegar" o "Deshabilitada".
EncryptionPreferences	Preferencias relacionadas con el cifrado doble
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ForwardShippingDetails	Detalles del envío de reenvío.
HierarchyInformation	Contiene detalles sobre la información de la jerarquía de productos
ManagementResourcePreferences	Preferencia de recursos de administración para vincular el dispositivo
NotificationPreference	Preferencia de notificación para una fase de trabajo.
NotificationStageName	Nombre de la fase.
OrderItemCancellationEnum	Describe si el elemento de pedido se puede cancelar o no.
OrderItemDetails	Detalles del elemento de pedido
OrderItemResource	Representa el contrato de elemento de pedido
OrderItemReturnEnum	Describe si el elemento de pedido se puede devolver o no.
OrderItemType	Tipo de elemento de pedido.
OrderItemUpdateParameter	Actualiza los parámetros del elemento de pedido.
Preferences	Preferencias relacionadas con el pedido
ProductDetails	Representa los detalles del producto.
ResourceProviderDetails	Detalles de RP de administración
ReverseShippingDetails	Detalles del envío inverso.
ShippingAddress	Dirección de envío donde el cliente desea recibir el dispositivo.
StageDetails	Detalles de la fase de recursos.
StageName	Nombre de la fase
StageStatus	Estado de la fase.
systemData	Metadatos relativos a la creación y última modificación del recurso.
TransportPreferences	Preferencias relacionadas con la logística de envío de la SKU
TransportShipmentTypes	Indica el tipo de logística de envío que el cliente prefiere.

ActionStatusEnum

Enumeración

Describe si el elemento de pedido es deletable o no.

Valor	Description
Allowed	Marca permitida.
NotAllowed	Marca No permitida.

AddressDetails

Object

Detalles de la dirección de un elemento de pedido.

Nombre	Tipo	Description
forwardAddress	AddressProperties	Dirección del cliente y detalles de contacto. Debe ser el recurso de dirección.
returnAddress	AddressProperties	Dirección de envío de devolución

AddressProperties

Object

Propiedades de dirección

Nombre	Tipo	Description
addressValidationStatus	AddressValidationStatus	Estado de la validación de direcciones
contactDetails	ContactDetails	Detalles de contacto de la dirección
shippingAddress	ShippingAddress	Detalles del envío de la dirección

AddressType

Enumeración

Tipo de dirección.

Valor	Description
None	Tipo de dirección no conocido.
Residential	Dirección residencial.
Commercial	Dirección comercial.

AddressValidationStatus

Enumeración

Estado de la validación de direcciones

Valor	Description
Valid	La dirección proporcionada es válida.
Invalid	La dirección proporcionada no es válida o no es compatible.
Ambiguous	La dirección proporcionada es ambigua, elija una de las direcciones alternativas devueltas.

ContactDetails

Object

Detalles de contacto.

Nombre	Tipo	Description
contactName	string	Nombre de contacto de la persona.
emailList	string[]	Lista de identificadores de correo electrónico que se van a notificar sobre el progreso del trabajo.
mobile	string	Número móvil de la persona de contacto.
phone	string	Número de teléfono de la persona de contacto.
phoneExtension	string	Número de extensión de teléfono de la persona de contacto.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DeviceDetails

Object

Detalles del dispositivo.

Nombre	Tipo	Description
managementResourceId	string	Identificador de recurso de administración
managementResourceTenantId	string	Identificador de inquilino del recurso de administración
serialNumber	string	número de serie del dispositivo

DisplayInfo

Object

Describe la información de presentación del producto.

Nombre	Tipo	Description
configurationDisplayName	string	Nombre para mostrar de configuración
productFamilyDisplayName	string	Nombre para mostrar de la familia de productos

DoubleEncryptionStatus

Enumeración

Estado de cifrado doble especificado por el cliente. Es obligatorio proporcionar este parámetro si se configura la directiva "Denegar" o "Deshabilitada".

Valor	Description
Disabled	El cifrado doble está deshabilitado
Enabled	El cifrado doble está habilitado

EncryptionPreferences

Object

Preferencias relacionadas con el cifrado doble

Nombre	Tipo	Description
doubleEncryptionStatus	DoubleEncryptionStatus	Estado de cifrado doble especificado por el cliente. Es obligatorio proporcionar este parámetro si se configura la directiva "Denegar" o "Deshabilitada".

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ForwardShippingDetails

Object

Detalles del envío de reenvío.

Nombre	Tipo	Description
carrierDisplayName	string	Nombre de operador para mostrar. No se usará para ningún procesamiento.
carrierName	string	Nombre del transportista.
trackingId	string	TrackingId del paquete
trackingUrl	string	TrackingUrl del paquete.

HierarchyInformation

Object

Contiene detalles sobre la información de la jerarquía de productos

Nombre	Tipo	Description
configurationName	string	Representa el nombre de configuración que identifica de forma única la configuración.
productFamilyName	string	Representa el nombre de familia de productos que identifica de forma única la familia de productos.
productLineName	string	Representa el nombre de línea de producto que identifica de forma única la línea de producto.
productName	string	Representa el nombre del producto que identifica de forma única el producto.

ManagementResourcePreferences

Object

Preferencia de recursos de administración para vincular el dispositivo

Nombre	Tipo	Description
preferredManagementResourceId	string	Identificador de ARM del recurso de administración preferido del cliente

NotificationPreference

Object

Preferencia de notificación para una fase de trabajo.

Nombre	Tipo	Description
sendNotification	boolean	La notificación es necesaria o no.
stageName	NotificationStageName	Nombre de la fase.

NotificationStageName

Enumeración

Nombre de la fase.

Valor	Description
Shipped	Notificación en el artículo de pedido enviado desde el centro de datos de Microsoft.
Delivered	Notificación en el artículo de pedido entregado al cliente.

OrderItemCancellationEnum

Enumeración

Describe si el elemento de pedido se puede cancelar o no.

Valor	Description
Cancellable	El artículo del pedido se puede cancelar sin cargo.
CancellableWithFee	El artículo de pedido se puede cancelar con cargo.
NotCancellable	No se puede cancelar el elemento de pedido.

OrderItemDetails

Object

Detalles del elemento de pedido

Nombre	Tipo	Description
cancellationReason	string	Motivo de cancelación.
cancellationStatus	OrderItemCancellationEnum	Describe si el elemento de pedido se puede cancelar o no.
currentStage	StageDetails	Estado actual del elemento de pedido
deletionStatus	ActionStatusEnum	Describe si el elemento de pedido es deletable o no.
error	ErrorDetail	Error de nivel superior para el trabajo.
forwardShippingDetails	ForwardShippingDetails	Reenvío de los detalles del envío de paquetes
managementRpDetails	ResourceProviderDetails	Detalles de RP primarios: devuelve solo el primer o el rp primario predeterminado de toda la lista.
managementRpDetailsList	ResourceProviderDetails[]	Lista de detalles de RP primarios admitidos para la configuración.
notificationEmailList	string[]	Lista de correo electrónico de notificación adicional
orderItemStageHistory	StageDetails[]	Historial de estado del elemento de pedido
orderItemType	OrderItemType	Tipo de elemento de pedido.
preferences	Preferences	Preferencias de notificación del cliente
productDetails	ProductDetails	Identificador único para la configuración.
returnReason	string	Motivo de devolución.
returnStatus	OrderItemReturnEnum	Describe si el elemento de pedido se puede devolver o no.
reverseShippingDetails	ReverseShippingDetails	Detalles de envío de paquetes inversos

OrderItemResource

Object

Representa el contrato de elemento de pedido

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.addressDetails	AddressDetails	Representa la dirección de envío y devolución del artículo de pedido.
properties.orderId	string	Identificador del orden al que pertenece el elemento de pedido
properties.orderItemDetails	OrderItemDetails	Representa los detalles del elemento de pedido.
properties.startTime	string (date-time)	Hora de inicio del elemento de pedido
systemData	systemData	Representa la hora de creación y actualización de los recursos.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

OrderItemReturnEnum

Enumeración

Describe si el elemento de pedido se puede devolver o no.

Valor	Description
Returnable	El artículo de pedido se puede devolver sin cargo.
ReturnableWithFee	El artículo de pedido se puede devolver con cargo.
NotReturnable	No se puede devolver el elemento de pedido.

OrderItemType

Enumeración

Tipo de elemento de pedido.

Valor	Description
Purchase	Comprar OrderItem.
Rental	OrderItem de alquiler.

OrderItemUpdateParameter

Object

Actualiza los parámetros del elemento de pedido.

Nombre	Tipo	Description
properties.forwardAddress	AddressProperties	Actualiza la dirección de envío de reenvío y los detalles de contacto.
properties.notificationEmailList	string[]	Lista de correo electrónico de notificación adicional.
properties.preferences	Preferences	Preferencia del cliente.
tags	object	Lista de pares clave-valor que describen el recurso. Estas etiquetas se pueden usar para ver y agrupar este recurso (entre grupos de recursos).

Preferences

Object

Preferencias relacionadas con el pedido

Nombre	Tipo	Description
encryptionPreferences	EncryptionPreferences	Preferencias relacionadas con el cifrado.
managementResourcePreferences	ManagementResourcePreferences	Preferencias relacionadas con el recurso de administración.
notificationPreferences	NotificationPreference[]	Preferencias de notificación.
transportPreferences	TransportPreferences	Preferencias relacionadas con la logística de envío del pedido.

ProductDetails

Object

Representa los detalles del producto.

Nombre	Tipo	Description
count	integer (int32)	Cantidad del producto
deviceDetails	DeviceDetails[]	lista de detalles del dispositivo
displayInfo	DisplayInfo	Mostrar detalles del producto
hierarchyInformation	HierarchyInformation	Jerarquía del producto que identifica de forma única el producto
productDoubleEncryptionStatus	DoubleEncryptionStatus	Estado de cifrado doble de la configuración. Campo de solo lectura.

ResourceProviderDetails

Object

Detalles de RP de administración

Nombre	Tipo	Description
resourceProviderNamespace	string	Espacio de nombres del proveedor de recursos

ReverseShippingDetails

Object

Detalles del envío inverso.

Nombre	Tipo	Description
carrierDisplayName	string	Nombre de operador para mostrar. No se usará para ningún procesamiento.
carrierName	string	Nombre del transportista.
sasKeyForLabel	string	Clave SAS para descargar la etiqueta de envío inverso del paquete.
trackingId	string	TrackingId del paquete
trackingUrl	string	TrackingUrl del paquete.

ShippingAddress

Object

Dirección de envío donde el cliente desea recibir el dispositivo.

Nombre	Tipo	Description
addressType	AddressType	Tipo de dirección.
city	string	Nombre de la ciudad.
companyName	string	Nombre de la empresa.
country	string	Nombre del país.
postalCode	string	Código postal.
stateOrProvince	string	Nombre del Estado o provincia.
streetAddress1	string	Línea de dirección postal 1.
streetAddress2	string	Línea de dirección postal 2.
streetAddress3	string	Línea 3 de dirección postal.
zipExtendedCode	string	Código postal extendido.

StageDetails

Object

Detalles de la fase de recursos.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la fase de recursos.
stageName	StageName	Nombre de la fase
stageStatus	StageStatus	Estado de la fase.
startTime	string (date-time)	Hora de inicio de la fase

StageName

Enumeración

Nombre de la fase

Valor	Description
Placed	Actualmente en modo borrador y todavía se puede cancelar
InReview	El pedido está actualmente en modo borrador y todavía se puede cancelar.
Confirmed	Se confirma el pedido
ReadyToShip	El pedido está listo para enviarse
Shipped	El pedido está en tránsito al cliente
Delivered	El pedido se entrega al cliente
InUse	El pedido está en uso en el sitio del cliente
ReturnInitiated	El cliente ha iniciado la devolución.
ReturnPickedUp	El pedido está en tránsito desde el cliente a Microsoft.
ReturnedToMicrosoft	El pedido se ha recibido de vuelta a Microsoft.
ReturnCompleted	La devolución ya se ha completado.
Cancelled	Se ha cancelado el pedido.

StageStatus

Enumeración

Estado de la fase.

Valor	Description
None	Todavía no hay ningún estado disponible.
InProgress	La fase está en curso.
Succeeded	La fase se ha realizado correctamente.
Failed	Error en la fase.
Cancelled	Se ha cancelado la fase.
Cancelling	La fase se está cancelando.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TransportPreferences

Object

Preferencias relacionadas con la logística de envío de la SKU

Nombre	Tipo	Description
preferredShipmentType	TransportShipmentTypes	Indica el tipo de logística de envío que el cliente prefiere.

TransportShipmentTypes

Enumeración

Indica el tipo de logística de envío que el cliente prefiere.

Valor	Description
CustomerManaged	El cliente controla la logística de envío.
MicrosoftManaged	La logística de envío se encarga de Microsoft.

Compartir a través de

Update Order Item - Update Order Item

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

UpdateOrderItem

Solicitud de ejemplo

Respuesta de muestra

Definiciones

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