Get Catalog - Get Catalog

Service:

Reserved VM Instances

API Version:

2022-11-01

指定した Azure サブスクリプションの RI 購入に使用できるリージョンと SKU を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/catalogs?api-version=2022-11-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/catalogs?api-version=2022-11-01&reservedResourceType={reservedResourceType}&location={location}&publisherId={publisherId}&offerId={offerId}&planId={planId}&$filter={$filter}&$skip={$skip}&$take={$take}

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	サブスクリプションの ID
api-version	query	True	string	サポートされているバージョン。
$filter	query		string	Catalog プロパティでフィルター処理するために使用できます。 フィルターは、'eq'、'or'、および 'and' をサポートしています。
$skip	query		number	結果を返す前にリストからスキップする予約の数
$take	query		number	返却する予約の数へ
location	query		string	このパラメーターで指定された場所に基づいて SKU をフィルター処理します。 これは、Azure リージョンまたはグローバルにすることができます。
offerId	query		string	サード パーティ製品の取得に使用されるオファー ID
planId	query		string	サード パーティ製品の取得に使用されるプラン ID
publisherId	query		string	サード パーティ製品の取得に使用される発行元 ID
reservedResourceType	query		string	SKU を指定する必要があるリソースの種類。

応答

名前	型	説明
200 OK	CatalogsResult	OK です。 要求は成功しました。
Other Status Codes	Error	予期しないエラーが発生しました。

例

Catalog

Sample Request

HTTP

GET https://management.azure.com/subscriptions/23bc208b-083f-4901-ae85-4f98c0c3b4b6/providers/Microsoft.Capacity/catalogs?api-version=2022-11-01&reservedResourceType=VirtualMachines&location=eastus

Java

