Update Order Item - Update Order Item

Referentie

Service:: Edge Hardware Center

API-versie:: 2021-12-01

Hiermee worden de eigenschappen van een bestaand orderitem bijgewerkt.

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

URI-parameters

Name	In	Vereist	Type	Description
orderItemName	path	True	string	De naam van het orderitem
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match		string	Hiermee definieert u de voorwaarde If-Match. De patch wordt alleen uitgevoerd als de ETag van de order op de server overeenkomt met deze waarde.

Aanvraagbody

Name	Type	Description
properties.forwardAddress	AddressProperties	Hiermee worden het verzendadres en contactgegevens bijgewerkt.
properties.notificationEmailList	string[]	Aanvullende lijst met e-mailmeldingen.
properties.preferences	Preferences	Klantvoorkeur.
tags	object	De lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt voor het weergeven en groeperen van deze resource (tussen resourcegroepen).

Antwoorden

Name	Type	Description
200 OK	OrderItemResource	Resourceobject orderitem.
202 Accepted		Geaccepteerde aanvraag voor het bijwerken van orderitems.
Other Status Codes	ErrorResponse	Foutantwoord met een beschrijving van de reden voor een bewerkingsfout.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

UpdateOrderItem

Voorbeeldaanvraag

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

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


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

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

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

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

Voorbeeldrespons

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

Statuscode:: 202

Definities

Name	Description
ActionStatusEnum	Beschrijft of het orderitem al dan niet kan worden verwijdert.
AddressDetails	Adresgegevens voor een orderitem.
AddressProperties	Adreseigenschappen
AddressType	Type adres.
AddressValidationStatus	Status van adresvalidatie
ContactDetails	Contactgegevens.
createdByType	Het type identiteit waarmee de resource is gemaakt.
DeviceDetails	Apparaatdetails.
DisplayInfo	Beschrijft productweergave-informatie
DoubleEncryptionStatus	Dubbele versleutelingsstatus zoals ingevoerd door de klant. Het is verplicht om deze parameter te geven als het beleid Weigeren of Uitgeschakeld is geconfigureerd.
EncryptionPreferences	Voorkeuren met betrekking tot dubbele versleuteling
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
ForwardShippingDetails	Verzendgegevens door.
HierarchyInformation	Bevat informatie over producthiërarchiegegevens
ManagementResourcePreferences	Beheerresourcevoorkeur om apparaat te koppelen
NotificationPreference	Meldingsvoorkeur voor een taakfase.
NotificationStageName	Naam van de fase.
OrderItemCancellationEnum	Beschrijft of het orderitem kan worden geannuleerd of niet.
OrderItemDetails	Details van orderitem
OrderItemResource	Vertegenwoordigt orderitemcontract
OrderItemReturnEnum	Beschrijft of het orderitem retourneert of niet.
OrderItemType	Orderitemtype.
OrderItemUpdateParameter	Hiermee worden orderitemparameters bijgewerkt.
Preferences	Voorkeuren met betrekking tot de bestelling
ProductDetails	Vertegenwoordigt productdetails
ResourceProviderDetails	Details van beheer-RP
ReverseShippingDetails	Details van omgekeerde verzending.
ShippingAddress	Verzendadres waar de klant het apparaat wil ontvangen.
StageDetails	Details van resourcefase.
StageName	Fasenaam
StageStatus	Fasestatus.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
TransportPreferences	Voorkeuren met betrekking tot de verzendingslogistiek van de sKU
TransportShipmentTypes	Hiermee wordt het type Verzendingslogistiek aangegeven dat de klant de voorkeur heeft gegeven.

ActionStatusEnum

Inventarisatie

Beschrijft of het orderitem al dan niet kan worden verwijdert.

Waarde	Description
Allowed	Vlag toegestaan.
NotAllowed	Vlag niet toegestaan.

AddressDetails

Object

Adresgegevens voor een orderitem.

