Get Catalog - Get Catalog

Szolgáltatás:

Reserved VM Instances

API-verzió:

2022-11-01

Szerezze be azokat a régiókat és termékváltozatokat, amelyek a megadott Azure-előfizetéshez való RI-vásárláshoz érhetők el.

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

Opcionális paraméterekkel:

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-paraméterek

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string	Az előfizetés azonosítója
api-version	query	True	string	Támogatott verzió.
$filter	query		string	Használható katalógustulajdonságok szerinti szűrésre. A szűrő támogatja az "eq", az "or" és az "and" elemet.
$skip	query		number	A listából az eredmények visszaadása előtt kihagyandó foglalások száma
$take	query		number	A visszaadandó foglalások száma
location	query		string	Szűri a termékváltozatot a paraméterben megadott hely alapján. Ez lehet Azure-régió vagy globális
offerId	query		string	A harmadik féltől származó termékek lekéréséhez használt ajánlatazonosító
planId	query		string	A harmadik féltől származó termékek lekéréséhez használt csomagazonosító
publisherId	query		string	Külső gyártók termékeinek lekéréséhez használt közzétevő azonosítója
reservedResourceType	query		string	Annak az erőforrásnak a típusa, amelyhez a termékváltozatot meg kell adni.

Válaszok

Name	Típus	Description
200 OK	CatalogsResult	OKÉ. A kérés sikeres volt.
Other Status Codes	Error	Váratlan hiba

Példák

Catalog

Mintakérelem

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Reservations.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Reservations;

// 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

Mintaválasz

Állapotkód:

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
}

Definíciók

Name	Description
Catalog	Egy erőforrástípus termékadatai.
CatalogsResult	A katalógusok és a lapozási információk listája.
Error	Hibainformációk
ErrorResponseCode	Hibakód, amely leírja, hogy a szolgáltatás miért nem tudja feldolgozni a bejövő kérést
ExtendedErrorInfo	Kiterjesztett hibainformációk, beleértve a hibakódot és a hibaüzenetet
Msrp	Díjszabási információk a termékváltozatról
Price	Az összeget és a pénznemkódot tartalmazó díjszabási információk
ReservationTerm	A foglalás időtartamát jelöli.
SkuCapability	Termékváltozat képessége.
SkuProperty	Termékváltozat tulajdonsága.
SkuRestriction	Termékváltozat korlátozása.

Catalog

Objektum

Egy erőforrástípus termékadatai.

Name	Típus	Description
billingPlans	object	A termékváltozathoz elérhető számlázási csomagbeállítások.
capabilities	SkuCapability[]	Termékváltozat képessége.
locations	string[]	A termékváltozat által elérhető helyek készlete. Ha nincs megadva, a termékváltozat minden helyen elérhető.
msrp	Msrp	Díjszabási információk a termékváltozatról
name	string	A termékváltozat neve
resourceType	string	Az erőforrás típusa, amelyre a termékváltozat vonatkozik.
restrictions	SkuRestriction[]	Termékváltozat korlátozása.
size	string	A termékváltozat mérete
skuProperties	SkuProperty[]	Termékváltozat tulajdonsága.
terms	ReservationTerm[]	Az erőforrás elérhető foglalási feltételei
tier	string	A termékváltozat szintje

CatalogsResult

Objektum

A katalógusok és a lapozási információk listája.

Name	Típus	Description
nextLink	string	Az eredmények következő oldalára mutató hivatkozás (URL- cím).
totalItems	integer (int64)	A katalóguselemek teljes mennyisége.
value	Catalog[]	A katalógusok listája.

Error

Objektum

Hibainformációk

Name	Típus	Description
error	ExtendedErrorInfo	Kiterjesztett hibainformációk, beleértve a hibakódot és a hibaüzenetet

ErrorResponseCode

Enumerálás

Hibakód, amely leírja, hogy a szolgáltatás miért nem tudja feldolgozni a bejövő kérést

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

ExtendedErrorInfo

Objektum

Kiterjesztett hibainformációk, beleértve a hibakódot és a hibaüzenetet

Name	Típus	Description
code	ErrorResponseCode	Hibakód, amely leírja, hogy a szolgáltatás miért nem tudja feldolgozni a bejövő kérést
message	string

Msrp

Objektum

Díjszabási információk a termékváltozatról

Name	Típus	Description
p1Y	Price	Összeg a díjszabás pénznemében. Az adót nem tartalmazza.
p3Y	Price	Összeg a díjszabás pénznemében. Az adót nem tartalmazza.
p5Y	Price	Összeg a díjszabás pénznemében. Az adót nem tartalmazza.

Price

Objektum

Az összeget és a pénznemkódot tartalmazó díjszabási információk

Name	Típus	Description
amount	number (double)
currencyCode	string	A vásárlási rekord által használt pénznem ISO 4217 3 betűs pénznemkódja.

ReservationTerm

Enumerálás

A foglalás időtartamát jelöli.

Érték	Description
P1Y
P3Y
P5Y

SkuCapability

Objektum

Termékváltozat képessége.

Name	Típus	Description
name	string	A funkció leírására használható invariáns.
value	string	Invariáns, ha a funkciót mennyiség alapján mérik.

SkuProperty

Objektum

Termékváltozat tulajdonsága.

Name	Típus	Description
name	string	A funkció leírására használható invariáns.
value	string	Invariáns, ha a funkciót mennyiség alapján mérik.

SkuRestriction

Objektum

Termékváltozat korlátozása.

Name	Típus	Description
reasonCode	string	A korlátozás oka.
type	string	A korlátozások típusa.
values	string[]	A korlátozások értéke. Ha a korlátozás típusa helyre van állítva. Ez különböző helyeken korlátozva van a termékváltozat.