Update Order Item - Update Order Item

Serviço:: Edge Hardware Center

Versão da API:: 2021-12-01

Atualiza as propriedades de um item de pedido existente.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
orderItemName	path	True	string	O nome do item de ordem
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-Match		string	Define a condição If-Match. O patch será executado somente se o ETag da ordem no servidor corresponder a esse valor.

Corpo do Pedido

Name	Tipo	Description
properties.forwardAddress	AddressProperties	Atualiza o endereço de envio e os detalhes de contato.
properties.notificationEmailList	string[]	Lista de e-mail de notificação adicional.
properties.preferences	Preferences	Preferência do cliente.
tags	object	A lista de pares de valores de chave que descrevem o recurso. Essas tags podem ser usadas para visualizar e agrupar esse recurso (entre grupos de recursos).

Respostas

Name	Tipo	Description
200 OK	OrderItemResource	Objeto de recurso do item de ordem.
202 Accepted		Pedido aceito de atualização de item de ordem.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo o motivo da falha na operação.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

UpdateOrderItem

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
}

Código de estado:: 202

Definições

Name	Description
ActionStatusEnum	Descreve se o item de ordem é excluível ou não.
AddressDetails	Detalhes do endereço de um item de pedido.
AddressProperties	Propriedades do endereço
AddressType	Tipo de endereço.
AddressValidationStatus	Status da validação do endereço
ContactDetails	Detalhes de contacto.
createdByType	O tipo de identidade que criou o recurso.
DeviceDetails	Detalhes do dispositivo.
DisplayInfo	Descreve as informações de exibição do produto
DoubleEncryptionStatus	Status de criptografia dupla conforme inserido pelo cliente. É obrigatório fornecer este parâmetro se a política 'Negar' ou 'Desativado' estiver configurada.
EncryptionPreferences	Preferências relacionadas com a dupla encriptação
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ForwardShippingDetails	Encaminhar detalhes da remessa.
HierarchyInformation	Contém detalhes sobre informações de hierarquia de produtos
ManagementResourcePreferences	Preferência de recurso de gerenciamento para vincular dispositivo
NotificationPreference	Preferência de notificação para um estágio de trabalho.
NotificationStageName	Nome do palco.
OrderItemCancellationEnum	Descreve se o item do pedido é cancelável ou não.
OrderItemDetails	Detalhes do item do pedido
OrderItemResource	Representa o contrato do item de ordem
OrderItemReturnEnum	Descreve se o item do pedido é retornável ou não.
OrderItemType	Tipo de item de pedido.
OrderItemUpdateParameter	Atualiza os parâmetros do item de ordem.
Preferences	Preferências relacionadas com a encomenda
ProductDetails	Representa os detalhes do produto
ResourceProviderDetails	Detalhes do RP de gerenciamento
ReverseShippingDetails	Detalhes de envio reverso.
ShippingAddress	Endereço de entrega onde o cliente deseja receber o dispositivo.
StageDetails	Detalhes do estágio do recurso.
StageName	Nome da fase
StageStatus	Status do palco.
systemData	Metadados referentes à criação e última modificação do recurso.
TransportPreferences	Preferências relacionadas com a logística de envio do sku
TransportShipmentTypes	Indica o tipo de Logística de Envio que o cliente preferia.

ActionStatusEnum

Enumeração

Descreve se o item de ordem é excluível ou não.

Valor	Description
Allowed	Bandeira permitida.
NotAllowed	Bandeira não permitida.

AddressDetails

Object

Detalhes do endereço de um item de pedido.

Name	Tipo	Description
forwardAddress	AddressProperties	Endereço do cliente e detalhes de contato. Deve ser recurso de endereço
returnAddress	AddressProperties	Endereço de devolução

AddressProperties

Object

Propriedades do endereço

Name	Tipo	Description
addressValidationStatus	AddressValidationStatus	Status da validação do endereço
contactDetails	ContactDetails	Detalhes de contato para o endereço
shippingAddress	ShippingAddress	Detalhes de envio para o endereço

AddressType

Enumeração

Tipo de endereço.

Valor	Description
None	Tipo de endereço desconhecido.
Residential	Endereço residencial.
Commercial	Endereço comercial.

AddressValidationStatus

Enumeração

Status da validação do endereço

Valor	Description
Valid	O endereço fornecido é válido.
Invalid	O endereço fornecido é inválido ou não é suportado.
Ambiguous	O endereço fornecido é ambíguo, por favor, escolha um dos endereços alternativos devolvidos.

ContactDetails

Object

Detalhes de contacto.

Name	Tipo	Description
contactName	string	Nome de contacto da pessoa.
emailList	string[]	Lista de IDs de e-mail a serem notificados sobre o progresso do trabalho.
mobile	string	Número de telemóvel da pessoa de contacto.
phone	string	Número de telefone da pessoa de contacto.
phoneExtension	string	Número do ramal telefónico da pessoa de contacto.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DeviceDetails

Object

