Get Catalog - Get Catalog

Serviço:

Reserved VM Instances

Versão da API:

2022-11-01

Obtenha as regiões e skus que estão disponíveis para compra de RI para a assinatura do Azure especificada.

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

Com parâmetros opcionais:

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}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	ID da assinatura
api-version	query	True	string	Versão com suporte.
$filter	query		string	Pode ser usado para filtrar por propriedades de catálogo. O filtro dá suporte a 'eq', 'or' e 'and'.
$skip	query		number	O número de reservas a serem ignoradas da lista antes de retornar os resultados
$take	query		number	Para o número de reservas a serem retornadas
location	query		string	Filtra os skus com base no local especificado neste parâmetro. Pode ser uma região do Azure ou global
offerId	query		string	ID da oferta usada para obter os produtos de terceiros
planId	query		string	ID de plano usada para obter os produtos de terceiros
publisherId	query		string	ID do publicador usada para obter os produtos de terceiros
reservedResourceType	query		string	O tipo do recurso para o qual os skus devem ser fornecidos.

Respostas

Nome	Tipo	Description
200 OK	CatalogsResult	OKEY. A solicitação foi bem-sucedida.
Other Status Codes	Error	Erro inesperado

Exemplos

Catalog

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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
}

Definições

Nome	Description
Catalog	Detalhes do produto de um tipo de recurso.
CatalogsResult	A lista de catálogos e informações de paginação.
Error	Informações de erro
ErrorResponseCode	Código de erro que descreve o motivo pelo qual o serviço não é capaz de processar a solicitação de entrada
ExtendedErrorInfo	Informações de erro estendidas, incluindo código de erro e mensagem de erro
Msrp	Informações sobre preços sobre o sku
Price	Informações de preços que contêm o valor e o código de moeda
ReservationTerm	Represente o termo de reserva.
SkuCapability	Funcionalidade de um sku.
SkuProperty	Propriedade de um sku.
SkuRestriction	Restrição de um sku.

Catalog

Objeto

Detalhes do produto de um tipo de recurso.

Nome	Tipo	Description
billingPlans	object	As opções de plano de cobrança disponíveis para esse sku.
capabilities	SkuCapability[]	Funcionalidade de um sku.
locations	string[]	O conjunto de locais que o sku está disponível. Se não for especificado, o sku estará disponível em todos os locais.
msrp	Msrp	Informações sobre preços sobre o sku
name	string	O nome do sku
resourceType	string	O tipo de recurso ao qual o sku se aplica.
restrictions	SkuRestriction[]	Restrição de um sku.
size	string	O tamanho deste sku
skuProperties	SkuProperty[]	Propriedade de um sku.
terms	ReservationTerm[]	Termos de reserva disponíveis para este recurso
tier	string	A camada deste sku

CatalogsResult

Objeto

A lista de catálogos e informações de paginação.

Nome	Tipo	Description
nextLink	string	O link (url) para a próxima página de resultados.
totalItems	integer (int64)	A quantidade total de itens de catálogo.
value	Catalog[]	A lista de catálogos.

Error

Objeto

Informações de erro

Nome	Tipo	Description
error	ExtendedErrorInfo	Informações de erro estendidas, incluindo código de erro e mensagem de erro

ErrorResponseCode

Enumeração

Código de erro que descreve o motivo pelo qual o serviço não é capaz de processar a solicitação de entrada

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

ExtendedErrorInfo

Objeto

Informações de erro estendidas, incluindo código de erro e mensagem de erro

Nome	Tipo	Description
code	ErrorResponseCode	Código de erro que descreve o motivo pelo qual o serviço não é capaz de processar a solicitação de entrada
message	string

Msrp

Objeto

Informações sobre preços sobre o sku

Nome	Tipo	Description
p1Y	Price	Valor em moeda de preço. Imposto não incluído.
p3Y	Price	Valor em moeda de preço. Imposto não incluído.
p5Y	Price	Valor em moeda de preço. Imposto não incluído.

Price

Objeto

Informações de preços que contêm o valor e o código de moeda

Nome	Tipo	Description
amount	number (double)
currencyCode	string	O código de moeda iso 4217 de 3 letras para a moeda usada por este registro de compra.

ReservationTerm

Enumeração

Represente o termo de reserva.

Valor	Description
P1Y
P3Y
P5Y

SkuCapability

Objeto

Funcionalidade de um sku.

Nome	Tipo	Description
name	string	Uma invariável para descrever o recurso.
value	string	Uma invariável se o recurso for medido pela quantidade.

SkuProperty

Objeto

Propriedade de um sku.

Nome	Tipo	Description
name	string	Uma invariável para descrever o recurso.
value	string	Uma invariável se o recurso for medido pela quantidade.

SkuRestriction

Objeto

Restrição de um sku.

Nome	Tipo	Description
reasonCode	string	O motivo da restrição.
type	string	O tipo de restrições.
values	string[]	O valor das restrições. Se o tipo de restrição estiver definido como local. Esses seriam locais diferentes em que o sku é restrito.