Update Order Item - Update Order Item

Tjänst:: Edge Hardware Center

API-version:: 2021-12-01

Uppdaterar egenskaperna för ett befintligt orderobjekt.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
orderItemName	path	True	string	Namnet på orderobjektet
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
If-Match		string	Definierar villkoret If-Match. Korrigeringen utförs endast om ETag för ordningen på servern matchar det här värdet.

Begärandetext

Name	Typ	Description
properties.forwardAddress	AddressProperties	Uppdaterar vidarebefordran av leveransadress och kontaktuppgifter.
properties.notificationEmailList	string[]	Ytterligare e-postlista för meddelanden.
properties.preferences	Preferences	Kundinställningar.
tags	object	Listan över nyckelvärdepar som beskriver resursen. Dessa taggar kan användas för att visa och gruppera den här resursen (mellan resursgrupper).

Svar

Name	Typ	Description
200 OK	OrderItemResource	Orderobjektets resursobjekt.
202 Accepted		Godkänd begäran om uppdatering av orderobjekt.
Other Status Codes	ErrorResponse	Felsvar som beskriver orsaken till åtgärdsfel.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

UpdateOrderItem

Exempelbegäran

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

Exempelsvar

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

Statuskod:: 202

Definitioner

Name	Description
ActionStatusEnum	Beskriver om orderobjektet kan tas bort eller inte.
AddressDetails	Adressinformation för ett orderobjekt.
AddressProperties	Adressegenskaper
AddressType	Typ av adress.
AddressValidationStatus	Status för adressverifiering
ContactDetails	Kontaktuppgifter.
createdByType	Den typ av identitet som skapade resursen.
DeviceDetails	Enhetsinformation.
DisplayInfo	Beskriver information om produktvisning
DoubleEncryptionStatus	Dubbel krypteringsstatus som angetts av kunden. Det är obligatoriskt att ge den här parametern om principen Neka eller Inaktiverad har konfigurerats.
EncryptionPreferences	Inställningar relaterade till dubbelkryptering
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ForwardShippingDetails	Vidarebefordra leveransinformation.
HierarchyInformation	Innehåller information om produkthierarkiinformation
ManagementResourcePreferences	Inställningar för hanteringsresurser för att länka enhet
NotificationPreference	Meddelandeinställning för ett jobbsteg.
NotificationStageName	Namnet på fasen.
OrderItemCancellationEnum	Beskriver om beställningsobjektet kan vara kancellable eller inte.
OrderItemDetails	Information om beställningsobjekt
OrderItemResource	Representerar orderartikelkontrakt
OrderItemReturnEnum	Beskriver om orderobjektet kan returneras eller inte.
OrderItemType	Orderartikeltyp.
OrderItemUpdateParameter	Uppdaterar orderobjektparametrar.
Preferences	Inställningar relaterade till ordern
ProductDetails	Representerar produktinformation
ResourceProviderDetails	Hanterings-RP-information
ReverseShippingDetails	Information om omvänd leverans.
ShippingAddress	Leveransadress där kunden vill ta emot enheten.
StageDetails	Information om resurssteg.
StageName	Namn på stadium
StageStatus	Status för fas.
systemData	Metadata som rör skapande och senaste ändring av resursen.
TransportPreferences	Inställningar relaterade till leveranslogistiken för sku:n
TransportShipmentTypes	Anger typ av leveranslogistik som kunden föredrar.

ActionStatusEnum

Uppräkning

Beskriver om orderobjektet kan tas bort eller inte.

Värde	Description
Allowed	Tillåten flagga.
NotAllowed	Flaggan Tillåts inte.

AddressDetails

Objekt

Adressinformation för ett orderobjekt.

Name	Typ	Description
forwardAddress	AddressProperties	Kundadress och kontaktuppgifter. Det bör vara adressresurs
returnAddress	AddressProperties	Returleveransadress

AddressProperties

Objekt

Adressegenskaper

Name	Typ	Description
addressValidationStatus	AddressValidationStatus	Status för adressverifiering
contactDetails	ContactDetails	Kontaktuppgifter för adressen
shippingAddress	ShippingAddress	Leveransinformation för adressen

AddressType

Uppräkning

Typ av adress.

Värde	Description
None	Adresstypen är inte känd.
Residential	Bostadsadress.
Commercial	Kommersiell adress.

AddressValidationStatus

Uppräkning

Status för adressverifiering

Värde	Description
Valid	Den angivna adressen är giltig.
Invalid	Den angivna adressen är ogiltig eller stöds inte.
Ambiguous	Den angivna adressen är tvetydig. Välj en av de alternativa adresser som returneras.

ContactDetails

Objekt

Kontaktuppgifter.

Name	Typ	Description
contactName	string	Personens kontaktnamn.
emailList	string[]	Lista över e-post-ID:er som ska meddelas om jobbförloppet.
mobile	string	Kontaktpersonens mobilnummer.
phone	string	Kontaktpersonens telefonnummer.
phoneExtension	string	Telefonnummer till kontaktpersonen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

