Update Order Item - Update Order Item

Hizmet:: Edge Hardware Center

API Sürümü:: 2021-12-01

Mevcut sipariş öğesinin özelliklerini güncelleştirir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
orderItemName	path	True	string	Sipariş öğesinin adı
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
subscriptionId	path	True	string minLength: 1	Hedef aboneliğin kimliği.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
If-Match		string	If-Match koşulunu tanımlar. Düzeltme eki yalnızca sunucudaki sıranın ETag değeri bu değerle eşleşiyorsa gerçekleştirilir.

İstek Gövdesi

Name	Tür	Description
properties.forwardAddress	AddressProperties	Güncelleştirmeler sevkiyat adresini ve iletişim bilgilerini iletir.
properties.notificationEmailList	string[]	Ek bildirim e-posta listesi.
properties.preferences	Preferences	Müşteri tercihi.
tags	object	Kaynağı açıklayan anahtar değer çiftlerinin listesi. Bu etiketler, bu kaynağı görüntülemek ve gruplandırırken (kaynak grupları arasında) kullanılabilir.

Yanıtlar

Name	Tür	Description
200 OK	OrderItemResource	Sipariş öğesi kaynak nesnesi.
202 Accepted		Sipariş öğesi güncelleştirmesi için kabul edilen istek.
Other Status Codes	ErrorResponse	İşlem hatasının nedenini açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

UpdateOrderItem

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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"
}

Durum kodu:: 202

Tanımlar

Name	Description
ActionStatusEnum	Sipariş öğesinin seçilebilir olup olmadığını açıklar.
AddressDetails	Bir sipariş öğesinin adres ayrıntıları.
AddressProperties	Adres Özellikleri
AddressType	Adres türü.
AddressValidationStatus	Adres doğrulama durumu
ContactDetails	İletişim Ayrıntıları.
createdByType	Kaynağı oluşturan kimliğin türü.
DeviceDetails	Cihaz ayrıntıları.
DisplayInfo	Ürün görüntüleme bilgilerini açıklar
DoubleEncryptionStatus	Müşteri tarafından girilen çift şifreleme durumu. 'Reddet' veya 'Devre Dışı' ilkesi yapılandırıldıysa bu parametrenin verilmesi zorunludur.
EncryptionPreferences	Çift şifreleme ile ilgili tercihler
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
ForwardShippingDetails	Sevkiyat ayrıntılarını iletin.
HierarchyInformation	Ürün hiyerarşisi bilgileriyle ilgili ayrıntıları tutar
ManagementResourcePreferences	Cihazı bağlamak için yönetim kaynağı tercihi
NotificationPreference	İş aşaması için bildirim tercihi.
NotificationStageName	Aşamanın adı.
OrderItemCancellationEnum	Sipariş öğesinin iptal edilebilir olup olmadığını açıklar.
OrderItemDetails	Sipariş öğesi ayrıntıları
OrderItemResource	Sipariş öğesi sözleşmesini temsil eder
OrderItemReturnEnum	Sipariş öğesinin iade edilebilir olup olmadığını açıklar.
OrderItemType	Sipariş öğesi türü.
OrderItemUpdateParameter	Sipariş öğesi parametrelerini güncelleştirir.
Preferences	Siparişle ilgili tercihler
ProductDetails	Ürün ayrıntılarını temsil eder
ResourceProviderDetails	Yönetim RP ayrıntıları
ReverseShippingDetails	Ters sevkiyat ayrıntıları.
ShippingAddress	Müşterinin cihazı almak istediği sevkiyat adresi.
StageDetails	Kaynak aşaması ayrıntıları.
StageName	Aşama adı
StageStatus	Aşama durumu.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
TransportPreferences	SKU'nun sevkiyat lojisti ile ilgili tercihler
TransportShipmentTypes	Müşterinin tercih ettiği Sevkiyat Lojisti türünü gösterir.

ActionStatusEnum

Listeleme

Sipariş öğesinin seçilebilir olup olmadığını açıklar.

Değer	Description
Allowed	İzin verilen bayrağı.
NotAllowed	İzin Verilmiyor bayrağı.

AddressDetails

Object

Bir sipariş öğesinin adres ayrıntıları.

