Update Order Item - Update Order Item

서비스:: Edge Hardware Center

API 버전:: 2021-12-01

기존 주문 항목의 속성을 업데이트합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
orderItemName	path	True	string	주문 항목의 이름입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
subscriptionId	path	True	string minLength: 1	대상 구독의 ID입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 헤더

Name	필수	형식	Description
If-Match		string	If-Match 조건을 정의합니다. 패치는 서버 주문의 ETag가 이 값과 일치하는 경우에만 수행됩니다.

요청 본문

Name	형식	Description
properties.forwardAddress	AddressProperties	전달 배송 주소 및 연락처 세부 정보를 업데이트합니다.
properties.notificationEmailList	string[]	추가 알림 전자 메일 목록입니다.
properties.preferences	Preferences	고객 기본 설정.
tags	object	리소스를 설명하는 키 값 쌍의 목록입니다. 이러한 태그는 리소스 그룹 전체에서 이 리소스를 보고 그룹화할 때 사용할 수 있습니다.

응답

Name	형식	Description
200 OK	OrderItemResource	주문 항목 리소스 개체입니다.
202 Accepted		주문 항목 업데이트 요청이 수락되었습니다.
Other Status Codes	ErrorResponse	작업 실패 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

UpdateOrderItem

샘플 요청

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

샘플 응답

상태 코드:: 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"
}

상태 코드:: 202

정의

Name	Description
ActionStatusEnum	주문 항목을 삭제할 수 있는지 여부를 설명합니다.
AddressDetails	주문 항목의 주소 세부 정보입니다.
AddressProperties	주소 속성
AddressType	주소 유형입니다.
AddressValidationStatus	주소 유효성 검사 상태
ContactDetails	연락처 세부 정보입니다.
createdByType	리소스를 만든 ID의 형식입니다.
DeviceDetails	디바이스 세부 정보.
DisplayInfo	제품 표시 정보를 설명합니다.
DoubleEncryptionStatus	고객이 입력한 이중 암호화 상태입니다. 'Deny' 또는 'Disabled' 정책이 구성된 경우 이 매개 변수를 제공해야 합니다.
EncryptionPreferences	이중 암호화와 관련된 기본 설정
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
ForwardShippingDetails	배송 세부 정보를 전달합니다.
HierarchyInformation	제품 계층 정보에 대한 세부 정보 보유
ManagementResourcePreferences	디바이스를 연결하는 관리 리소스 기본 설정
NotificationPreference	작업 단계에 대한 알림 기본 설정입니다.
NotificationStageName	스테이지의 이름입니다.
OrderItemCancellationEnum	주문 항목을 취소할 수 있는지 여부를 설명합니다.
OrderItemDetails	주문 항목 세부 정보
OrderItemResource	주문 항목 계약을 나타냅니다.
OrderItemReturnEnum	주문 항목을 반환할 수 있는지 여부를 설명합니다.
OrderItemType	주문 항목 유형입니다.
OrderItemUpdateParameter	주문 항목 매개 변수를 업데이트합니다.
Preferences	주문과 관련된 기본 설정
ProductDetails	제품 세부 정보를 나타냅니다.
ResourceProviderDetails	관리 RP 세부 정보
ReverseShippingDetails	역방향 배송 세부 정보입니다.
ShippingAddress	고객이 디바이스를 받으려는 배송 주소입니다.
StageDetails	리소스 단계 세부 정보입니다.
StageName	스테이지 이름
StageStatus	스테이지 상태입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
TransportPreferences	SKU의 배송 물류와 관련된 기본 설정
TransportShipmentTypes	고객이 선호하는 배송 물류 유형을 나타냅니다.

ActionStatusEnum

열거형

주문 항목을 삭제할 수 있는지 여부를 설명합니다.

값	Description
Allowed	허용되는 플래그입니다.
NotAllowed	허용되지 않는 플래그입니다.

AddressDetails

Object

주문 항목의 주소 세부 정보입니다.