Name	Type	Description
forwardAddress	AddressProperties	Klantadres en contactgegevens. Dit moet een adresresource zijn
returnAddress	AddressProperties	Verzendadres retourneren

AddressProperties

Object

Adreseigenschappen

Name	Type	Description
addressValidationStatus	AddressValidationStatus	Status van adresvalidatie
contactDetails	ContactDetails	Contactgegevens voor het adres
shippingAddress	ShippingAddress	Verzendgegevens voor het adres

AddressType

Inventarisatie

Type adres.

Waarde	Description
Commercial	Commercieel adres.
None	Adrestype niet bekend.
Residential	Woonadres.

AddressValidationStatus

Inventarisatie

Status van adresvalidatie

Waarde	Description
Ambiguous	Het opgegeven adres is dubbelzinnig. Kies een van de alternatieve adressen die worden geretourneerd.
Invalid	Het opgegeven adres is ongeldig of wordt niet ondersteund.
Valid	Het opgegeven adres is geldig.

ContactDetails

Object

Contactgegevens.

Name	Type	Description
contactName	string	Naam van de contactpersoon.
emailList	string[]	Lijst met e-mail-id's die moeten worden geïnformeerd over de voortgang van de taak.
mobile	string	Mobiel nummer van de contactpersoon.
phone	string	Telefoonnummer van de contactpersoon.
phoneExtension	string	Telefoonnummer van de contactpersoon.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

DeviceDetails

Object

Apparaatdetails.

Name	Type	Description
managementResourceId	string	Beheerresource-id
managementResourceTenantId	string	Tenant-id van beheerresource
serialNumber	string	serienummer van apparaat

DisplayInfo

Object

Beschrijft productweergave-informatie

Name	Type	Description
configurationDisplayName	string	Weergavenaam van configuratie
productFamilyDisplayName	string	Weergavenaam van productfamilie

DoubleEncryptionStatus

Inventarisatie

Dubbele versleutelingsstatus zoals ingevoerd door de klant. Het is verplicht om deze parameter te geven als het beleid Weigeren of Uitgeschakeld is geconfigureerd.

Waarde	Description
Disabled	Dubbele versleuteling is uitgeschakeld
Enabled	Dubbele versleuteling is ingeschakeld

EncryptionPreferences

Object

Voorkeuren met betrekking tot dubbele versleuteling

Name	Type	Description
doubleEncryptionStatus	DoubleEncryptionStatus	Dubbele versleutelingsstatus zoals ingevoerd door de klant. Het is verplicht om deze parameter te geven als het beleid Weigeren of Uitgeschakeld is geconfigureerd.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ForwardShippingDetails

Object

Verzendgegevens door.

Name	Type	Description
carrierDisplayName	string	Naam van de provider voor weergavedoeleinden. Niet te gebruiken voor verwerking.
carrierName	string	Naam van de vervoerder.
trackingId	string	TrackingId van het pakket
trackingUrl	string	TrackingUrl van het pakket.

HierarchyInformation

Object

Bevat informatie over producthiërarchiegegevens

Name	Type	Description
configurationName	string	Vertegenwoordigt de configuratienaam die de configuratie uniek identificeert
productFamilyName	string	Vertegenwoordigt de productfamilienaam die uniek productfamilie identificeert
productLineName	string	Vertegenwoordigt de productlijnnaam waarmee productlijn uniek wordt geïdentificeerd
productName	string	Vertegenwoordigt productnaam die het product uniek identificeert

ManagementResourcePreferences

Object

Beheerresourcevoorkeur om apparaat te koppelen

Name	Type	Description
preferredManagementResourceId	string	ARM-id van de klant voorkeursbeheerresource

NotificationPreference

Object

Meldingsvoorkeur voor een taakfase.

Name	Type	Description
sendNotification	boolean	Melding is vereist of niet.
stageName	NotificationStageName	Naam van de fase.

NotificationStageName

Inventarisatie

Naam van de fase.