Name	Tür	Description
forwardAddress	AddressProperties	Müşteri adresi ve iletişim bilgileri. Adres kaynağı olmalıdır
returnAddress	AddressProperties	İade sevkiyat adresi

AddressProperties

Object

Adres Özellikleri

Name	Tür	Description
addressValidationStatus	AddressValidationStatus	Adres doğrulama durumu
contactDetails	ContactDetails	Adres için iletişim bilgileri
shippingAddress	ShippingAddress	Adres için sevkiyat ayrıntıları

AddressType

Listeleme

Adres türü.

Değer	Description
None	Adres türü bilinmiyor.
Residential	Konut Adresi.
Commercial	Ticari Adres.

AddressValidationStatus

Listeleme

Adres doğrulama durumu

Değer	Description
Valid	Sağlanan adres geçerli.
Invalid	Sağlanan adres geçersiz veya desteklenmiyor.
Ambiguous	Sağlanan adres belirsiz, lütfen döndürülen alternatif adreslerden birini seçin.

ContactDetails

Object

İletişim Ayrıntıları.

Name	Tür	Description
contactName	string	Kişinin kişi adı.
emailList	string[]	İş ilerleme durumu hakkında bilgilendirilecek e-posta kimliklerinin listesi.
mobile	string	İlgili kişinin cep telefonu numarası.
phone	string	İlgili kişinin telefon numarası.
phoneExtension	string	İlgili kişinin telefon dahili numarası.

createdByType

Listeleme

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

DeviceDetails

Object

Cihaz ayrıntıları.

Name	Tür	Description
managementResourceId	string	Yönetim Kaynak Kimliği
managementResourceTenantId	string	Yönetim Kaynağı Kiracı Kimliği
serialNumber	string	cihaz seri numarası

DisplayInfo

Object

Ürün görüntüleme bilgilerini açıklar

Name	Tür	Description
configurationDisplayName	string	Yapılandırma görünen adı
productFamilyDisplayName	string	Ürün ailesi görünen adı

DoubleEncryptionStatus

Listeleme

Müşteri tarafından girilen çift şifreleme durumu. 'Reddet' veya 'Devre Dışı' ilkesi yapılandırıldıysa bu parametrenin verilmesi zorunludur.

Değer	Description
Disabled	Çift şifreleme devre dışı bırakıldı
Enabled	Çift şifreleme etkinleştirildi

EncryptionPreferences

Object

Çift şifreleme ile ilgili tercihler

Name	Tür	Description
doubleEncryptionStatus	DoubleEncryptionStatus	Müşteri tarafından girilen çift şifreleme durumu. 'Reddet' veya 'Devre Dışı' ilkesi yapılandırıldıysa bu parametrenin verilmesi zorunludur.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

ForwardShippingDetails

Object

Sevkiyat ayrıntılarını iletin.

Name	Tür	Description
carrierDisplayName	string	Görüntüleme amacıyla Taşıyıcı Adı. Herhangi bir işlem için kullanılmamalıdır.
carrierName	string	Taşıyıcının adı.
trackingId	string	Paketin TrackingId değeri
trackingUrl	string	Paketin TrackingUrl.

HierarchyInformation

Object

Ürün hiyerarşisi bilgileriyle ilgili ayrıntıları tutar

Name	Tür	Description
configurationName	string	Yapılandırmayı benzersiz olarak tanımlayan yapılandırma adını temsil eder
productFamilyName	string	Ürün ailesini benzersiz olarak tanımlayan ürün ailesi adını temsil eder
productLineName	string	Ürün satırını benzersiz olarak tanımlayan ürün satırı adını temsil eder
productName	string	Ürünü benzersiz olarak tanımlayan ürün adını temsil eder

ManagementResourcePreferences

Object

Cihazı bağlamak için yönetim kaynağı tercihi

Name	Tür	Description
preferredManagementResourceId	string	Müşteri tarafından tercih edilen Yönetim kaynağı ARM Kimliği

NotificationPreference

Object

İş aşaması için bildirim tercihi.

Name	Tür	Description
sendNotification	boolean	Bildirim gerekiyor veya gerekmiyor.
stageName	NotificationStageName	Aşamanın adı.

NotificationStageName

Listeleme

Aşamanın adı.