/** Samples for ResourceProvider List. */
public final class Main {
    /*
     * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/GetCatalog.json
     */
    /**
     * Sample code: Catalog.
     *
     * @param manager Entry point to ReservationsManager.
     */
    public static void catalog(com.azure.resourcemanager.reservations.ReservationsManager manager) {
        manager
            .resourceProviders()
            .list(
                "23bc208b-083f-4901-ae85-4f98c0c3b4b6",
                "VirtualMachines",
                "eastus",
                null,
                null,
                null,
                null,
                null,
                null,
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.reservations import AzureReservationAPI

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-reservations
# USAGE
    python get_catalog.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AzureReservationAPI(
        credential=DefaultAzureCredential(),
    )

    response = client.get_catalog(
        subscription_id="23bc208b-083f-4901-ae85-4f98c0c3b4b6",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/GetCatalog.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armreservations_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/reservations/armreservations/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/GetCatalog.json
func ExampleAzureReservationAPIClient_NewGetCatalogPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armreservations.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAzureReservationAPIClient().NewGetCatalogPager("23bc208b-083f-4901-ae85-4f98c0c3b4b6", &armreservations.AzureReservationAPIClientGetCatalogOptions{ReservedResourceType: to.Ptr("VirtualMachines"),
		Location:    to.Ptr("eastus"),
		PublisherID: nil,
		OfferID:     nil,
		PlanID:      nil,
		Filter:      nil,
		Skip:        nil,
		Take:        nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.CatalogsResult = armreservations.CatalogsResult{
		// 	TotalItems: to.Ptr[int64](1000),
		// 	Value: []*armreservations.Catalog{
		// 		{
		// 			Name: to.Ptr("Standard_DS5_v2"),
		// 			BillingPlans: map[string][]*armreservations.ReservationBillingPlan{
		// 				"P1Y": []*armreservations.ReservationBillingPlan{
		// 					to.Ptr(armreservations.ReservationBillingPlanUpfront),
		// 					to.Ptr(armreservations.ReservationBillingPlanMonthly)},
		// 					"P3Y": []*armreservations.ReservationBillingPlan{
		// 						to.Ptr(armreservations.ReservationBillingPlanUpfront),
		// 						to.Ptr(armreservations.ReservationBillingPlanMonthly)},
		// 					},
		// 					Locations: []*string{
		// 						to.Ptr("eastus")},
		// 						ResourceType: to.Ptr("VirtualMachines"),
		// 						Restrictions: []*armreservations.SKURestriction{
		// 						},
		// 						SKUProperties: []*armreservations.SKUProperty{
		// 							{
		// 								Name: to.Ptr("Cores"),
		// 								Value: to.Ptr("16"),
		// 							},
		// 							{
		// 								Name: to.Ptr("ProductTitle"),
		// 								Value: to.Ptr("DSv2 Series, DS5"),
		// 							},
		// 							{
		// 								Name: to.Ptr("ProductShortName"),
		// 								Value: to.Ptr("DSv2 Series"),
		// 							},
		// 							{
		// 								Name: to.Ptr("SKUName"),
		// 								Value: to.Ptr("DS5 v2"),
		// 							},
		// 							{
		// 								Name: to.Ptr("MeterId"),
		// 								Value: to.Ptr("12bc208b-083f-4901-ae85-4f98c0c3b4b8"),
		// 						}},
		// 						Terms: []*armreservations.ReservationTerm{
		// 							to.Ptr(armreservations.ReservationTermP1Y),
		// 							to.Ptr(armreservations.ReservationTermP3Y)},
		// 						},
		// 						{
		// 							Name: to.Ptr("Standard_D1"),
		// 							BillingPlans: map[string][]*armreservations.ReservationBillingPlan{
		// 								"P1Y": []*armreservations.ReservationBillingPlan{
		// 									to.Ptr(armreservations.ReservationBillingPlanUpfront),
		// 									to.Ptr(armreservations.ReservationBillingPlanMonthly)},
		// 									"P3Y": []*armreservations.ReservationBillingPlan{
		// 										to.Ptr(armreservations.ReservationBillingPlanUpfront),
		// 										to.Ptr(armreservations.ReservationBillingPlanMonthly)},
		// 									},
		// 									Locations: []*string{
		// 										to.Ptr("eastus")},
		// 										ResourceType: to.Ptr("VirtualMachines"),
		// 										Restrictions: []*armreservations.SKURestriction{
		// 											{
		// 												Type: to.Ptr("Term"),
		// 												ReasonCode: to.Ptr("NotAvailableForSubscription"),
		// 												Values: []*string{
		// 													to.Ptr("P1Y")},
		// 												},
		// 												{
		// 													Type: to.Ptr("Term"),
		// 													ReasonCode: to.Ptr("NotAvailableForSubscription"),
		// 													Values: []*string{
		// 														to.Ptr("P3Y")},
		// 												}},
		// 												SKUProperties: []*armreservations.SKUProperty{
		// 													{
		// 														Name: to.Ptr("Cores"),
		// 														Value: to.Ptr("1"),
		// 													},
		// 													{
		// 														Name: to.Ptr("ProductTitle"),
		// 														Value: to.Ptr("D Series, D1"),
		// 													},
		// 													{
		// 														Name: to.Ptr("ProductShortName"),
		// 														Value: to.Ptr("D Series"),
		// 													},
		// 													{
		// 														Name: to.Ptr("SKUName"),
		// 														Value: to.Ptr("D1"),
		// 													},
		// 													{
		// 														Name: to.Ptr("MeterId"),
		// 														Value: to.Ptr("12bc208b-083f-4901-ae85-4f98c0c3b4b8"),
		// 												}},
		// 												Terms: []*armreservations.ReservationTerm{
		// 													to.Ptr(armreservations.ReservationTermP1Y),
		// 													to.Ptr(armreservations.ReservationTermP3Y)},
		// 												},
		// 												{
		// 													Name: to.Ptr("Standard_F2"),
		// 													BillingPlans: map[string][]*armreservations.ReservationBillingPlan{
		// 														"P1Y": []*armreservations.ReservationBillingPlan{
		// 															to.Ptr(armreservations.ReservationBillingPlanUpfront),
		// 															to.Ptr(armreservations.ReservationBillingPlanMonthly)},
		// 															"P3Y": []*armreservations.ReservationBillingPlan{
		// 																to.Ptr(armreservations.ReservationBillingPlanUpfront),
		// 																to.Ptr(armreservations.ReservationBillingPlanMonthly)},
		// 															},
		// 															Locations: []*string{
		// 																to.Ptr("eastus")},
		// 																ResourceType: to.Ptr("VirtualMachines"),
		// 																Restrictions: []*armreservations.SKURestriction{
		// 																	{
		// 																		Type: to.Ptr("Location"),
		// 																		ReasonCode: to.Ptr("NotAvailableForSubscription"),
		// 																		Values: []*string{
		// 																			to.Ptr("eastus")},
		// 																	}},
		// 																	SKUProperties: []*armreservations.SKUProperty{
		// 																		{
		// 																			Name: to.Ptr("Cores"),
		// 																			Value: to.Ptr("2"),
		// 																		},
		// 																		{
		// 																			Name: to.Ptr("ProductTitle"),
		// 																			Value: to.Ptr("F Series, F2"),
		// 																		},
		// 																		{
		// 																			Name: to.Ptr("ProductShortName"),
		// 																			Value: to.Ptr("F Series"),
		// 																		},
		// 																		{
		// 																			Name: to.Ptr("SKUName"),
		// 																			Value: to.Ptr("F2"),
		// 																		},
		// 																		{
		// 																			Name: to.Ptr("MeterId"),
		// 																			Value: to.Ptr("12bc208b-083f-4901-ae85-4f98c0c3b4b8"),
		// 																	}},
		// 																	Terms: []*armreservations.ReservationTerm{
		// 																		to.Ptr(armreservations.ReservationTermP1Y),
		// 																		to.Ptr(armreservations.ReservationTermP3Y)},
		// 																}},
		// 															}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AzureReservationAPI } = require("@azure/arm-reservations");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the regions and skus that are available for RI purchase for the specified Azure subscription.
 *
 * @summary Get the regions and skus that are available for RI purchase for the specified Azure subscription.
 * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/GetCatalog.json
 */
async function catalog() {
  const subscriptionId = "23bc208b-083f-4901-ae85-4f98c0c3b4b6";
  const reservedResourceType = "VirtualMachines";
  const location = "eastus";
  const options = { reservedResourceType, location };
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const resArray = new Array();
  for await (let item of client.listCatalog(subscriptionId, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Reservations;
using Azure.ResourceManager.Reservations.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/GetCatalog.json
// this example is just showing the usage of "GetCatalog" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "23bc208b-083f-4901-ae85-4f98c0c3b4b6";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
SubscriptionResourceGetCatalogOptions options = new SubscriptionResourceGetCatalogOptions() { ReservedResourceType = "VirtualMachines", Location = new AzureLocation("eastus") };
await foreach (ReservationCatalog item in subscriptionResource.GetCatalogAsync(options))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "resourceType": "VirtualMachines",
      "name": "Standard_DS5_v2",
      "terms": [
        "P1Y",
        "P3Y"
      ],
      "billingPlans": {
        "P1Y": [
          "Upfront",
          "Monthly"
        ],
        "P3Y": [
          "Upfront",
          "Monthly"
        ]
      },
      "locations": [
        "eastus"
      ],
      "skuProperties": [
        {
          "name": "Cores",
          "value": "16"
        },
        {
          "name": "ProductTitle",
          "value": "DSv2 Series, DS5"
        },
        {
          "name": "ProductShortName",
          "value": "DSv2 Series"
        },
        {
          "name": "SKUName",
          "value": "DS5 v2"
        },
        {
          "name": "MeterId",
          "value": "12bc208b-083f-4901-ae85-4f98c0c3b4b8"
        }
      ],
      "restrictions": []
    },
    {
      "resourceType": "VirtualMachines",
      "name": "Standard_D1",
      "terms": [
        "P1Y",
        "P3Y"
      ],
      "billingPlans": {
        "P1Y": [
          "Upfront",
          "Monthly"
        ],
        "P3Y": [
          "Upfront",
          "Monthly"
        ]
      },
      "locations": [
        "eastus"
      ],
      "skuProperties": [
        {
          "name": "Cores",
          "value": "1"
        },
        {
          "name": "ProductTitle",
          "value": "D Series, D1"
        },
        {
          "name": "ProductShortName",
          "value": "D Series"
        },
        {
          "name": "SKUName",
          "value": "D1"
        },
        {
          "name": "MeterId",
          "value": "12bc208b-083f-4901-ae85-4f98c0c3b4b8"
        }
      ],
      "restrictions": [
        {
          "type": "Term",
          "values": [
            "P1Y"
          ],
          "reasonCode": "NotAvailableForSubscription"
        },
        {
          "type": "Term",
          "values": [
            "P3Y"
          ],
          "reasonCode": "NotAvailableForSubscription"
        }
      ]
    },
    {
      "resourceType": "VirtualMachines",
      "name": "Standard_F2",
      "terms": [
        "P1Y",
        "P3Y"
      ],
      "billingPlans": {
        "P1Y": [
          "Upfront",
          "Monthly"
        ],
        "P3Y": [
          "Upfront",
          "Monthly"
        ]
      },
      "locations": [
        "eastus"
      ],
      "skuProperties": [
        {
          "name": "Cores",
          "value": "2"
        },
        {
          "name": "ProductTitle",
          "value": "F Series, F2"
        },
        {
          "name": "ProductShortName",
          "value": "F Series"
        },
        {
          "name": "SKUName",
          "value": "F2"
        },
        {
          "name": "MeterId",
          "value": "12bc208b-083f-4901-ae85-4f98c0c3b4b8"
        }
      ],
      "restrictions": [
        {
          "type": "Location",
          "values": [
            "eastus"
          ],
          "reasonCode": "NotAvailableForSubscription"
        }
      ]
    }
  ],
  "nextLink": "https://management.azure.com/providers/Microsoft.Capacity/reservationOrders?api-version=2022-11-01&$filter=(term eq 'P1Y')&$take=50&$skip=50",
  "totalItems": 1000
}

定義

名前	説明
Catalog	リソースの種類の製品の詳細。
CatalogsResult	カタログと改ページ位置情報の一覧。
Error	エラー情報
ErrorResponseCode	サービスが受信要求を処理できない理由を説明するエラー コード
ExtendedErrorInfo	エラー コードとエラー メッセージを含む拡張エラー情報
Msrp	SKU に関する価格情報
Price	金額と通貨コードを含む価格情報
ReservationTerm	予約の期間を表します。
SkuCapability	SKU の機能。
SkuProperty	SKU のプロパティ。
SkuRestriction	SKU の制限。

Catalog

リソースの種類の製品の詳細。

名前	型	説明
billingPlans	object	この SKU で使用できる課金プラン のオプション。
capabilities	SkuCapability[]	SKU の機能。
locations	string[]	SKU が使用可能な場所のセット。 指定しない場合、SKU はすべての場所で使用できます。
msrp	Msrp	SKU に関する価格情報
name	string	SKU の名前
resourceType	string	SKU が適用されるリソースの種類。
restrictions	SkuRestriction[]	SKU の制限。
size	string	この SKU のサイズ
skuProperties	SkuProperty[]	SKU のプロパティ。
terms	ReservationTerm[]	このリソースの利用可能な予約条件
tier	string	この SKU のレベル

CatalogsResult

カタログと改ページ位置情報の一覧。

名前	型	説明
nextLink	string	結果の次のページへのリンク (URL)。
totalItems	integer	カタログ アイテムの合計量。
value	Catalog[]	カタログの一覧。

Error

エラー情報

名前	型	説明
error	ExtendedErrorInfo	エラー コードとエラー メッセージを含む拡張エラー情報

ErrorResponseCode

サービスが受信要求を処理できない理由を説明するエラー コード

名前	型	説明
ActivateQuoteFailed	string
AppliedScopesNotAssociatedWithCommerceAccount	string
AppliedScopesSameAsExisting	string
AuthorizationFailed	string
BadRequest	string
BillingCustomerInputError	string
BillingError	string
BillingPaymentInstrumentHardError	string
BillingPaymentInstrumentSoftError	string
BillingScopeIdCannotBeChanged	string
BillingTransientError	string
CalculatePriceFailed	string
CapacityUpdateScopesFailed	string
ClientCertificateThumbprintNotSet	string
CreateQuoteFailed	string
Forbidden	string
FulfillmentConfigurationError	string
FulfillmentError	string
FulfillmentOutOfStockError	string
FulfillmentTransientError	string
HttpMethodNotSupported	string
InternalServerError	string
InvalidAccessToken	string
InvalidFulfillmentRequestParameters	string
InvalidHealthCheckType	string
InvalidLocationId	string
InvalidRefundQuantity	string
InvalidRequestContent	string
InvalidRequestUri	string
InvalidReservationId	string
InvalidReservationOrderId	string
InvalidSingleAppliedScopesCount	string
InvalidSubscriptionId	string
InvalidTenantId	string
MissingAppliedScopesForSingle	string
MissingTenantId	string
NoValidReservationsToReRate	string
NonsupportedAccountId	string
NotSpecified	string
NotSupportedCountry	string
OperationCannotBePerformedInCurrentState	string
OperationFailed	string
PatchValuesSameAsExisting	string
PaymentInstrumentNotFound	string
PurchaseError	string
ReRateOnlyAllowedForEA	string
RefundLimitExceeded	string
ReservationIdNotInReservationOrder	string
ReservationOrderCreationFailed	string
ReservationOrderIdAlreadyExists	string
ReservationOrderNotEnabled	string
ReservationOrderNotFound	string
RiskCheckFailed	string
RoleAssignmentCreationFailed	string
SelfServiceRefundNotSupported	string
ServerTimeout	string
UnauthenticatedRequestsThrottled	string
UnsupportedReservationTerm	string

ExtendedErrorInfo

エラー コードとエラー メッセージを含む拡張エラー情報

名前	型	説明
code	ErrorResponseCode	サービスが受信要求を処理できない理由を説明するエラー コード
message	string

Msrp

SKU に関する価格情報

名前	型	説明
p1Y	Price	価格通貨での金額。 税は含まれていません。
p3Y	Price	価格通貨での金額。 税は含まれていません。
p5Y	Price	価格通貨での金額。 税は含まれていません。

Price

金額と通貨コードを含む価格情報

名前	型	説明
amount	number
currencyCode	string	この購入レコードで使用される通貨の ISO 4217 3 文字の通貨コード。

ReservationTerm

予約の期間を表します。

名前	型	説明
P1Y	string
P3Y	string
P5Y	string

SkuCapability

SKU の機能。

名前	型	説明
name	string	機能を記述するための不変。
value	string	特徴量が数量で測定される場合は不変です。

SkuProperty

SKU のプロパティ。

名前	型	説明
name	string	機能を記述するための不変。
value	string	特徴量が数量で測定される場合は不変です。

SkuRestriction

SKU の制限。

名前	型	説明
reasonCode	string	制限の理由。
type	string	制限の種類。
values	string[]	制限の値。 制限の種類が location に設定されている場合。 これは、SKU が制限されている別の場所になります。