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 de URI

Nome	Em	Obrigatório	Tipo	Description
orderItemName	path	True	string	O nome do item de pedido
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 da solicitação

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

Corpo da solicitação

Nome	Tipo	Description
properties.forwardAddress	AddressProperties	Atualiza o endereço de envio e os detalhes do contato.
properties.notificationEmailList	string[]	Lista de email 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 marcas podem ser usadas na exibição e agrupamento desse recurso (entre grupos de recursos).

Respostas

Nome	Tipo	Description
200 OK	OrderItemResource	Objeto de recurso de item de pedido.
202 Accepted		Solicitação aceita para atualização de item de pedido.
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo da falha na operação.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

UpdateOrderItem

Solicitação de exemplo

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

Java

import com.azure.resourcemanager.edgeorder.models.OrderItemResource;
import com.azure.resourcemanager.edgeorder.models.Preferences;
import com.azure.resourcemanager.edgeorder.models.TransportPreferences;
import com.azure.resourcemanager.edgeorder.models.TransportShipmentTypes;

/**
 * Samples for ResourceProvider UpdateOrderItem.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/UpdateOrderItem.json
     */
    /**
     * Sample code: UpdateOrderItem.
     * 
     * @param manager Entry point to EdgeOrderManager.
     */
    public static void updateOrderItem(com.azure.resourcemanager.edgeorder.EdgeOrderManager manager) {
        OrderItemResource resource = manager.resourceProviders().getOrderItemByNameWithResponse("TestOrderItemName3",
            "YourResourceGroupName", null, com.azure.core.util.Context.NONE).getValue();
        resource.update().withPreferences(new Preferences().withTransportPreferences(
            new TransportPreferences().withPreferredShipmentType(TransportShipmentTypes.CUSTOMER_MANAGED))).apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.edgeorder import EdgeOrderManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-edgeorder
# USAGE
    python update_order_item.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EdgeOrderManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="YourSubscriptionId",
    )

    response = client.begin_update_order_item(
        order_item_name="TestOrderItemName3",
        resource_group_name="YourResourceGroupName",
        order_item_update_parameter={
            "properties": {"preferences": {"transportPreferences": {"preferredShipmentType": "CustomerManaged"}}}
        },
    ).result()
    print(response)


