サブスクリプションの登録状態を取得するGet subscription registration status

適用対象Applies To

  • パートナー センターPartner Center

Azure Reserved VM Instances 購入が有効になっている顧客サブスクリプションのサブスクリプション登録状態を取得する方法。How to get the subscription registration status for a customer subscription that has been enabled for purchasing Azure Reserved VM Instances.

パートナーセンター API を使用して Azure 予約 VM インスタンスを購入するには、少なくとも1つの既存の CSP Azure サブスクリプションが必要です。To purchase an Azure Reserved VM Instance using the Partner Center API, you must have at least one existing CSP Azure subscription. サブスクリプションの登録方法を使用すると、既存の CSP Azure サブスクリプションを登録し、Azure Reserved VM Instances を購入できるようになります。The Register a subscription method allows you to register your existing CSP Azure subscription, enabling it for purchasing Azure Reserved VM Instances. このメソッドを使用すると、その登録の状態を取得できます。This method allows you to retrieve the status of that registration.

前提条件Prerequisites

  • パートナー センターの認証に関するページで説明している資格情報。Credentials as described in Partner Center authentication. このシナリオでは、スタンドアロンアプリとアプリ + ユーザー資格情報の両方を使用した認証がサポートされています。This scenario supports authentication with both standalone App and App+User credentials.

  • 顧客 ID です (customer-tenant-id)。A customer ID (customer-tenant-id). お客様の ID がわからない場合は、パートナー センターのダッシュボードで検索できます。If you don't know the customer's ID, you can look it up in the Partner Center dashboard. パートナー センター メニューの [CSP] を選択し、 [顧客] を選択します。Select CSP from the Partner Center menu, followed by Customers. 顧客一覧からお客様を選び、 [アカウント] を選択します。Select the customer from the customer list, then select Account. お客様のアカウント ページで、 [顧客のアカウント情報] セクションの Microsoft ID を探します。On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。The Microsoft ID is the same as the customer ID (customer-tenant-id).

  • サブスクリプション ID。A subscription ID.

C#C#

サブスクリプションの登録状態を取得するには、まず、顧客 ID を指定して ById メソッドを使用して顧客を識別します。To get the registration status of a subscription, begin by using the IAggregatePartner.Customers.ById method with the customer ID to identify the customer. 次に、サブスクリプションを識別するためにサブスクリプション ID を指定して ById () メソッドを呼び出すことにより、サブスクリプション操作へのインターフェイスを取得します。Then, get an interface to subscription operations by calling the Subscription.ById() method with the subscription ID to identify the subscription. 次に、RegistrationStatus プロパティを使用して、現在のサブスクリプションの登録状態操作へのインターフェイスを取得し、 Get または GetAsync メソッドを呼び出して subscriptionregistrationstatus オブジェクトを取得します。Next, use the RegistrationStatus property to obtain an interface to the current subscription's registration status operations, and call the Get or GetAsync method to retrieve the SubscriptionRegistrationStatus object.

// IAggregatePartner partnerOperations;
// var selectedCustomerId;
// var selectedSubscriptionId;

// Retrieve a subscription's registration status details.
var subscriptionRegistrationDetails = partnerOperations.Customers.ById(selectedCustomerId).Subscriptions.ById(selectedSubscriptionId).RegistrationStatus.Get();

REST 要求REST request

要求の構文Request syntax

認証方法Method 要求 URIRequest URI
GETGET {baseURL}/v1/customers/{customer-id}/subscriptions/{subscription-id}/registrationstatus HTTP/1.1{baseURL}/v1/customers/{customer-id}/subscriptions/{subscription-id}/registrationstatus HTTP/1.1

URI パラメーターURI parameters

次のパスパラメーターを使用して、顧客とサブスクリプションを識別します。Use the following path parameters to identify the customer and subscription.

名前Name 種類Type 必須Required 説明Description
customer-idcustomer-id stringstring はいYes 顧客を識別する GUID 形式の文字列。A GUID formatted string that identifies the customer.
subscription-idsubscription-id stringstring はいYes サブスクリプションを識別する GUID 形式の文字列。A GUID formatted string that identifies the subscription.

要求ヘッダーRequest headers

詳細については、「パートナー センター REST ヘッダー」を参照してください。For more information, see Partner Center REST headers.

[要求本文]Request body

[なし] :None.

要求の例Request example

GET https://api.partnercenter.microsoft.com/v1/customers/<customer-id>/subscriptions/<subscription-id>/registrationstatus HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3123
MS-CorrelationId: ec8f62e5-1d92-47e9-8d5d-1924af105123
Content-Type: application/json
Content-Length: 1029
Expect: 100-continue
Connection: Keep-Alive

REST 応答REST response

成功した場合、応答本文には Subscriptionregistrationstatus リソースが含まれます。If successful, the response body contains a SubscriptionRegistrationStatus resource.

応答の成功とエラーのコードResponse success and error codes

各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。Each response comes with an HTTP status code that indicates success or failure and additional debugging information. このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。Use a network trace tool to read this code, error type, and additional parameters. 完全な一覧については、エラー コードに関するページを参照してください。For the full list, see Error Codes.

応答の例Response example

HTTP/1.1 200 OK
Content-Length: 177
Content-Type: application/json; charset=utf-8
MS-CorrelationId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3123
MS-RequestId: ec8f62e5-1d92-47e9-8d5d-1924af105123
MS-CV: InswEQre402koceL.0
MS-ServerId: 030020344

{
    "subscriptionId":"<subscription-id>",
    "status":"NotRegistered",
    "attributes":{
        "objectType":"SubscriptionRegistrationStatus"
    }
}