Name	형식	Description
forwardAddress	AddressProperties	고객 주소 및 연락처 세부 정보입니다. 주소 리소스여야 합니다.
returnAddress	AddressProperties	반송 주소

AddressProperties

Object

주소 속성

Name	형식	Description
addressValidationStatus	AddressValidationStatus	주소 유효성 검사 상태
contactDetails	ContactDetails	주소에 대한 연락처 세부 정보
shippingAddress	ShippingAddress	주소에 대한 배송 세부 정보

AddressType

열거형

주소 유형입니다.

값	Description
None	주소 유형을 알 수 없습니다.
Residential	주거용 주소입니다.
Commercial	상업용 주소입니다.

AddressValidationStatus

열거형

주소 유효성 검사 상태

값	Description
Valid	제공된 주소가 유효합니다.
Invalid	제공된 주소가 잘못되었거나 지원되지 않습니다.
Ambiguous	제공된 주소가 모호합니다. 반환되는 대체 주소 중 하나를 선택하세요.

ContactDetails

Object

연락처 세부 정보입니다.

Name	형식	Description
contactName	string	사용자의 연락처 이름입니다.
emailList	string[]	작업 진행 상황에 대한 알림을 받을 전자 메일 ID 목록입니다.
mobile	string	대화 상대의 휴대폰 번호입니다.
phone	string	대화 상대의 전화 번호입니다.
phoneExtension	string	연락처의 전화 확장 번호입니다.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

DeviceDetails

Object

디바이스 세부 정보.

Name	형식	Description
managementResourceId	string	관리 리소스 ID
managementResourceTenantId	string	관리 리소스 테넌트 ID
serialNumber	string	디바이스 일련 번호

DisplayInfo

Object

제품 표시 정보를 설명합니다.

Name	형식	Description
configurationDisplayName	string	구성 표시 이름
productFamilyDisplayName	string	제품군 표시 이름

DoubleEncryptionStatus

열거형

고객이 입력한 이중 암호화 상태입니다. 'Deny' 또는 'Disabled' 정책이 구성된 경우 이 매개 변수를 제공해야 합니다.

값	Description
Disabled	이중 암호화를 사용할 수 없습니다.
Enabled	이중 암호화 사용

EncryptionPreferences

Object

이중 암호화와 관련된 기본 설정

Name	형식	Description
doubleEncryptionStatus	DoubleEncryptionStatus	고객이 입력한 이중 암호화 상태입니다. 'Deny' 또는 'Disabled' 정책이 구성된 경우 이 매개 변수를 제공해야 합니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

ForwardShippingDetails

Object

배송 세부 정보를 전달합니다.

Name	형식	Description
carrierDisplayName	string	표시 용도의 운송업체 이름입니다. 모든 처리에 사용할 수 없습니다.
carrierName	string	이동 통신 사업자의 이름입니다.
trackingId	string	패키지의 TrackingId
trackingUrl	string	패키지의 TrackingUrl입니다.

HierarchyInformation

Object

제품 계층 정보에 대한 세부 정보 보유

Name	형식	Description
configurationName	string	구성을 고유하게 식별하는 구성 이름을 나타냅니다.
productFamilyName	string	제품군을 고유하게 식별하는 제품 패밀리 이름을 나타냅니다.
productLineName	string	제품 라인을 고유하게 식별하는 제품 라인 이름을 나타냅니다.
productName	string	제품을 고유하게 식별하는 제품 이름을 나타냅니다.

ManagementResourcePreferences

Object

디바이스를 연결하는 관리 리소스 기본 설정

Name	형식	Description
preferredManagementResourceId	string	고객 기본 관리 리소스 ARM ID

NotificationPreference

Object

작업 단계에 대한 알림 기본 설정입니다.

Name	형식	Description
sendNotification	boolean	알림이 필요한지 여부입니다.
stageName	NotificationStageName	스테이지의 이름입니다.

NotificationStageName

열거형

스테이지의 이름입니다.

값	Description
Shipped	Microsoft 데이터 센터에서 배송된 주문 항목에 대한 알림입니다.
Delivered	고객에게 배달된 주문 항목의 알림입니다.