Detalhes do dispositivo.

Name	Tipo	Description
managementResourceId	string	ID do recurso de gerenciamento
managementResourceTenantId	string	ID do locatário do recurso de gerenciamento
serialNumber	string	número de série do dispositivo

DisplayInfo

Object

Descreve as informações de exibição do produto

Name	Tipo	Description
configurationDisplayName	string	Nome de exibição da configuração
productFamilyDisplayName	string	Nome de exibição da família de produtos

DoubleEncryptionStatus

Enumeração

Status de criptografia dupla conforme inserido pelo cliente. É obrigatório fornecer este parâmetro se a política 'Negar' ou 'Desativado' estiver configurada.

Valor	Description
Disabled	A encriptação dupla está desativada
Enabled	A encriptação dupla está ativada

EncryptionPreferences

Object

Preferências relacionadas com a dupla encriptação

Name	Tipo	Description
doubleEncryptionStatus	DoubleEncryptionStatus	Status de criptografia dupla conforme inserido pelo cliente. É obrigatório fornecer este parâmetro se a política 'Negar' ou 'Desativado' estiver configurada.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ForwardShippingDetails

Object

Encaminhar detalhes da remessa.

Name	Tipo	Description
carrierDisplayName	string	Nome da transportadora para fins de exibição. Não deve ser usado para qualquer processamento.
carrierName	string	Nome da transportadora.
trackingId	string	TrackingId do pacote
trackingUrl	string	TrackingUrl do pacote.

HierarchyInformation

Object

Contém detalhes sobre informações de hierarquia de produtos

Name	Tipo	Description
configurationName	string	Representa o nome da configuração que identifica exclusivamente a configuração
productFamilyName	string	Representa o nome da família de produtos que identifica exclusivamente a família de produtos
productLineName	string	Representa o nome da linha de produtos que identifica exclusivamente a linha de produtos
productName	string	Representa o nome do produto que identifica exclusivamente o produto

ManagementResourcePreferences

Object

Preferência de recurso de gerenciamento para vincular dispositivo

Name	Tipo	Description
preferredManagementResourceId	string	ID ARM do recurso de gerenciamento preferido do cliente

NotificationPreference

Object

Preferência de notificação para um estágio de trabalho.

Name	Tipo	Description
sendNotification	boolean	A notificação é obrigatória ou não.
stageName	NotificationStageName	Nome do palco.

NotificationStageName

Enumeração

Nome do palco.

Valor	Description
Shipped	Notificação no item de pedido enviado do datacenter da Microsoft.
Delivered	Notificação no item do pedido entregue ao cliente.

OrderItemCancellationEnum

Enumeração

Descreve se o item do pedido é cancelável ou não.

Valor	Description
Cancellable	O artigo da encomenda pode ser cancelado sem custos.
CancellableWithFee	Item de pedido pode ser cancelado com taxa.
NotCancellable	Item de pedido não cancelável.

OrderItemDetails

Object

Detalhes do item do pedido

Name	Tipo	Description
cancellationReason	string	Motivo do cancelamento.
cancellationStatus	OrderItemCancellationEnum	Descreve se o item do pedido é cancelável ou não.
currentStage	StageDetails	Status atual do item do pedido
deletionStatus	ActionStatusEnum	Descreve se o item de ordem é excluível ou não.
error	ErrorDetail	Erro de nível superior para o trabalho.
forwardShippingDetails	ForwardShippingDetails	Detalhes de envio do pacote de encaminhamento
managementRpDetails	ResourceProviderDetails	Detalhes do RP pai - retorna apenas o primeiro RP pai ou o RP pai padrão de toda a lista
managementRpDetailsList	ResourceProviderDetails[]	Lista de detalhes do RP pai suportados para configuração.
notificationEmailList	string[]	Lista de e-mail de notificação adicional
orderItemStageHistory	StageDetails[]	Histórico de status do item do pedido
orderItemType	OrderItemType	Tipo de item de pedido.
preferences	Preferences	Preferências de notificação do cliente
productDetails	ProductDetails	Identificador exclusivo para configuração.
returnReason	string	Motivo da devolução.
returnStatus	OrderItemReturnEnum	Descreve se o item do pedido é retornável ou não.
reverseShippingDetails	ReverseShippingDetails	Detalhes de envio de pacote reverso

OrderItemResource

Object

Representa o contrato do item de ordem

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.addressDetails	AddressDetails	Representa o endereço de envio e devolução do item do pedido
properties.orderId	string	Id da ordem à qual o item de ordem pertence
properties.orderItemDetails	OrderItemDetails	Representa os detalhes do item do pedido.
properties.startTime	string (date-time)	Hora de início do item de ordem
systemData	systemData	Representa a criação de recursos e o tempo de atualização
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

OrderItemReturnEnum

Enumeração

Descreve se o item do pedido é retornável ou não.

Valor	Description
Returnable	O artigo da encomenda pode ser devolvido sem custos.
ReturnableWithFee	O artigo da encomenda pode ser devolvido com taxa.
NotReturnable	Item de pedido não retornável.