Waarde	Description
Delivered	Melding bij orderitem dat aan de klant wordt geleverd.
Shipped	Melding bij orderitem dat is verzonden vanuit het Microsoft-datacenter.

OrderItemCancellationEnum

Inventarisatie

Beschrijft of het orderitem kan worden geannuleerd of niet.

Waarde	Description
Cancellable	Orderitem kan zonder kosten worden geannuleerd.
CancellableWithFee	Orderitem kan worden geannuleerd met kosten.
NotCancellable	Orderitem kan niet worden geannuleerd.

OrderItemDetails

Object

Details van orderitem

Name	Type	Description
cancellationReason	string	Annuleringsreden.
cancellationStatus	OrderItemCancellationEnum	Beschrijft of het orderitem kan worden geannuleerd of niet.
currentStage	StageDetails	Status van huidig orderitem
deletionStatus	ActionStatusEnum	Beschrijft of het orderitem al dan niet kan worden verwijdert.
error	ErrorDetail	Fout op het hoogste niveau voor de taak.
forwardShippingDetails	ForwardShippingDetails	Verzenddetails van pakket doorsturen
managementRpDetails	ResourceProviderDetails	Bovenliggende RP-details: hiermee wordt alleen de eerste of standaard bovenliggende RP uit de hele lijst geretourneerd
managementRpDetailsList	ResourceProviderDetails[]	Lijst met bovenliggende RP-details die worden ondersteund voor configuratie.
notificationEmailList	string[]	Aanvullende lijst met e-mailmeldingen
orderItemStageHistory	StageDetails[]	Statusgeschiedenis van orderitem
orderItemType	OrderItemType	Orderitemtype.
preferences	Preferences	Voorkeuren voor klantmeldingen
productDetails	ProductDetails	Unieke id voor configuratie.
returnReason	string	Retourreden.
returnStatus	OrderItemReturnEnum	Beschrijft of het orderitem retourneert of niet.
reverseShippingDetails	ReverseShippingDetails	Details van omgekeerde pakketverzending

OrderItemResource

Object

Vertegenwoordigt orderitemcontract

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.addressDetails	AddressDetails	Vertegenwoordigt verzend- en retouradres voor orderitem
properties.orderId	string	Id van de order waartoe orderitem behoort
properties.orderItemDetails	OrderItemDetails	Vertegenwoordigt orderitemgegevens.
properties.startTime	string (date-time)	Begintijd van orderitem
systemData	systemData	Vertegenwoordigt het maken en bijwerken van resources
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

OrderItemReturnEnum

Inventarisatie

Beschrijft of het orderitem retourneert of niet.

Waarde	Description
NotReturnable	Orderitem kan niet worden geretourneerd.
Returnable	Orderitem kan zonder kosten worden geretourneerd.
ReturnableWithFee	Orderitem kan worden geretourneerd met kosten.

OrderItemType

Inventarisatie

Orderitemtype.

Waarde	Description
Purchase	Inkooporderitem.
Rental	HuurorderItem.

OrderItemUpdateParameter

Object

Hiermee worden orderitemparameters bijgewerkt.

Name	Type	Description
properties.forwardAddress	AddressProperties	Hiermee worden het verzendadres en contactgegevens bijgewerkt.
properties.notificationEmailList	string[]	Aanvullende lijst met e-mailmeldingen.
properties.preferences	Preferences	Klantvoorkeur.
tags	object	De lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt voor het weergeven en groeperen van deze resource (tussen resourcegroepen).

Preferences

Object

Voorkeuren met betrekking tot de bestelling

Name	Type	Description
encryptionPreferences	EncryptionPreferences	Voorkeuren met betrekking tot de versleuteling.
managementResourcePreferences	ManagementResourcePreferences	Voorkeuren met betrekking tot de beheerresource.
notificationPreferences	NotificationPreference[]	Berichtgevingsvoorkeuren.
transportPreferences	TransportPreferences	Voorkeuren met betrekking tot de logistiek van de verzending van de bestelling.

ProductDetails

Object