OrderItemCancellationEnum

열거형

주문 항목을 취소할 수 있는지 여부를 설명합니다.

값	Description
Cancellable	주문 항목은 수수료 없이 취소할 수 있습니다.
CancellableWithFee	주문 항목은 수수료로 취소할 수 있습니다.
NotCancellable	주문 항목을 취소할 수 없습니다.

OrderItemDetails

Object

주문 항목 세부 정보

Name	형식	Description
cancellationReason	string	취소 이유입니다.
cancellationStatus	OrderItemCancellationEnum	주문 항목을 취소할 수 있는지 여부를 설명합니다.
currentStage	StageDetails	현재 주문 항목 상태
deletionStatus	ActionStatusEnum	주문 항목을 삭제할 수 있는지 여부를 설명합니다.
error	ErrorDetail	작업의 최상위 수준 오류입니다.
forwardShippingDetails	ForwardShippingDetails	전달 패키지 배송 세부 정보
managementRpDetails	ResourceProviderDetails	부모 RP 세부 정보 - 전체 목록에서 첫 번째 또는 기본 부모 RP만 반환합니다.
managementRpDetailsList	ResourceProviderDetails[]	구성에 지원되는 부모 RP 세부 정보 목록입니다.
notificationEmailList	string[]	추가 알림 전자 메일 목록
orderItemStageHistory	StageDetails[]	주문 항목 상태 기록
orderItemType	OrderItemType	주문 항목 유형입니다.
preferences	Preferences	고객 알림 기본 설정
productDetails	ProductDetails	구성에 대한 고유 식별자입니다.
returnReason	string	이유를 반환합니다.
returnStatus	OrderItemReturnEnum	주문 항목을 반환할 수 있는지 여부를 설명합니다.
reverseShippingDetails	ReverseShippingDetails	역방향 패키지 배송 세부 정보

OrderItemResource

Object

주문 항목 계약을 나타냅니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	리소스가 있는 지리적 위치
name	string	리소스의 이름
properties.addressDetails	AddressDetails	주문 항목의 배송 및 반송 주소를 나타냅니다.
properties.orderId	string	주문 항목이 속한 순서의 ID입니다.
properties.orderItemDetails	OrderItemDetails	주문 항목 세부 정보를 나타냅니다.
properties.startTime	string (date-time)	주문 항목의 시작 시간
systemData	systemData	리소스 만들기 및 업데이트 시간을 나타냅니다.
tags	object	리소스 태그.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

OrderItemReturnEnum

열거형

주문 항목을 반환할 수 있는지 여부를 설명합니다.

값	Description
Returnable	주문 항목은 수수료 없이 반환할 수 있습니다.
ReturnableWithFee	주문 항목은 수수료로 반환할 수 있습니다.
NotReturnable	주문 항목을 반환할 수 없습니다.

OrderItemType

열거형

주문 항목 유형입니다.

값	Description
Purchase	OrderItem을 구매합니다.
Rental	Rental OrderItem입니다.

OrderItemUpdateParameter

Object

주문 항목 매개 변수를 업데이트합니다.

Name	형식	Description
properties.forwardAddress	AddressProperties	전달 배송 주소 및 연락처 세부 정보를 업데이트합니다.
properties.notificationEmailList	string[]	추가 알림 전자 메일 목록입니다.
properties.preferences	Preferences	고객 기본 설정.
tags	object	리소스를 설명하는 키 값 쌍의 목록입니다. 이러한 태그는 리소스 그룹 전체에서 이 리소스를 보고 그룹화할 때 사용할 수 있습니다.

Preferences

Object

주문과 관련된 기본 설정

Name	형식	Description
encryptionPreferences	EncryptionPreferences	암호화와 관련된 기본 설정입니다.
managementResourcePreferences	ManagementResourcePreferences	관리 리소스와 관련된 기본 설정입니다.
notificationPreferences	NotificationPreference[]	알림 기본 설정입니다.
transportPreferences	TransportPreferences	주문의 배송 물류와 관련된 기본 설정입니다.

