サブスクリプションの Azure エンタイトルメントを取得する
適用対象: パートナー センター | 21Vianet が運営するパートナー センター | Microsoft Cloud for US Government のパートナー センター
パートナーは、この API を使用してサブスクリプションの Azure エンタイトルメントを表示できます。この API は、顧客のサブスクリプション識別子の権利を取得します。
前提条件
- パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、スタンドアロン アプリとアプリ + ユーザーの両方の資格情報を使った認証がサポートされています。
- Customer_id。
- Subscription_id。
- Entitlement_id。
C#
Azure サブスクリプションを取り消すには、取り消す Azure サブスクリプションの顧客 ID、サブスクリプション ID、エンタイトルメント ID を識別する必要があります。
顧客を取得するには、「 ID で顧客を取得する と 顧客 ID で顧客を取得する - REST API を参照してください。
サブスクリプションを取得するには、「ID でサブスクリプションを取得するおよび
ID でサブスクリプションを取得する - REST API」を参照してください。 権利を取得するには、「 サブスクリプションの Azure エンタイトルメントを取得する - REST API」を参照してください。
REST 要求
要求の構文
Method | 要求 URI |
---|---|
投稿 | {baseURL}/v1/customers/{customer_id}/subscriptions/{subscription_id}/azureEntitlements/{entitlement_id} HTTP/1.1 |
URI パラメーター
次の表に、Azure サブスクリプションを取り消すために必要なクエリ パラメーターを示します。
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
customer_id | String | 年 | 値は、顧客の識別子を表す文字列です。 |
subscription_id | String | 年 | 値は、顧客の識別子を表す文字列です。 |
entitlement_id | String | 年 | 値は、Azure サブスクリプションの権利の識別子を示す文字列です。 |
要求ヘッダー
「<
要求本文
要求本文は必要ありません。
要求の例
GET https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/subscriptions/{subscription_id}/azureEntitlements/{entitlement_id}
HTTP/1.1
Accept: application/json
MS-RequestId: 655890ba-4d2b-4d09-a95f-4ea1348686a5
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
REST 応答
成功した場合、このメソッドは、応答本文でサブスクリプション リソースのAzure エンタイトルメントを返します。
応答の成功とエラーのコード
各応答には、成功または失敗とより多くのデバッグ情報を示す HTTP 状態コードが付属しています。 ネットワーク トレース ツールを使用して、このコード、エラーの種類、およびその他のパラメーターを読み取ります。 完全な一覧については、パートナー センターの REST エラーコードに関する記事を参照してください。
HTTP 状態 | HTTP コード | エラー コード | 説明 |
---|---|---|---|
BadRequest | 400 | 900118 | 顧客 ID が無効です。 |
BadRequest | 400 | 800002 | 顧客 ID {0} は GUID 形式である必要があります (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)。 |
BadRequest | 400 | 800002 | サブスクリプション ID が必要です。 |
BadRequest | 400 | 800002 | エンタイトルメント ID が必要です。 |
BadRequest | 400 | 800002 | Azure エンタイトルメントキャンセル要求のコンテンツが必要です。 |
Forbidden | 403 | 900159 | アカウント ID {0} と組織 ID {1} を持つパートナーは、アカウント ID {2} と組織 ID {3}を持つ顧客との商取引関係を持っていません。 |
BadRequest | 400 | 900307 | 取り消し理由 '{0} が無効です。 |
NotFound | 404 | 800111 | ID {0} を持つ Azure エンタイトルメントが見つかりません。 |
応答の例
応答は、特定の顧客の Azure エンタイトルメントを返します。
HTTP
HTTP/1.1 200 OK
Content-Length: 1132
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: 22bfd0fb-d1e6-4a8f-aa1a-124b7c820d80
MS-CV: cmde2DtbuUWi8JLq.0
MS-ServerId: 201022015
Date: Wed, 14 Dec 2022 00:12:53 GMT
{
"id": "bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f",
"friendlyName": " Cancel_Azure_Subscription",
"status": “inactive",
"subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
"links": {
"self": {
"uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/azureEntitlements/bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f",
"method": "GET",
"headers": []
}
}