Vertegenwoordigt productdetails

Name	Type	Description
count	integer (int32)	Hoeveelheid van het product
deviceDetails	DeviceDetails[]	lijst met apparaatdetails
displayInfo	DisplayInfo	Details van het product weergeven
hierarchyInformation	HierarchyInformation	Hiërarchie van het product dat het product uniek identificeert
productDoubleEncryptionStatus	DoubleEncryptionStatus	Dubbele versleutelingsstatus van de configuratie. Alleen-lezenveld.

ResourceProviderDetails

Object

Details van beheer-RP

Name	Type	Description
resourceProviderNamespace	string	Naamruimte van resourceprovider

ReverseShippingDetails

Object

Details van omgekeerde verzending.

Name	Type	Description
carrierDisplayName	string	Naam van de provider voor weergavedoeleinden. Niet te gebruiken voor verwerking.
carrierName	string	Naam van de vervoerder.
sasKeyForLabel	string	SAS-sleutel om het label voor omgekeerde verzending van het pakket te downloaden.
trackingId	string	TrackingId van het pakket
trackingUrl	string	TrackingUrl van het pakket.

ShippingAddress

Object

Verzendadres waar de klant het apparaat wil ontvangen.

Name	Type	Description
addressType	AddressType	Type adres.
city	string	Naam van de stad.
companyName	string	Naam van het bedrijf.
country	string	Naam van het land.
postalCode	string	Postcode.
stateOrProvince	string	Naam van de staat of provincie.
streetAddress1	string	Adresregel 1.
streetAddress2	string	Adresregel 2.
streetAddress3	string	Adresregel 3.
zipExtendedCode	string	Uitgebreide postcode.

StageDetails

Object

Details van resourcefase.

Name	Type	Description
displayName	string	Weergavenaam van de resourcefase.
stageName	StageName	Fasenaam
stageStatus	StageStatus	Fasestatus.
startTime	string (date-time)	Begintijd van fase

StageName

Inventarisatie

Fasenaam

Waarde	Description
Cancelled	De bestelling is geannuleerd.
Confirmed	Bestelling wordt bevestigd
Delivered	Bestelling wordt aan de klant geleverd
InReview	Bestelling bevindt zich momenteel in de conceptmodus en kan nog steeds worden geannuleerd
InUse	Bestelling wordt gebruikt op de klantsite
Placed	Momenteel in conceptmodus en kan nog steeds worden geannuleerd
ReadyToShip	Bestelling is gereed voor verzending
ReturnCompleted	Return is nu voltooid.
ReturnInitiated	Return is geïnitieerd door de klant.
ReturnPickedUp	Bestelling is onderweg van klant naar Microsoft.
ReturnedToMicrosoft	Bestelling is teruggestuurd naar Microsoft.
Shipped	Bestelling is onderweg naar klant

StageStatus

Inventarisatie

Fasestatus.

Waarde	Description
Cancelled	Fase is geannuleerd.
Cancelling	Fase wordt geannuleerd.
Failed	Fase is mislukt.
InProgress	Fase wordt uitgevoerd.
None	Er is nog geen status beschikbaar.
Succeeded	De fase is geslaagd.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

TransportPreferences

Object

Voorkeuren met betrekking tot de verzendingslogistiek van de sKU

Name	Type	Description
preferredShipmentType	TransportShipmentTypes	Hiermee wordt het type Verzendingslogistiek aangegeven dat de klant de voorkeur heeft gegeven.

TransportShipmentTypes

Inventarisatie

Hiermee wordt het type Verzendingslogistiek aangegeven dat de klant de voorkeur heeft gegeven.

Waarde	Description
CustomerManaged	Verzendingslogistiek wordt afgehandeld door de klant.
MicrosoftManaged	Verzendingslogistiek wordt afgehandeld door Microsoft.

Delen via

Update Order Item - Update Order Item

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

UpdateOrderItem

Voorbeeldaanvraag

Voorbeeldrespons

Definities

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