ProductDetails

Object

제품 세부 정보를 나타냅니다.

Name	형식	Description
count	integer (int32)	제품의 수량
deviceDetails	DeviceDetails[]	디바이스 세부 정보 목록
displayInfo	DisplayInfo	제품의 세부 정보 표시
hierarchyInformation	HierarchyInformation	제품을 고유하게 식별하는 제품의 계층 구조
productDoubleEncryptionStatus	DoubleEncryptionStatus	구성의 이중 암호화 상태입니다. 읽기 전용 필드입니다.

ResourceProviderDetails

Object

관리 RP 세부 정보

Name	형식	Description
resourceProviderNamespace	string	리소스 공급자 네임스페이스

ReverseShippingDetails

Object

역방향 배송 세부 정보입니다.

Name	형식	Description
carrierDisplayName	string	표시 용도의 운송업체 이름입니다. 모든 처리에 사용할 수 없습니다.
carrierName	string	이동 통신 사업자의 이름입니다.
sasKeyForLabel	string	패키지의 역방향 배송 레이블을 다운로드하는 SAS 키입니다.
trackingId	string	패키지의 TrackingId
trackingUrl	string	패키지의 TrackingUrl입니다.

ShippingAddress

Object

고객이 디바이스를 받으려는 배송 주소입니다.

Name	형식	Description
addressType	AddressType	주소 유형입니다.
city	string	도시의 이름입니다.
companyName	string	회사의 이름입니다.
country	string	국가 이름입니다.
postalCode	string	우편번호.
stateOrProvince	string	주 또는 지방의 이름입니다.
streetAddress1	string	주소 줄 1.
streetAddress2	string	주소 줄 2.
streetAddress3	string	주소 줄 3.
zipExtendedCode	string	확장 우편 번호.

StageDetails

Object

리소스 단계 세부 정보입니다.

Name	형식	Description
displayName	string	리소스 단계의 표시 이름입니다.
stageName	StageName	스테이지 이름
stageStatus	StageStatus	스테이지 상태입니다.
startTime	string (date-time)	스테이지 시작 시간

StageName

열거형

스테이지 이름

값	Description
Placed	현재 초안 모드이며 여전히 취소할 수 있습니다.
InReview	주문은 현재 초안 모드이며 여전히 취소할 수 있습니다.
Confirmed	주문이 확인됨
ReadyToShip	주문 준비 완료
Shipped	주문이 고객에게 전송 중
Delivered	주문은 고객에게 전달됩니다.
InUse	주문은 고객 사이트에서 사용 중
ReturnInitiated	고객이 반환을 시작했습니다.
ReturnPickedUp	주문이 고객에서 Microsoft로 전송됩니다.
ReturnedToMicrosoft	주문이 Microsoft에 다시 수신되었습니다.
ReturnCompleted	이제 반환이 완료되었습니다.
Cancelled	주문이 취소되었습니다.

StageStatus

열거형

스테이지 상태입니다.

값	Description
None	아직 상태를 사용할 수 없습니다.
InProgress	단계가 진행 중입니다.
Succeeded	스테이지가 성공했습니다.
Failed	스테이지가 실패했습니다.
Cancelled	스테이지가 취소되었습니다.
Cancelling	스테이지가 취소되고 있습니다.

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

TransportPreferences

Object

SKU의 배송 물류와 관련된 기본 설정

Name	형식	Description
preferredShipmentType	TransportShipmentTypes	고객이 선호하는 배송 물류 유형을 나타냅니다.

TransportShipmentTypes

열거형

고객이 선호하는 배송 물류 유형을 나타냅니다.

값	Description
CustomerManaged	배송 물류는 고객이 처리합니다.
MicrosoftManaged	배송 물류는 Microsoft에서 처리합니다.

다음을 통해 공유

Update Order Item - Update Order Item

URI 매개 변수

요청 헤더

요청 본문

응답

보안

azure_auth

범위

예제

UpdateOrderItem

샘플 요청

샘플 응답

정의

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