Değer	Description
Shipped	Microsoft DataCenter'dan gönderilen sipariş öğesinde bildirim.
Delivered	Müşteriye teslim edilen sipariş öğesinde bildirim.

OrderItemCancellationEnum

Listeleme

Sipariş öğesinin iptal edilebilir olup olmadığını açıklar.

Değer	Description
Cancellable	Sipariş öğesi ücret ödemeden iptal edilebilir.
CancellableWithFee	Sipariş öğesi ücretle iptal edilebilir.
NotCancellable	Sipariş öğesi iptal edilemez.

OrderItemDetails

Object

Sipariş öğesi ayrıntıları

Name	Tür	Description
cancellationReason	string	İptal nedeni.
cancellationStatus	OrderItemCancellationEnum	Sipariş öğesinin iptal edilebilir olup olmadığını açıklar.
currentStage	StageDetails	Geçerli Sipariş öğesi Durumu
deletionStatus	ActionStatusEnum	Sipariş öğesinin seçilebilir olup olmadığını açıklar.
error	ErrorDetail	İş için üst düzey hata.
forwardShippingDetails	ForwardShippingDetails	İleri Paket Gönderim ayrıntıları
managementRpDetails	ResourceProviderDetails	Üst RP ayrıntıları - Bu, listenin tamamından yalnızca ilk veya varsayılan üst RP'yi döndürür
managementRpDetailsList	ResourceProviderDetails[]	Yapılandırma için desteklenen üst RP ayrıntılarının listesi.
notificationEmailList	string[]	Ek bildirim e-posta listesi
orderItemStageHistory	StageDetails[]	Sipariş öğesi durum geçmişi
orderItemType	OrderItemType	Sipariş öğesi türü.
preferences	Preferences	Müşteri bildirimi Tercihleri
productDetails	ProductDetails	Yapılandırma için benzersiz tanımlayıcı.
returnReason	string	İade nedeni.
returnStatus	OrderItemReturnEnum	Sipariş öğesinin iade edilebilir olup olmadığını açıklar.
reverseShippingDetails	ReverseShippingDetails	Ters Paket Gönderimi ayrıntıları

OrderItemResource

Object

Sipariş öğesi sözleşmesini temsil eder

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Kaynağın bulunduğu coğrafi konum
name	string	Kaynağın adı
properties.addressDetails	AddressDetails	Sipariş öğesinin sevkiyat ve iade adresini temsil eder
properties.orderId	string	Sipariş öğesinin ait olduğu siparişin kimliği
properties.orderItemDetails	OrderItemDetails	Sipariş öğesi ayrıntılarını temsil eder.
properties.startTime	string (date-time)	Sipariş öğesinin başlangıç saati
systemData	systemData	Kaynak oluşturma ve güncelleştirme süresini temsil eder
tags	object	Kaynak etiketleri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

OrderItemReturnEnum

Listeleme

Sipariş öğesinin iade edilebilir olup olmadığını açıklar.

Değer	Description
Returnable	Sipariş öğesi ücret ödemeden iade edilebilir.
ReturnableWithFee	Sipariş öğesi ücretle iade edilebilir.
NotReturnable	Sipariş öğesi iade edilemez.

OrderItemType

Listeleme

Sipariş öğesi türü.

Değer	Description
Purchase	OrderItem satın alın.
Rental	Kiralık OrderItem.

OrderItemUpdateParameter

Object

Sipariş öğesi parametrelerini güncelleştirir.

Name	Tür	Description
properties.forwardAddress	AddressProperties	Güncelleştirmeler sevkiyat adresini ve iletişim bilgilerini iletir.
properties.notificationEmailList	string[]	Ek bildirim e-posta listesi.
properties.preferences	Preferences	Müşteri tercihi.
tags	object	Kaynağı açıklayan anahtar değer çiftlerinin listesi. Bu etiketler, bu kaynağı görüntülemek ve gruplandırırken (kaynak grupları arasında) kullanılabilir.

Preferences

Object

Siparişle ilgili tercihler

Name	Tür	Description
encryptionPreferences	EncryptionPreferences	Şifreleme ile ilgili tercihler.
managementResourcePreferences	ManagementResourcePreferences	Yönetim kaynağıyla ilgili tercihler.
notificationPreferences	NotificationPreference[]	Bildirim tercihleri.
transportPreferences	TransportPreferences	Siparişin sevkiyat lojisti ile ilgili tercihler.

