Manage orders - Update an existing transfer

Updates an existing transfer.

PATCH https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/transfers/{transfer_id}

URI Parameters

Name In Required Type Description
customer_id
path True

string

The customer identifier.

transfer_id
path True

string

The transfer identifier.

version
path True

string

Request Header

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Name Required Type Description
Authorization True

string

Authorization Bearer token

ms-correlationid

string

Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request

ms-cv

string

Used for tracking requests internally. If a ms-cv is not provided, the server will generate a new one for each request

ms-requestid

string

Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request

Request Body

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Name Type Description
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

completedTime

string

createdTime

string

customerEmailId

string

customerName

string

customerTenantId

string

id

string

ignoreEligibilityCheck

boolean

lastModifiedTime

string

lastModifiedUser

string

lineItems

Microsoft.Partner.Services.Transfers.V2.Models.TransferLineItem[]

links

Microsoft.Partner.Core.Collections.ResourceLinks

partnerOnRecord

string

partnertenantid

string

sourcePartnerEmailId

string

sourcePartnerName

string

sourcePartnerTenantId

string

status

string

targetPartnerEmailId

string

targetPartnerName

string

targetPartnerProjectId

string

targetPartnerTenantId

string

transferDirection enum:
  • 0
  • 1
  • 2
transferType enum:
  • Unknown
  • EaToCsp
  • DirectToIndirect
  • ModernAzure
  • PartnerToPartner

Responses

Name Type Description
200 OK

object

OK

Media Types: "application/json", "text/json", "application/xml", "text/xml"

201 Created

Microsoft.Partner.Services.Transfers.V2.Models.TransferEntity

The request was successful. The response body contains the transfer information.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

400 Bad Request

There was a missing or an invalid input. The response body will provide the error details.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

401 Unauthorized

The request was not authenticated. The client needs to authenticate with the partner API service first.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

403 Forbidden

The request was authenticated but was refused since the caller does not have the rights to invoke it.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

404 Not Found

The resource is not found or not available with the given input parameters.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

500 Internal Server Error

The partner API service or one of its dependencies failed to fulfill the request. Callers may retry this.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name Description
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Services.Transfer.V2.Models.TransferItemType
Microsoft.Partner.Services.Transfers.V2.Models.LastKnownBillingDetails
Microsoft.Partner.Services.Transfers.V2.Models.LastKnownBillingPeriod
Microsoft.Partner.Services.Transfers.V2.Models.TransferEntity
Microsoft.Partner.Services.Transfers.V2.Models.TransferLineItem
System.Collections.Generic.KeyValuePair[System.String,System.String]
Name Type Description
body

string

headers

System.Collections.Generic.KeyValuePair[System.String,System.String][]

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Name Type Description
etag

string

objectType

string

Name Type Description
next

Microsoft.Partner.Core.Collections.Link

previous

Microsoft.Partner.Core.Collections.Link

self

Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Services.Transfer.V2.Models.TransferItemType

Name Type Description
AzureReservation

string

AzureSavingsPlan

string

AzureSubscription

string

LegacyAzureSubscription

string

Microsoft.Partner.Services.Transfers.V2.Models.LastKnownBillingDetails

Name Type Description
billingAmount

number

billingCycle enum:
  • annual
  • monthly
  • none
  • one_time
  • unknown
billingPeriod

Microsoft.Partner.Services.Transfers.V2.Models.LastKnownBillingPeriod

billingType enum:
  • license
  • none
  • usage
currency

string

Microsoft.Partner.Services.Transfers.V2.Models.LastKnownBillingPeriod

Name Type Description
endDate

string

startDate

string

Microsoft.Partner.Services.Transfers.V2.Models.TransferEntity

Name Type Description
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

completedTime

string

createdTime

string

customerEmailId

string

customerName

string

customerTenantId

string

id

string

ignoreEligibilityCheck

boolean

lastModifiedTime

string

lastModifiedUser

string

lineItems

Microsoft.Partner.Services.Transfers.V2.Models.TransferLineItem[]

links

Microsoft.Partner.Core.Collections.ResourceLinks

partnerOnRecord

string

partnertenantid

string

sourcePartnerEmailId

string

sourcePartnerName

string

sourcePartnerTenantId

string

status

string

targetPartnerEmailId

string

targetPartnerName

string

targetPartnerProjectId

string

targetPartnerTenantId

string

transferDirection enum:
  • 0
  • 1
  • 2
transferType enum:
  • DirectToIndirect
  • EaToCsp
  • ModernAzure
  • PartnerToPartner
  • Unknown

Microsoft.Partner.Services.Transfers.V2.Models.TransferLineItem

Name Type Description
addonItems

Microsoft.Partner.Services.Transfers.V2.Models.TransferLineItem[]

billingCycle enum:
  • annual
  • monthly
  • none
  • one_time
  • unknown
billingDetails

Microsoft.Partner.Services.Transfers.V2.Models.LastKnownBillingDetails

currencyCode

string

friendlyName

string

id

integer

offerId

string

orderId

string

partnerIdOnRecord

string

productType

Microsoft.Partner.Services.Transfer.V2.Models.TransferItemType

quantity

integer

status

string

subscriptionId

string

transferError

string

transferGroupId

string

System.Collections.Generic.KeyValuePair[System.String,System.String]

Name Type Description
key

string

value

string