Update Order Item - Update Order Item

Služba:: Edge Hardware Center

Verze rozhraní API:: 2021-12-01

Aktualizuje vlastnosti existující položky objednávky.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
orderItemName	path	True	string	Název položky objednávky
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match		string	Definuje podmínku If-Match. Oprava bude provedena pouze v případě, že ETag objednávky na serveru odpovídá této hodnotě.

Text požadavku

Name	Typ	Description
properties.forwardAddress	AddressProperties	Aktualizuje dodací adresu a kontaktní údaje.
properties.notificationEmailList	string[]	Další seznam e-mailových oznámení
properties.preferences	Preferences	Předvolba zákazníka.
tags	object	Seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupování tohoto prostředku (napříč skupinami prostředků).

Odpovědi

Name	Typ	Description
200 OK	OrderItemResource	Objednejte si položku prostředku objektu.
202 Accepted		Přijatá žádost o aktualizaci položky objednávky
Other Status Codes	ErrorResponse	Odpověď na chybu popisující důvod selhání operace

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

UpdateOrderItem

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
}

Stavový kód:: 202

Definice

Name	Description
ActionStatusEnum	Popisuje, jestli je položka objednávky deletovatelná nebo ne.
AddressDetails	Podrobnosti adresy pro položku objednávky
AddressProperties	Vlastnosti adresy
AddressType	Typ adresy.
AddressValidationStatus	Stav ověření adresy
ContactDetails	Kontaktní údaje.
createdByType	Typ identity, která prostředek vytvořila.
DeviceDetails	Podrobnosti o zařízení.
DisplayInfo	Popisuje informace o zobrazení produktu.
DoubleEncryptionStatus	Stav dvojitého šifrování zadaný zákazníkem. Tento parametr je povinný dát, pokud je nakonfigurovaná zásada Odepření nebo Zakázáno.
EncryptionPreferences	Předvolby související s dvojitým šifrováním
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ForwardShippingDetails	Podrobnosti o expedici.
HierarchyInformation	Obsahuje podrobnosti o informacích o hierarchii produktů.
ManagementResourcePreferences	Předvolba prostředků správy pro propojení zařízení
NotificationPreference	Předvolba oznámení pro fázi úlohy
NotificationStageName	Název fáze
OrderItemCancellationEnum	Popisuje, jestli je položka objednávky zrušená nebo ne.
OrderItemDetails	Podrobnosti o položce objednávky
OrderItemResource	Představuje kontrakt položky objednávky.
OrderItemReturnEnum	Popisuje, jestli je položka objednávky vrácená, nebo ne.
OrderItemType	Typ položky objednávky.
OrderItemUpdateParameter	Aktualizuje parametry položky objednávky.
Preferences	Předvolby související s objednávkou
ProductDetails	Představuje podrobnosti o produktu.
ResourceProviderDetails	Podrobnosti o poskytovateli žádostí o správu
ReverseShippingDetails	Podrobnosti o zpětné zásilce.
ShippingAddress	Dodací adresa, kde zákazník chce zařízení obdržet.
StageDetails	Podrobnosti fáze zdroje
StageName	Název fáze
StageStatus	Stav fáze
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
TransportPreferences	Předvolby související s logistikou zásilek skladové položky
TransportShipmentTypes	Označuje typ logistiky zásilky, který zákazník preferoval.

ActionStatusEnum

Výčet

Popisuje, jestli je položka objednávky deletovatelná nebo ne.

Hodnota	Description
Allowed	Povolený příznak.
NotAllowed	Příznak Není povolený.

AddressDetails

Objekt

Podrobnosti adresy pro položku objednávky

Name	Typ	Description
forwardAddress	AddressProperties	Adresa zákazníka a kontaktní údaje. Měl by být adresní prostředek.
returnAddress	AddressProperties	Zpáteční dodací adresa

AddressProperties

Objekt

Vlastnosti adresy

Name	Typ	Description
addressValidationStatus	AddressValidationStatus	Stav ověření adresy
contactDetails	ContactDetails	Kontaktní údaje pro adresu
shippingAddress	ShippingAddress	Podrobnosti o expedici adresy

AddressType

Výčet

Typ adresy.

Hodnota	Description
None	Typ adresy není znám.
Residential	Adresa bydliště.
Commercial	Komerční adresa.

AddressValidationStatus

Výčet

Stav ověření adresy

Hodnota	Description
Valid	Zadaná adresa je platná.
Invalid	Zadanou adresu je neplatná nebo není podporována.
Ambiguous	Zadaná adresa je nejednoznačná, zvolte jednu z vrácených alternativních adres.

ContactDetails

Objekt

Kontaktní údaje.

Name	Typ	Description
contactName	string	Jméno kontaktu osoby.
emailList	string[]	Seznam ID e-mailů, které se mají informovat o průběhu úlohy
mobile	string	Číslo mobilního kontaktu.
phone	string	Telefonní číslo kontaktní osoby.
phoneExtension	string	Telefonní číslo linky kontaktní osoby.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DeviceDetails

Objekt

Podrobnosti o zařízení.