ProductDetails

Object

Ürün ayrıntılarını temsil eder

Name	Tür	Description
count	integer (int32)	Ürünün miktarı
deviceDetails	DeviceDetails[]	cihaz ayrıntıları listesi
displayInfo	DisplayInfo	Ürünün ayrıntılarını görüntüleme
hierarchyInformation	HierarchyInformation	Ürünü benzersiz olarak tanımlayan ürünün hiyerarşisi
productDoubleEncryptionStatus	DoubleEncryptionStatus	Yapılandırmanın çift şifreleme durumu. Salt okunur alan.

ResourceProviderDetails

Object

Yönetim RP ayrıntıları

Name	Tür	Description
resourceProviderNamespace	string	Kaynak sağlayıcısı ad alanı

ReverseShippingDetails

Object

Ters sevkiyat ayrıntıları.

Name	Tür	Description
carrierDisplayName	string	Görüntüleme amacıyla Taşıyıcı Adı. Herhangi bir işlem için kullanılmamalıdır.
carrierName	string	Taşıyıcının adı.
sasKeyForLabel	string	Paketin ters sevkiyat etiketini indirmek için SAS anahtarı.
trackingId	string	Paketin TrackingId değeri
trackingUrl	string	Paketin TrackingUrl.

ShippingAddress

Object

Müşterinin cihazı almak istediği sevkiyat adresi.

Name	Tür	Description
addressType	AddressType	Adres türü.
city	string	Şehrin adı.
companyName	string	Şirketin adı.
country	string	Ülke adı.
postalCode	string	Posta kodu.
stateOrProvince	string	Eyalet veya İl adı.
streetAddress1	string	Sokak Adresi satırı 1.
streetAddress2	string	Sokak Adresi satırı 2.
streetAddress3	string	Sokak Adresi satırı 3.
zipExtendedCode	string	Genişletilmiş Posta Kodu.

StageDetails

Object

Kaynak aşaması ayrıntıları.

Name	Tür	Description
displayName	string	Kaynak aşamasının görünen adı.
stageName	StageName	Aşama adı
stageStatus	StageStatus	Aşama durumu.
startTime	string (date-time)	Aşama başlangıç zamanı

StageName

Listeleme

Aşama adı

Değer	Description
Placed	Şu anda taslak modunda ve hala iptal edilebilir
InReview	Sipariş şu anda taslak modunda ve iptal edilebilir
Confirmed	Sipariş onaylandı
ReadyToShip	Sipariş göndermeye hazır
Shipped	Sipariş müşteriye aktarılıyor
Delivered	Sipariş müşteriye teslim edildi
InUse	Sipariş müşteri sitesinde kullanılıyor
ReturnInitiated	İade müşteri tarafından başlatıldı.
ReturnPickedUp	Sipariş müşteriden microsoft'a aktarılıyor.
ReturnedToMicrosoft	Sipariş microsoft'a geri alındı.
ReturnCompleted	İade işlemi tamamlandı.
Cancelled	Sipariş iptal edildi.

StageStatus

Listeleme

Aşama durumu.

Değer	Description
None	Henüz kullanılabilir durum yok.
InProgress	Aşama devam ediyor.
Succeeded	Aşama başarılı oldu.
Failed	Aşama başarısız oldu.
Cancelled	Aşama iptal edildi.
Cancelling	Aşama iptal edildi.

systemData

Object

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.

TransportPreferences

Object

SKU'nun sevkiyat lojisti ile ilgili tercihler

Name	Tür	Description
preferredShipmentType	TransportShipmentTypes	Müşterinin tercih ettiği Sevkiyat Lojisti türünü gösterir.

TransportShipmentTypes

Listeleme

Müşterinin tercih ettiği Sevkiyat Lojisti türünü gösterir.

Değer	Description
CustomerManaged	Sevkiyat Lojisti müşteri tarafından işlenir.
MicrosoftManaged	Sevkiyat Lojisti microsoft tarafından işlenir.

Aracılığıyla paylaş

Update Order Item - Update Order Item

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

UpdateOrderItem

Örnek isteği

Örnek yanıt

Tanımlar

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