キャンセル操作
手記
Cloud パートナー ポータル API は、パートナー センターと統合され、引き続き動作します。 この切り替えでは、小さな変更が発生します。 Cloud パートナー ポータル API リファレンス に記載されている変更を確認して、パートナー センターに移行した後もコードが引き続き動作することを確認します。 CPP API は、パートナー センターに移行する前に既に統合されている既存の製品にのみ使用する必要があります。新しい製品では、パートナー センター申請 API を使用する必要があります。
この API は、オファーで現在進行中の操作を取り消します。
取得操作 API を使用して、この API に渡すoperationId
を取得します。 通常、キャンセルは同期操作ですが、一部の複雑なシナリオでは、既存の操作を取り消すために新しい操作が必要になる場合があります。 この場合、HTTP 応答本文には、状態のクエリに使用する操作の場所が含まれています。
POST https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/cancel?api-version=2017-10-31
URI パラメーター
名の | 説明 | データ型の |
---|---|---|
publisherId | 発行元識別子 (例: contoso |
糸 |
offerId | オファー識別子 | 糸 |
api-version | API の現在のバージョン | 日付 |
ヘッダ
名の | 値の |
---|---|
Content-Type | application/json |
認可 | トークンのベアラー |
本文の例
依頼
{
"metadata": {
"notification-emails": "jondoe@contoso.com"
}
}
要求本文のプロパティ
名の | 説明 |
---|---|
notification-emails | 発行操作の進行状況を通知する電子メール ID のコンマ区切りの一覧。 |
応答
移行されたオファー
Location: /api/publishers/contoso/offers/contoso-offer/operations/56615b67-2185-49fe-80d2-c4ddf77bb2e8?api-version=2017-10-31
移行されていないオファー
Location: /api/operations/contoso$contoso-offer$2$preview?api-version=2017-10-31
応答ヘッダー
名の | 値の |
---|---|
場所 | この操作の状態を取得する相対パス。 |
応答状態コード
コード | 説明 |
---|---|
200 | わかりました。 要求が正常に処理され、操作が同期的に取り消されました。 |
202 | 受け入れ られる。 要求が正常に処理され、操作が取り消される処理中です。 取り消し操作の場所が応答ヘッダーで返されます。 |
400 | 要求が正しくない/形式が正しくありません。 エラー応答本文では、詳細情報が提供される場合があります。 |
403 | アクセス禁止。 クライアントは、要求で指定された名前空間にアクセスできません。 |
404 | 見つかりません。 指定されたエンティティが存在しません。 |