Name	Typ	Description
managementResourceId	string	ID prostředku správy
managementResourceTenantId	string	ID tenanta prostředku správy
serialNumber	string	sériové číslo zařízení

DisplayInfo

Objekt

Popisuje informace o zobrazení produktu.

Name	Typ	Description
configurationDisplayName	string	Zobrazovaný název konfigurace
productFamilyDisplayName	string	Zobrazované jméno produktové řady

DoubleEncryptionStatus

Výčet

Stav dvojitého šifrování zadaný zákazníkem. Tento parametr je povinný dát, pokud je nakonfigurovaná zásada Odepření nebo Zakázáno.

Hodnota	Description
Disabled	Dvojité šifrování je zakázané.
Enabled	Dvojité šifrování je povolené.

EncryptionPreferences

Objekt

Předvolby související s dvojitým šifrováním

Name	Typ	Description
doubleEncryptionStatus	DoubleEncryptionStatus	Stav dvojitého šifrování zadaný zákazníkem. Tento parametr je povinný dát, pokud je nakonfigurovaná zásada Odepření nebo Zakázáno.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ForwardShippingDetails

Objekt

Podrobnosti o expedici.

Name	Typ	Description
carrierDisplayName	string	Název dopravce pro účely zobrazení. Nepoužívá se k žádnému zpracování.
carrierName	string	Jméno dopravce.
trackingId	string	TrackingId balíčku
trackingUrl	string	TrackingUrl balíčku.

HierarchyInformation

Objekt

Obsahuje podrobnosti o informacích o hierarchii produktů.

Name	Typ	Description
configurationName	string	Představuje název konfigurace, který jedinečně identifikuje konfiguraci.
productFamilyName	string	Představuje název produktové řady, který jednoznačně identifikuje řadu produktů.
productLineName	string	Představuje název produktové řady, který jednoznačně identifikuje produktovou řadu.
productName	string	Představuje název produktu, který jednoznačně identifikuje produkt.

ManagementResourcePreferences

Objekt

Předvolba prostředků správy pro propojení zařízení

Name	Typ	Description
preferredManagementResourceId	string	ID ARM upřednostňovaného prostředku správy zákazníka

NotificationPreference

Objekt

Předvolba oznámení pro fázi úlohy

Name	Typ	Description
sendNotification	boolean	Oznámení je povinné nebo není.
stageName	NotificationStageName	Název fáze

NotificationStageName

Výčet

Název fáze

Hodnota	Description
Shipped	Oznámení o položce objednávky expedované z datacentra Microsoftu
Delivered	Oznámení o položce objednávky doručené zákazníkovi.

OrderItemCancellationEnum

Výčet

Popisuje, jestli je položka objednávky zrušená nebo ne.

Hodnota	Description
Cancellable	Položku objednávky je možné zrušit bez poplatku.
CancellableWithFee	Položku objednávky je možné zrušit s poplatkem.
NotCancellable	Položka objednávky není zrušena.

OrderItemDetails

Objekt

Podrobnosti o položce objednávky

Name	Typ	Description
cancellationReason	string	Důvod zrušení.
cancellationStatus	OrderItemCancellationEnum	Popisuje, jestli je položka objednávky zrušená nebo ne.
currentStage	StageDetails	Aktuální stav položky objednávky
deletionStatus	ActionStatusEnum	Popisuje, jestli je položka objednávky deletovatelná nebo ne.
error	ErrorDetail	Chyba nejvyšší úrovně pro úlohu
forwardShippingDetails	ForwardShippingDetails	Podrobnosti o přeposílání zásilek
managementRpDetails	ResourceProviderDetails	Podrobnosti nadřazeného poskytovatele prostředků – vrátí se pouze první nebo výchozí nadřazený poskytovatel prostředků z celého seznamu.
managementRpDetailsList	ResourceProviderDetails[]	Seznam podrobností nadřazených rp podporovaných pro konfiguraci
notificationEmailList	string[]	Seznam e-mailů s dalšími oznámeními
orderItemStageHistory	StageDetails[]	Historie stavu položky objednávky
orderItemType	OrderItemType	Typ položky objednávky.
preferences	Preferences	Předvolby oznámení zákazníka
productDetails	ProductDetails	Jedinečný identifikátor konfigurace.
returnReason	string	Vrátit důvod.
returnStatus	OrderItemReturnEnum	Popisuje, jestli je položka objednávky vrácená, nebo ne.
reverseShippingDetails	ReverseShippingDetails	Podrobnosti o zpětné dopravě balíčku

OrderItemResource

Objekt

Představuje kontrakt položky objednávky.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.addressDetails	AddressDetails	Představuje dodací a zpáteční adresu pro položku objednávky.
properties.orderId	string	ID objednávky, do které položka objednávky patří
properties.orderItemDetails	OrderItemDetails	Představuje podrobnosti položky objednávky.
properties.startTime	string (date-time)	Počáteční čas položky objednávky
systemData	systemData	Představuje čas vytvoření a aktualizace prostředku.
tags	object	Značky prostředků
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

OrderItemReturnEnum

Výčet

Popisuje, jestli je položka objednávky vrácená, nebo ne.