DeviceDetails

Objekt

Enhetsinformation.

Name	Typ	Description
managementResourceId	string	Resurs-ID för hantering
managementResourceTenantId	string	Klient-ID för hanteringsresurs
serialNumber	string	enhetens serienummer

DisplayInfo

Objekt

Beskriver information om produktvisning

Name	Typ	Description
configurationDisplayName	string	Visningsnamn för konfiguration
productFamilyDisplayName	string	Visningsnamn för produktfamilj

DoubleEncryptionStatus

Uppräkning

Dubbel krypteringsstatus som angetts av kunden. Det är obligatoriskt att ge den här parametern om principen Neka eller Inaktiverad har konfigurerats.

Värde	Description
Disabled	Dubbel kryptering är inaktiverat
Enabled	Dubbel kryptering är aktiverat

EncryptionPreferences

Objekt

Inställningar relaterade till dubbelkryptering

Name	Typ	Description
doubleEncryptionStatus	DoubleEncryptionStatus	Dubbel krypteringsstatus som angetts av kunden. Det är obligatoriskt att ge den här parametern om principen Neka eller Inaktiverad har konfigurerats.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ForwardShippingDetails

Objekt

Vidarebefordra leveransinformation.

Name	Typ	Description
carrierDisplayName	string	Bärarnamn för visningsändamål. Ska inte användas för bearbetning.
carrierName	string	Namnet på transportören.
trackingId	string	TrackingId för paketet
trackingUrl	string	TrackingUrl för paketet.

HierarchyInformation

Objekt

Innehåller information om produkthierarkiinformation

Name	Typ	Description
configurationName	string	Representerar konfigurationsnamn som unikt identifierar konfiguration
productFamilyName	string	Representerar produktfamiljenamn som unikt identifierar produktfamiljen
productLineName	string	Representerar produktradsnamn som unikt identifierar produktraden
productName	string	Representerar produktnamn som unikt identifierar produkten

ManagementResourcePreferences

Objekt

Inställningar för hanteringsresurser för att länka enhet

Name	Typ	Description
preferredManagementResourceId	string	Kundens föredragna ARM-ID för hanteringsresurs

NotificationPreference

Objekt

Meddelandeinställning för ett jobbsteg.

Name	Typ	Description
sendNotification	boolean	Meddelande krävs eller inte.
stageName	NotificationStageName	Namnet på fasen.

NotificationStageName

Uppräkning

Namnet på fasen.

Värde	Description
Shipped	Meddelande vid orderartikel som levereras från Microsofts datacenter.
Delivered	Meddelande vid beställningsartikel som levereras till kunden.

OrderItemCancellationEnum

Uppräkning

Beskriver om beställningsobjektet kan vara kancellable eller inte.

Värde	Description
Cancellable	Beställningsobjekt kan annulleras utan avgift.
CancellableWithFee	Beställningsartikeln kan annulleras med avgift.
NotCancellable	Det går inte att ange orderobjekt.

OrderItemDetails

Objekt

Information om beställningsobjekt

Name	Typ	Description
cancellationReason	string	Avbokningsorsak.
cancellationStatus	OrderItemCancellationEnum	Beskriver om beställningsobjektet kan vara kancellable eller inte.
currentStage	StageDetails	Aktuell orderobjektstatus
deletionStatus	ActionStatusEnum	Beskriver om orderobjektet kan tas bort eller inte.
error	ErrorDetail	Fel på toppnivå för jobbet.
forwardShippingDetails	ForwardShippingDetails	Leveransinformation för vidarebefordran av paket
managementRpDetails	ResourceProviderDetails	Överordnad RP-information – detta returnerar endast den första eller standardmässiga överordnade RP:en från hela listan
managementRpDetailsList	ResourceProviderDetails[]	Lista över överordnad RP-information som stöds för konfiguration.
notificationEmailList	string[]	Ytterligare e-postlista för meddelanden
orderItemStageHistory	StageDetails[]	Statushistorik för orderobjekt
orderItemType	OrderItemType	Orderartikeltyp.
preferences	Preferences	Inställningar för kundmeddelanden
productDetails	ProductDetails	Unik identifierare för konfiguration.
returnReason	string	Returorsak.
returnStatus	OrderItemReturnEnum	Beskriver om orderobjektet kan returneras eller inte.
reverseShippingDetails	ReverseShippingDetails	Leveransinformation för omvänd paket

OrderItemResource

Objekt

Representerar orderartikelkontrakt

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.addressDetails	AddressDetails	Representerar leverans- och returadress för orderartikel
properties.orderId	string	ID för den ordning som orderartikeln tillhör
properties.orderItemDetails	OrderItemDetails	Representerar information om orderobjekt.
properties.startTime	string (date-time)	Starttid för orderobjekt
systemData	systemData	Representerar resursskapande och uppdateringstid
tags	object	Resurstaggar.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

OrderItemReturnEnum

Uppräkning

Beskriver om orderobjektet kan returneras eller inte.

