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 (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$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 (float)	O número de reservas a serem ignoradas da lista antes de retornar os resultados
$take	query		number (float)	Para o número de reservas a serem retornadas
location	query		string	Filtra os skus com base no local especificado neste parâmetro. Isso pode ser uma região 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	Operação do Azure concluída com sucesso.
Other Status Codes	Error	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.reservations import ReservationsMgmtClient

"""
# 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 = ReservationsMgmtClient(
        credential=DefaultAzureCredential(),
    )

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


# x-ms-original-file: 2022-11-01/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

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: 2022-11-01/GetCatalog.json
 */
async function catalog() {
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const resArray = new Array();
  for await (const item of client.getCatalog("23bc208b-083f-4901-ae85-4f98c0c3b4b6", {
    reservedResourceType: "VirtualMachines",
    location: "eastus",
  })) {
    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

Resposta de exemplo

Código de status:

200

{
  "nextLink": "https://management.azure.com/providers/Microsoft.Capacity/reservationOrders?api-version=2022-11-01&$filter=(term%20eq%20'P1Y')&$take=50&$skip=50",
  "totalItems": 1000,
  "value": [
    {
      "name": "Standard_DS5_v2",
      "billingPlans": {
        "P1Y": [
          "Upfront",
          "Monthly"
        ],
        "P3Y": [
          "Upfront",
          "Monthly"
        ]
      },
      "locations": [
        "eastus"
      ],
      "resourceType": "VirtualMachines",
      "restrictions": [],
      "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"
        }
      ],
      "terms": [
        "P1Y",
        "P3Y"
      ]
    },
    {
      "name": "Standard_D1",
      "billingPlans": {
        "P1Y": [
          "Upfront",
          "Monthly"
        ],
        "P3Y": [
          "Upfront",
          "Monthly"
        ]
      },
      "locations": [
        "eastus"
      ],
      "resourceType": "VirtualMachines",
      "restrictions": [
        {
          "type": "Term",
          "reasonCode": "NotAvailableForSubscription",
          "values": [
            "P1Y"
          ]
        },
        {
          "type": "Term",
          "reasonCode": "NotAvailableForSubscription",
          "values": [
            "P3Y"
          ]
        }
      ],
      "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"
        }
      ],
      "terms": [
        "P1Y",
        "P3Y"
      ]
    },
    {
      "name": "Standard_F2",
      "billingPlans": {
        "P1Y": [
          "Upfront",
          "Monthly"
        ],
        "P3Y": [
          "Upfront",
          "Monthly"
        ]
      },
      "locations": [
        "eastus"
      ],
      "resourceType": "VirtualMachines",
      "restrictions": [
        {
          "type": "Location",
          "reasonCode": "NotAvailableForSubscription",
          "values": [
            "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"
        }
      ],
      "terms": [
        "P1Y",
        "P3Y"
      ]
    }
  ]
}

Definições

Nome	Description
Catalog	Detalhes do produto de um tipo de recurso.
CatalogMsrp	Informações sobre preços sobre o sku
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
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[]
msrp	CatalogMsrp	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

CatalogMsrp

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.

CatalogsResult

Objeto

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

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
totalItems	integer (int64)	A quantidade total de itens de catálogo.
value	Catalog[]	Os itens do Catálogo nesta página

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
NotSpecified	Não especificado
InternalServerError	Erro Interno do Servidor
ServerTimeout	ServerTimeout
AuthorizationFailed	Falha na Autorização
BadRequest	SolicitaçãoInválida
ClientCertificateThumbprintNotSet	ClienteCredencialThumbThumbPrintNotSet
InvalidRequestContent	Conteúdo de Solicitação Inválido
OperationFailed	Operação Fracassada
HttpMethodNotSupported	HttpMethodNotSupported
InvalidRequestUri	InvalidRequestUri
MissingTenantId	InquilinoPerdido
InvalidTenantId	InvalidTenantId
InvalidReservationOrderId	InvalidReservationOrderId
InvalidReservationId	InvalidReservationId
ReservationIdNotInReservationOrder	ReservationNotInReservationOrder
ReservationOrderNotFound	ReservationOrderNotFound
InvalidSubscriptionId	InvalidSubscriptionId
InvalidAccessToken	InvalidAccessToken
InvalidLocationId	InvalidLocationId
UnauthenticatedRequestsThrottled	SolicitaçõesSem AutenticaçãoLimitado
InvalidHealthCheckType	InvalidHealthCheckType
Forbidden	Proibido
BillingScopeIdCannotBeChanged	EscopoFaturamentoEuNãoPodeSer Alterado
AppliedScopesNotAssociatedWithCommerceAccount	AppliedScopesNotAssociatedAmbCommerceAccount
PatchValuesSameAsExisting	ValoresPatchesIgualesQueExistentes
RoleAssignmentCreationFailed	PapelAtribuiçãoCriaçãoFalhada
ReservationOrderCreationFailed	ReservaEncomendaCriaçãoFalhada
ReservationOrderNotEnabled	ReservaOrderNotEnabled
CapacityUpdateScopesFailed	CapacidadeAtualizaçãoEscoposFalhado
UnsupportedReservationTerm	Período de Reserva Não Suportado
ReservationOrderIdAlreadyExists	ReservaEncomendaIdJáExisteExiste
RiskCheckFailed	RiscoChecaçãoFalhada
CreateQuoteFailed	CriarCitaçãoFalhada
ActivateQuoteFailed	AtivarCitaçãoFalhada
NonsupportedAccountId	ContaConta Não Suportada
PaymentInstrumentNotFound	InstrumentoNãoEncontrado
MissingAppliedScopesForSingle	Escopos Aplicados FaltandoParaÚnico
NoValidReservationsToReRate	SemReservaVálidaParaReavaliar
ReRateOnlyAllowedForEA	ReRateOnlyPermiteDeEA
OperationCannotBePerformedInCurrentState	OperaçãoNão PodeSer Realizada No Estado Atual
InvalidSingleAppliedScopesCount	ContagemInválidaSingleAppliedScopesCount
InvalidFulfillmentRequestParameters	InválidoPrazoPedidoCumprimentoParâmetros
NotSupportedCountry	NãoApoiadoPaís
InvalidRefundQuantity	Valor de ReembolsoInválidoReembolso
PurchaseError	BuyError
BillingCustomerInputError	ErroEntradaFatura do Cliente
BillingPaymentInstrumentSoftError	BillingPaymentInstrumentSoftError
BillingPaymentInstrumentHardError	InstrumentoPagamentoDifícilErro Difícil
BillingTransientError	BillingTransientError
BillingError	Erro de Faturamento
FulfillmentConfigurationError	FulfillmentConfigurationError
FulfillmentOutOfStockError	FulfillmentOutOfStockError
FulfillmentTransientError	FulfillmentTransientError
FulfillmentError	FulfillmentError
CalculatePriceFailed	CalcularPreçoFalhado
AppliedScopesSameAsExisting	Escopos AplicadosIguais QueExistentes
SelfServiceRefundNotSupported	SelfServiceReembolsoNãoSuportado
RefundLimitExceeded	Limite de ReembolsoExcedido

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

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	P1Y
P3Y	P3Y
P5Y	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.