# x-ms-original-file: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/UpdateOrderItem.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armedgeorder_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/edgeorder/armedgeorder"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/UpdateOrderItem.json
func ExampleManagementClient_BeginUpdateOrderItem() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armedgeorder.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewManagementClient().BeginUpdateOrderItem(ctx, "TestOrderItemName3", "YourResourceGroupName", armedgeorder.OrderItemUpdateParameter{
		Properties: &armedgeorder.OrderItemUpdateProperties{
			Preferences: &armedgeorder.Preferences{
				TransportPreferences: &armedgeorder.TransportPreferences{
					PreferredShipmentType: to.Ptr(armedgeorder.TransportShipmentTypesCustomerManaged),
				},
			},
		},
	}, &armedgeorder.ManagementClientBeginUpdateOrderItemOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OrderItemResource = armedgeorder.OrderItemResource{
	// 	Name: to.Ptr("TestOrderItemName3"),
	// 	Type: to.Ptr("Microsoft.EdgeOrder/orderItems"),
	// 	ID: to.Ptr("/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3"),
	// 	Location: to.Ptr("eastus"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armedgeorder.OrderItemProperties{
	// 		AddressDetails: &armedgeorder.AddressDetails{
	// 			ForwardAddress: &armedgeorder.AddressProperties{
	// 				AddressValidationStatus: to.Ptr(armedgeorder.AddressValidationStatusValid),
	// 				ContactDetails: &armedgeorder.ContactDetails{
	// 					ContactName: to.Ptr("XXXX XXXX"),
	// 					EmailList: []*string{
	// 						to.Ptr("xxxx@xxxx.xxx")},
	// 						Phone: to.Ptr("0000000000"),
	// 						PhoneExtension: to.Ptr(""),
	// 					},
	// 					ShippingAddress: &armedgeorder.ShippingAddress{
	// 						AddressType: to.Ptr(armedgeorder.AddressTypeNone),
	// 						City: to.Ptr("San Francisco"),
	// 						CompanyName: to.Ptr("Microsoft"),
	// 						Country: to.Ptr("US"),
	// 						PostalCode: to.Ptr("94107"),
	// 						StateOrProvince: to.Ptr("CA"),
	// 						StreetAddress1: to.Ptr("16 TOWNSEND ST"),
	// 						StreetAddress2: to.Ptr("UNIT 1"),
	// 					},
	// 				},
	// 			},
	// 			OrderID: to.Ptr("/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName3"),
	// 			OrderItemDetails: &armedgeorder.OrderItemDetails{
	// 				CancellationStatus: to.Ptr(armedgeorder.OrderItemCancellationEnumCancellable),
	// 				CurrentStage: &armedgeorder.StageDetails{
	// 					StageName: to.Ptr(armedgeorder.StageNamePlaced),
	// 					StageStatus: to.Ptr(armedgeorder.StageStatusSucceeded),
	// 					StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T06:00:31.583Z"); return t}()),
	// 				},
	// 				DeletionStatus: to.Ptr(armedgeorder.ActionStatusEnumNotAllowed),
	// 				ManagementRpDetailsList: []*armedgeorder.ResourceProviderDetails{
	// 					{
	// 						ResourceProviderNamespace: to.Ptr("Microsoft.DataBoxEdge"),
	// 				}},
	// 				NotificationEmailList: []*string{
	// 				},
	// 				OrderItemStageHistory: []*armedgeorder.StageDetails{
	// 					{
	// 						StageName: to.Ptr(armedgeorder.StageNamePlaced),
	// 						StageStatus: to.Ptr(armedgeorder.StageStatusSucceeded),
	// 						StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T06:00:31.583Z"); return t}()),
	// 					},
	// 					{
	// 						StageName: to.Ptr(armedgeorder.StageNameConfirmed),
	// 						StageStatus: to.Ptr(armedgeorder.StageStatusNone),
	// 					},
	// 					{
	// 						StageName: to.Ptr(armedgeorder.StageNameReadyToShip),
	// 						StageStatus: to.Ptr(armedgeorder.StageStatusNone),
	// 					},
	// 					{
	// 						StageName: to.Ptr(armedgeorder.StageNameShipped),
	// 						StageStatus: to.Ptr(armedgeorder.StageStatusNone),
	// 					},
	// 					{
	// 						StageName: to.Ptr(armedgeorder.StageNameDelivered),
	// 						StageStatus: to.Ptr(armedgeorder.StageStatusNone),
	// 					},
	// 					{
	// 						StageName: to.Ptr(armedgeorder.StageNameInUse),
	// 						StageStatus: to.Ptr(armedgeorder.StageStatusNone),
	// 				}},
	// 				OrderItemType: to.Ptr(armedgeorder.OrderItemTypePurchase),
	// 				Preferences: &armedgeorder.Preferences{
	// 					TransportPreferences: &armedgeorder.TransportPreferences{
	// 						PreferredShipmentType: to.Ptr(armedgeorder.TransportShipmentTypesCustomerManaged),
	// 					},
	// 				},
	// 				ProductDetails: &armedgeorder.ProductDetails{
	// 					Count: to.Ptr[int32](0),
	// 					DisplayInfo: &armedgeorder.DisplayInfo{
	// 						ConfigurationDisplayName: to.Ptr("Azure Stack Edge Pro - 1 GPU"),
	// 						ProductFamilyDisplayName: to.Ptr("Azure Stack Edge"),
	// 					},
	// 					HierarchyInformation: &armedgeorder.HierarchyInformation{
	// 						ConfigurationName: to.Ptr("edgep_base"),
	// 						ProductFamilyName: to.Ptr("azurestackedge"),
	// 						ProductLineName: to.Ptr("azurestackedge"),
	// 						ProductName: to.Ptr("azurestackedgegpu"),
	// 					},
	// 					ProductDoubleEncryptionStatus: to.Ptr(armedgeorder.DoubleEncryptionStatusDisabled),
	// 				},
	// 				ReturnStatus: to.Ptr(armedgeorder.OrderItemReturnEnumNotReturnable),
	// 			},
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T05:59:47.348Z"); return t}()),
	// 		},
	// 		SystemData: &armedgeorder.SystemData{
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.EdgeOrder.Models;
using Azure.ResourceManager.EdgeOrder;

// Generated from example definition: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/UpdateOrderItem.json
// this example is just showing the usage of "UpdateOrderItem" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this EdgeOrderItemResource created on azure
// for more information of creating EdgeOrderItemResource, please refer to the document of EdgeOrderItemResource
string subscriptionId = "fa68082f-8ff7-4a25-95c7-ce9da541242f";
string resourceGroupName = "TestRG";
string orderItemName = "TestOrderItemName01";
ResourceIdentifier edgeOrderItemResourceId = EdgeOrderItemResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, orderItemName);
EdgeOrderItemResource edgeOrderItem = client.GetEdgeOrderItemResource(edgeOrderItemResourceId);

// invoke the operation
EdgeOrderItemPatch patch = new EdgeOrderItemPatch
{
    Tags =
    {
    ["ant"] = "insect",
    ["pigeon"] = "bird",
    ["tiger"] = "animal"
    },
    ForwardAddress = new EdgeOrderItemAddressProperties(new EdgeOrderAddressContactDetails("Updated contact name", "2222200000", new string[] { "testemail@microsoft.com" })),
    Preferences = new OrderItemPreferences
    {
        TransportPreferencesPreferredShipmentType = TransportShipmentType.CustomerManaged,
    },
};
ArmOperation<EdgeOrderItemResource> lro = await edgeOrderItem.UpdateAsync(WaitUntil.Completed, patch);
EdgeOrderItemResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
EdgeOrderItemData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

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 status:

202

Definições

Nome	Description
ActionStatusEnum	Descreve se o item de pedido é deletá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 de endereço
ContactDetails	Detalhes do contato.
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 esse parâmetro se a política 'Negar' ou 'Desabilitada' estiver configurada.
EncryptionPreferences	Preferências relacionadas à criptografia dupla
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ForwardShippingDetails	Encaminhar detalhes de remessa.
HierarchyInformation	Contém detalhes sobre as informações da hierarquia do produto
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 estágio.
OrderItemCancellationEnum	Descreve se o item de pedido é cancelável ou não.
OrderItemDetails	Detalhes do item de pedido
OrderItemResource	Representa o contrato do item de pedido
OrderItemReturnEnum	Descreve se o item de pedido é retornável ou não.
OrderItemType	Tipo de item de pedido.
OrderItemUpdateParameter	Atualiza os parâmetros do item de pedido.
Preferences	Preferências relacionadas à ordem
ProductDetails	Representa os detalhes do produto
ResourceProviderDetails	Detalhes do RP de gerenciamento
ReverseShippingDetails	Detalhes da remessa inversa.
ShippingAddress	Endereço de envio em que o cliente deseja receber o dispositivo.
StageDetails	Detalhes do estágio do recurso.
StageName	Nome do estágio
StageStatus	Status do estágio.
systemData	Metadados relativos à criação e última modificação do recurso.
TransportPreferences	Preferências relacionadas à logística de remessa do sku
TransportShipmentTypes	Indica o tipo de Logística de Remessa que o cliente preferiu.

ActionStatusEnum

Enumeração

Descreve se o item de pedido é deletável ou não.

Valor	Description
Allowed	Sinalizador permitido.
NotAllowed	Sinalizador não permitido.

AddressDetails

Objeto

Detalhes do endereço de um item de pedido.

Nome	Tipo	Description
forwardAddress	AddressProperties	Endereço do cliente e detalhes do contato. Ele deve ser o recurso de endereço
returnAddress	AddressProperties	Endereço de envio de devolução

AddressProperties

Objeto

Propriedades do endereço

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

AddressType

Enumeração

Tipo de endereço.

Valor	Description
Commercial	Endereço comercial.
None	Tipo de endereço não conhecido.
Residential	Endereço residencial.

AddressValidationStatus

Enumeração

Status da validação de endereço

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

ContactDetails

Objeto

Detalhes do contato.

Nome	Tipo	Description
contactName	string	Nome do contato da pessoa.
emailList	string[]	Lista de IDs por email a serem notificadas sobre o progresso do trabalho.
mobile	string	Número de celular da pessoa de contato.
phone	string	Número de telefone da pessoa de contato.
phoneExtension	string	Número de extensão de telefone da pessoa de contato.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DeviceDetails

Objeto

Detalhes do dispositivo.

Nome	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

Objeto

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

Nome	Tipo	Description
configurationDisplayName	string	Nome de exibição de 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 esse parâmetro se a política 'Negar' ou 'Desabilitada' estiver configurada.

Valor	Description
Disabled	A criptografia dupla está desabilitada
Enabled	A criptografia dupla está habilitada

EncryptionPreferences

Objeto

Preferências relacionadas à criptografia dupla

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

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ForwardShippingDetails

Objeto

Encaminhar detalhes de remessa.

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

HierarchyInformation

Objeto

Contém detalhes sobre as informações da hierarquia do produto

Nome	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 do produto que identifica exclusivamente a linha do produto
productName	string	Representa o nome do produto que identifica exclusivamente o produto

ManagementResourcePreferences

Objeto

Preferência de recurso de gerenciamento para vincular dispositivo

Nome	Tipo	Description
preferredManagementResourceId	string	ID do ARM do recurso de gerenciamento preferencial do cliente

NotificationPreference

Objeto

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

Nome	Tipo	Description
sendNotification	boolean	A notificação é necessária ou não.
stageName	NotificationStageName	Nome do estágio.

NotificationStageName

Enumeração

Nome do estágio.

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

OrderItemCancellationEnum

Enumeração

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

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

OrderItemDetails

Objeto

Detalhes do item de pedido

Nome	Tipo	Description
cancellationReason	string	Motivo do cancelamento.
cancellationStatus	OrderItemCancellationEnum	Descreve se o item de pedido é cancelável ou não.
currentStage	StageDetails	Status do item de ordem atual
deletionStatus	ActionStatusEnum	Descreve se o item de pedido é deletável ou não.
error	ErrorDetail	Erro de nível superior para o trabalho.
forwardShippingDetails	ForwardShippingDetails	Encaminhar detalhes de envio de pacotes
managementRpDetails	ResourceProviderDetails	Detalhes de RP pai – isso retorna apenas o primeiro RP pai ou padrão de toda a lista
managementRpDetailsList	ResourceProviderDetails[]	Lista de detalhes de RP pai com suporte para configuração.
notificationEmailList	string[]	Lista de email de notificação adicional
orderItemStageHistory	StageDetails[]	Histórico de status do item de 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 de retorno.
returnStatus	OrderItemReturnEnum	Descreve se o item de pedido é retornável ou não.
reverseShippingDetails	ReverseShippingDetails	Detalhes do envio reverso de pacotes

OrderItemResource

Objeto

Representa o contrato do item de pedido

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

OrderItemReturnEnum

Enumeração

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

Valor	Description
NotReturnable	Item de pedido não retornável.
Returnable	O item de pedido pode ser retornado sem taxa.
ReturnableWithFee	O item de pedido pode ser retornado com a taxa.

OrderItemType

Enumeração

Tipo de item de pedido.

Valor	Description
Purchase	OrderItem de compra.
Rental	OrderItem de Aluguel.

OrderItemUpdateParameter

Objeto

Atualiza os parâmetros do item de pedido.

Nome	Tipo	Description
properties.forwardAddress	AddressProperties	Atualiza o endereço de envio e os detalhes do contato.
properties.notificationEmailList	string[]	Lista de email 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 marcas podem ser usadas na exibição e agrupamento desse recurso (entre grupos de recursos).

Preferences

Objeto

Preferências relacionadas à ordem

Nome	Tipo	Description
encryptionPreferences	EncryptionPreferences	Preferências relacionadas à Criptografia.
managementResourcePreferences	ManagementResourcePreferences	Preferências relacionadas ao recurso gerenciamento.
notificationPreferences	NotificationPreference[]	Preferências de notificação.
transportPreferences	TransportPreferences	Preferências relacionadas à logística de remessa do pedido.

ProductDetails

Objeto

Representa os detalhes do produto

Nome	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

Objeto

Detalhes do RP de gerenciamento

Nome	Tipo	Description
resourceProviderNamespace	string	Namespace de provedor de recursos

ReverseShippingDetails

Objeto

Detalhes da remessa inversa.

Nome	Tipo	Description
carrierDisplayName	string	Nome da transportadora para fins de exibição. Não deve ser usado para nenhum processamento.
carrierName	string	Nome da transportadora.
sasKeyForLabel	string	Chave SAS para baixar o rótulo de remessa reversa do pacote.
trackingId	string	TrackingId do pacote
trackingUrl	string	TrackingUrl do pacote.

ShippingAddress

Objeto

Endereço de envio em que o cliente deseja receber o dispositivo.

Nome	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 de Rua linha 1.
streetAddress2	string	Endereço de Rua linha 2.
streetAddress3	string	Endereço de Rua linha 3.
zipExtendedCode	string	Cep estendido.

StageDetails

Objeto

Detalhes do estágio do recurso.

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

StageName

Enumeração

Nome do estágio

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

StageStatus

Enumeração

Status do estágio.

Valor	Description
Cancelled	O estágio foi cancelado.
Cancelling	O estágio está sendo cancelado.
Failed	O estágio falhou.
InProgress	O estágio está em andamento.
None	Nenhum status disponível ainda.
Succeeded	O estágio foi bem-sucedido.

systemData

Objeto

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

Nome	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

Objeto

Preferências relacionadas à logística de remessa do sku

Nome	Tipo	Description
preferredShipmentType	TransportShipmentTypes	Indica o tipo de Logística de Remessa que o cliente preferiu.

TransportShipmentTypes

Enumeração

Indica o tipo de Logística de Remessa que o cliente preferiu.

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