OrderItemType

Enumeração

Tipo de item de pedido.

Valor	Description
Purchase	Ordem de compraItem.
Rental	Ordem de aluguerItem.

OrderItemUpdateParameter

Object

Atualiza os parâmetros do item de ordem.

Name	Tipo	Description
properties.forwardAddress	AddressProperties	Atualiza o endereço de envio e os detalhes de contato.
properties.notificationEmailList	string[]	Lista de e-mail de notificação adicional.
properties.preferences	Preferences	Preferência do cliente.
tags	object	A lista de pares de valores de chave que descrevem o recurso. Essas tags podem ser usadas para visualizar e agrupar esse recurso (entre grupos de recursos).

Preferences

Object

Preferências relacionadas com a encomenda

Name	Tipo	Description
encryptionPreferences	EncryptionPreferences	Preferências relacionadas com a Encriptação.
managementResourcePreferences	ManagementResourcePreferences	Preferências relacionadas com o recurso de Gestão.
notificationPreferences	NotificationPreference[]	Preferências de notificação.
transportPreferences	TransportPreferences	Preferências relacionadas com a logística de envio da encomenda.

ProductDetails

Object

Representa os detalhes do produto

Name	Tipo	Description
count	integer (int32)	Quantidade do produto
deviceDetails	DeviceDetails[]	Lista de detalhes do dispositivo
displayInfo	DisplayInfo	Exibir detalhes do produto
hierarchyInformation	HierarchyInformation	Hierarquia do produto que identifica exclusivamente o produto
productDoubleEncryptionStatus	DoubleEncryptionStatus	Status de criptografia dupla da configuração. Campo somente leitura.

ResourceProviderDetails

Object

Detalhes do RP de gerenciamento

Name	Tipo	Description
resourceProviderNamespace	string	Namespace do provedor de recursos

ReverseShippingDetails

Object

Detalhes de envio reverso.

Name	Tipo	Description
carrierDisplayName	string	Nome da transportadora para fins de exibição. Não deve ser usado para qualquer processamento.
carrierName	string	Nome da transportadora.
sasKeyForLabel	string	Chave SAS para descarregar a etiqueta de envio reverso da embalagem.
trackingId	string	TrackingId do pacote
trackingUrl	string	TrackingUrl do pacote.

ShippingAddress

Object

Endereço de entrega onde o cliente deseja receber o dispositivo.

Name	Tipo	Description
addressType	AddressType	Tipo de endereço.
city	string	Nome da cidade.
companyName	string	Nome da empresa.
country	string	Nome do país.
postalCode	string	Código postal.
stateOrProvince	string	Nome do Estado ou Província.
streetAddress1	string	Endereço linha 1.
streetAddress2	string	Endereço linha 2.
streetAddress3	string	Endereço linha 3.
zipExtendedCode	string	CEP estendido.

StageDetails

Object

Detalhes do estágio do recurso.

Name	Tipo	Description
displayName	string	Nome para exibição do estágio do recurso.
stageName	StageName	Nome da fase
stageStatus	StageStatus	Status do palco.
startTime	string (date-time)	Hora de início do estágio

StageName

Enumeração

Nome da fase

Valor	Description
Placed	Atualmente em modo rascunho e ainda pode ser cancelado
InReview	A encomenda está atualmente em modo de rascunho e ainda pode ser cancelada
Confirmed	A encomenda está confirmada
ReadyToShip	A encomenda está pronta para ser enviada
Shipped	A encomenda está em trânsito para o cliente
Delivered	A encomenda é entregue ao cliente
InUse	O pedido está em uso no site do cliente
ReturnInitiated	A devolução foi iniciada pelo cliente.
ReturnPickedUp	O pedido está em trânsito do cliente para a microsoft.
ReturnedToMicrosoft	A encomenda foi recebida de volta à microsoft.
ReturnCompleted	O retorno já foi concluído.
Cancelled	A encomenda foi cancelada.

StageStatus

Enumeração

Status do palco.

Valor	Description
None	Ainda não há status disponível.
InProgress	Estágio está em andamento.
Succeeded	O estágio foi bem-sucedido.
Failed	Etapa falhou.
Cancelled	A etapa foi cancelada.
Cancelling	Estágio está cancelando.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TransportPreferences

Object

Preferências relacionadas com a logística de envio do sku

Name	Tipo	Description
preferredShipmentType	TransportShipmentTypes	Indica o tipo de Logística de Envio que o cliente preferia.

TransportShipmentTypes

Enumeração

Indica o tipo de Logística de Envio que o cliente preferia.

Valor	Description
CustomerManaged	A logística de envio é tratada pelo cliente.
MicrosoftManaged	A logística de envio é tratada pela Microsoft.

Partilhar via

Update Order Item - Update Order Item

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

UpdateOrderItem

Pedido de amostra

Resposta da amostra

Definições

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