パートナー センター API を使用して統合サンドボックスから注文をキャンセルする
適用対象: パートナー センター | 21Vianet が運営するパートナー センター | Microsoft Cloud for US Government のパートナー センター
この記事では、パートナー センター API を使用して、統合サンドボックス アカウントからさまざまな種類のサブスクリプション注文を取り消す方法について説明します。 このような注文には、予約インスタンス、ソフトウェア、および商用マーケットプレースのサービスとしてのソフトウェア (SaaS) サブスクリプションの注文を含めることができます。
次の表は、サンドボックスと運用環境でのキャンセル順序を示しています。
製品の種類 | サンドボックスの更新順序 | サンドボックス更新サブスクリプション | 運用環境の更新プログラムの順序 | 運用更新プログラムのサブスクリプション |
---|---|---|---|---|
Azure 予約インスタンス | 年 | N | N | N |
永続的ソフトウェア | 年 | N | 年 | N |
ソフトウェア サブスクリプション | 年 | 年 | 年 | Y |
新しいコマース | N | 年 | N | 年 |
商業マーケットプレース | N | 年 | N | 年 |
Azure プラン | N | 年 | N | 年 |
Note
予約インスタンスまたはコマーシャル マーケットプレース SaaS サブスクリプションの注文のキャンセルは、統合サンドボックス アカウントからのみ可能です。 60 日を超えるサンドボックス注文は、パートナー センターから取り消すことはできません。
API を使用してソフトウェアの製造オーダーをキャンセルするには、 cancel-software-purchasesを使用します。 また、 cancel a purchase を使用して、ダッシュボードからソフトウェアの製造オーダーを取り消すこともできます。
前提条件
パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、スタンドアロン アプリとアプリ + ユーザーの両方の資格情報を使った認証がサポートされています。
アクティブな予約インスタンス/ソフトウェア/サードパーティの SaaS サブスクリプション注文を持つ顧客との統合サンドボックス パートナー アカウント。
C#
統合サンドボックスからの注文をキャンセルするには、アカウントの資格情報を CreatePartnerOperations
メソッドに渡して、パートナー操作を取得する IPartner
インターフェイスを取得します。
特定の Orderを選択するには、パートナー操作を使用し、顧客識別子を持つ Customers.ById()
メソッドを呼び出して顧客を指定し、注文識別子を持つ Orders.ById()
を使用して注文を指定し、最後に Get
または GetAsync
メソッドを取得します。
Order.Status
プロパティをcancelled
に設定し、Patch()
メソッドを使用して順序を更新します。
// IPartnerCredentials tipAccountCredentials;
// Customer tenant Id to be deleted.
// string customerTenantId;
IPartner tipAccountPartnerOperations = PartnerService.Instance.CreatePartnerOperations(tipAccountCredentials);
// Cancel order
var order = tipAccountPartnerOperations.Customers.ById(customerTenantId).Orders.ById(orderId).Get();
order.Status = "cancelled";
order = tipAccountPartnerOperations.Customers.ById(customerTenantId).Orders.ById(orderId).Patch(order);
REST 要求
要求の構文
認証方法 | 要求 URI |
---|---|
PATCH | {baseURL}/v1/customers/{customer-tenant-id}/orders/{order-id} HTTP/1.1 |
URI パラメーター
顧客を削除するには、次のクエリ パラメーターを使用します。
名前 | タイプ | Required | 説明 |
---|---|---|---|
customer-tenant-id | guid | 年 | この値は、GUID 形式の customer-tenant-id で、これによってリセラーは、リセラーに属する特定の顧客の結果をフィルター処理できます。 |
order-id | string | 年 | この値は、取り消す必要がある注文 ID を示す文字列です。 |
要求ヘッダー
詳細については、「パートナー センター REST ヘッダー」を参照してください。
要求本文
{
"id": "UKXASSO1dezh3HdxClHxSp5UEFXGbAnt1",
"status": "cancelled",
}
要求の例
PATCH https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>/orders/<order-id> HTTP/1.1
Accept: application/json
MS-RequestId: 655890ba-4d2b-4d09-a95f-4ea1348686a5
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
{
"id": "UKXASSO1dezh3HdxClHxSp5UEFXGbAnt1",
"status": "cancelled",
}
REST 応答
成功した場合、このメソッドは取り消された注文を返します。
応答の成功とエラーのコード
各応答には、成功または失敗とより多くのデバッグ情報を示す HTTP 状態コードが付属しています。 ネットワーク トレース ツールを使用して、このコード、エラーの種類、およびその他のパラメーターを読み取ります。 完全な一覧については、パートナー センターの REST エラーコードに関する記事を参照してください。
応答の例
HTTP/1.1 200 OK
Content-Length: 866
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 655890ba-4d2b-4d09-a95f-4ea1348686a5
{
"id": "UKXASSO1dezh3HdxClHxSp5UEFXGbAnt1",
"alternateId": "11fc4bdfd47a",
"referenceCustomerId": "bd59b416-37f9-4d8f-8df3-5750111fc615",
"billingCycle": "one_time",
"currencyCode": "USD",
"currencySymbol": "$",
"lineItems": [
{
"lineItemNumber": 0,
"offerId": "DG7GMGF0DWT0:0001:DG7GMGF0DSQR",
"termDuration": "",
"transactionType": "New",
"friendlyName": "Microsoft Identity Manager 2016 - 1 User CAL",
"quantity": 1,
"links": {
"product": {
"uri": "/products/DG7GMGF0DWT0?country=US",
"method": "GET",
"headers": []
},
"sku": {
"uri": "/products/DG7GMGF0DWT0/skus/0001?country=US",
"method": "GET",
"headers": []
},
"availability": {
"uri": "/products/DG7GMGF0DWT0/skus/0001/availabilities/DG7GMGF0DSQR?country=US",
"method": "GET",
"headers": []
}
}
}
],
"creationDate": "2019-02-21T17:56:21.1335741Z",
"status": "cancelled",
"transactionType": "UserPurchase",
"attributes": {
"objectType": "Order"
}
}