Hodnota	Description
Returnable	Položku objednávky lze vrátit bez poplatku.
ReturnableWithFee	Položku objednávky lze vrátit s poplatkem.
NotReturnable	Položka objednávky se nedá vrátit.

OrderItemType

Výčet

Typ položky objednávky.

Hodnota	Description
Purchase	Nákupní objednávkaPoložka.
Rental	Objednávka pronájmuPoložka.

OrderItemUpdateParameter

Objekt

Aktualizuje parametry položky objednávky.

Name	Typ	Description
properties.forwardAddress	AddressProperties	Aktualizuje dodací adresu a kontaktní údaje.
properties.notificationEmailList	string[]	Další seznam e-mailových oznámení
properties.preferences	Preferences	Předvolba zákazníka.
tags	object	Seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupování tohoto prostředku (napříč skupinami prostředků).

Preferences

Objekt

Předvolby související s objednávkou

Name	Typ	Description
encryptionPreferences	EncryptionPreferences	Předvolby související se šifrováním
managementResourcePreferences	ManagementResourcePreferences	Předvolby související s prostředkem pro správu
notificationPreferences	NotificationPreference[]	Předvolby oznámení.
transportPreferences	TransportPreferences	Předvolby týkající se logistiky zásilky objednávky.

ProductDetails

Objekt

Představuje podrobnosti o produktu.

Name	Typ	Description
count	integer (int32)	Množství výrobku
deviceDetails	DeviceDetails[]	seznam podrobností o zařízení
displayInfo	DisplayInfo	Zobrazení podrobností o produktu
hierarchyInformation	HierarchyInformation	Hierarchie produktu, který jednoznačně identifikuje produkt
productDoubleEncryptionStatus	DoubleEncryptionStatus	Stav dvojitého šifrování konfigurace. Pole jen pro čtení

ResourceProviderDetails

Objekt

Podrobnosti o poskytovateli žádostí o správu

Name	Typ	Description
resourceProviderNamespace	string	Obor názvů poskytovatele prostředků

ReverseShippingDetails

Objekt

Podrobnosti o zpětné zásilce.

Name	Typ	Description
carrierDisplayName	string	Název dopravce pro účely zobrazení. Nepoužívá se k žádnému zpracování.
carrierName	string	Jméno dopravce.
sasKeyForLabel	string	Klíč SAS pro stažení štítku zpětné zásilky balíčku.
trackingId	string	TrackingId balíčku
trackingUrl	string	TrackingUrl balíčku.

ShippingAddress

Objekt

Dodací adresa, kde zákazník chce zařízení obdržet.

Name	Typ	Description
addressType	AddressType	Typ adresy.
city	string	Název města.
companyName	string	Název společnosti.
country	string	Název země.
postalCode	string	Psč.
stateOrProvince	string	Název státu nebo provincie.
streetAddress1	string	Řádek adresy 1.
streetAddress2	string	Řádek adresy 2.
streetAddress3	string	Řádek adresy 3.
zipExtendedCode	string	Rozšířené PSČ.

StageDetails

Objekt

Podrobnosti fáze zdroje

Name	Typ	Description
displayName	string	Zobrazovaný název fáze prostředku
stageName	StageName	Název fáze
stageStatus	StageStatus	Stav fáze
startTime	string (date-time)	Čas zahájení fáze

StageName

Výčet

Název fáze

Hodnota	Description
Placed	V současné době je možné ho zrušit v režimu konceptu.
InReview	Objednávka je aktuálně v režimu konceptu a je stále možné ji zrušit.
Confirmed	Objednávka je potvrzena.
ReadyToShip	Objednávka je připravená k odeslání
Shipped	Objednávka probíhá na cestě zákazníkovi.
Delivered	Objednávka se doručí zákazníkovi.
InUse	Objednávka se používá na webu zákazníka.
ReturnInitiated	Vrácení iniciovalo zákazník.
ReturnPickedUp	Objednávka probíhá na cestě od zákazníka do Microsoftu.
ReturnedToMicrosoft	Objednávka byla přijata zpět do microsoftu.
ReturnCompleted	Vrácení se teď dokončilo.
Cancelled	Objednávka byla zrušena.

StageStatus

Výčet

Stav fáze

Hodnota	Description
None	Zatím není k dispozici žádný stav.
InProgress	Probíhá fáze.
Succeeded	Fáze byla úspěšná.
Failed	Fáze se nezdařila.
Cancelled	Fáze byla zrušena.
Cancelling	Fáze se ruší.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

TransportPreferences

Objekt

Předvolby související s logistikou zásilek skladové položky

Name	Typ	Description
preferredShipmentType	TransportShipmentTypes	Označuje typ logistiky zásilky, který zákazník preferoval.

TransportShipmentTypes

Výčet

Označuje typ logistiky zásilky, který zákazník preferoval.

Hodnota	Description
CustomerManaged	Logistika zásilek je zpracována zákazníkem.
MicrosoftManaged	Logistiku zásilek zpracovává Microsoft.

Sdílet prostřednictvím

Update Order Item - Update Order Item

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

UpdateOrderItem

Ukázkový požadavek

Ukázková odpověď

Definice

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