Värde	Description
Returnable	Beställningsartikeln kan returneras utan avgift.
ReturnableWithFee	Beställningsartikeln kan returneras med avgift.
NotReturnable	Orderobjektet kan inte returneras.

OrderItemType

Uppräkning

Orderartikeltyp.

Värde	Description
Purchase	Köp OrderItem.
Rental	Hyra OrderItem.

OrderItemUpdateParameter

Objekt

Uppdaterar orderobjektparametrar.

Name	Typ	Description
properties.forwardAddress	AddressProperties	Uppdaterar vidarebefordran av leveransadress och kontaktuppgifter.
properties.notificationEmailList	string[]	Ytterligare e-postlista för meddelanden.
properties.preferences	Preferences	Kundinställningar.
tags	object	Listan över nyckelvärdepar som beskriver resursen. Dessa taggar kan användas för att visa och gruppera den här resursen (mellan resursgrupper).

Preferences

Objekt

Inställningar relaterade till ordern

Name	Typ	Description
encryptionPreferences	EncryptionPreferences	Inställningar som är relaterade till krypteringen.
managementResourcePreferences	ManagementResourcePreferences	Inställningar relaterade till hanteringsresursen.
notificationPreferences	NotificationPreference[]	Meddelandeinställningar.
transportPreferences	TransportPreferences	Inställningar relaterade till leveranslogistiken för ordern.

ProductDetails

Objekt

Representerar produktinformation

Name	Typ	Description
count	integer (int32)	Produktens kvantitet
deviceDetails	DeviceDetails[]	lista över enhetsinformation
displayInfo	DisplayInfo	Visa information om produkten
hierarchyInformation	HierarchyInformation	Hierarki för den produkt som unikt identifierar produkten
productDoubleEncryptionStatus	DoubleEncryptionStatus	Dubbel krypteringsstatus för konfigurationen. Skrivskyddat fält.

ResourceProviderDetails

Objekt

Hanterings-RP-information

Name	Typ	Description
resourceProviderNamespace	string	Namnområde för resursprovider

ReverseShippingDetails

Objekt

Information om omvänd leverans.

Name	Typ	Description
carrierDisplayName	string	Bärarnamn för visningsändamål. Ska inte användas för bearbetning.
carrierName	string	Namnet på transportören.
sasKeyForLabel	string	SAS-nyckel för att ladda ned paketets etikett för omvänd leverans.
trackingId	string	TrackingId för paketet
trackingUrl	string	TrackingUrl för paketet.

ShippingAddress

Objekt

Leveransadress där kunden vill ta emot enheten.

Name	Typ	Description
addressType	AddressType	Typ av adress.
city	string	Namnet på staden.
companyName	string	Företagets namn.
country	string	Namnet på landet.
postalCode	string	Postnummer.
stateOrProvince	string	Namnet på delstaten eller provinsen.
streetAddress1	string	Gatuadress rad 1.
streetAddress2	string	Gatuadress, rad 2.
streetAddress3	string	Gatuadress rad 3.
zipExtendedCode	string	Utökat postnummer.

StageDetails

Objekt

Information om resurssteg.

Name	Typ	Description
displayName	string	Visningsnamn för resurssteget.
stageName	StageName	Namn på stadium
stageStatus	StageStatus	Status för fas.
startTime	string (date-time)	Starttid för fas

StageName

Uppräkning

Namn på stadium

Värde	Description
Placed	För närvarande i utkastläge och kan fortfarande avbrytas
InReview	Beställningen är för närvarande i utkastläge och kan fortfarande avbrytas
Confirmed	Beställningen bekräftas
ReadyToShip	Beställningen är klar att skickas
Shipped	Beställningen överförs till kunden
Delivered	Beställningen levereras till kunden
InUse	Beställningen används på kundens webbplats
ReturnInitiated	Returen har initierats av kunden.
ReturnPickedUp	Beställningen överförs från kunden till Microsoft.
ReturnedToMicrosoft	Beställningen har mottagits tillbaka till Microsoft.
ReturnCompleted	Returen har nu slutförts.
Cancelled	Beställningen har avbrutits.

StageStatus

Uppräkning

Status för fas.

Värde	Description
None	Ingen status är tillgänglig än.
InProgress	Fasen pågår.
Succeeded	Fasen har slutförts.
Failed	Fasen misslyckades.
Cancelled	Fasen har avbrutits.
Cancelling	Fasen avbryts.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

TransportPreferences

Objekt

Inställningar relaterade till leveranslogistiken för sku:n

Name	Typ	Description
preferredShipmentType	TransportShipmentTypes	Anger typ av leveranslogistik som kunden föredrar.

TransportShipmentTypes

Uppräkning

Anger typ av leveranslogistik som kunden föredrar.

Värde	Description
CustomerManaged	Leveranslogistik hanteras av kunden.
MicrosoftManaged	Leveranslogistik hanteras av Microsoft.

Dela via

Update Order Item - Update Order Item

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

UpdateOrderItem

Exempelbegäran

Exempelsvar

Definitioner

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