Get Catalog - Get Catalog

Get the regions and skus that are available for RI purchase for the specified Azure subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/catalogs?api-version=2019-04-01&reservedResourceType={reservedResourceType}
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/catalogs?api-version=2019-04-01&reservedResourceType={reservedResourceType}&location={location}

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Id of the subscription

api-version
query True
  • string

Supported version for this document is 2019-04-01

reservedResourceType
query True
  • string

The type of the resource for which the skus should be provided.

location
query
  • string

Filters the skus based on the location specified in this parameter. This can be an azure region or global

Responses

Name Type Description
200 OK

List of available resources

Other Status Codes

Unexpected error

Examples

Catalog

Sample Request

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

Sample Response

[
  {
    "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"
      }
    ]
  }
]

Definitions

Catalog
Error
ErrorResponseCode
ExtendedErrorInfo
SkuProperty
SkuRestriction

Catalog

Name Type Description
billingPlans
  • object

The billing plan options available for this SKU.

locations
  • string[]

The set of locations that the SKU is available. If not specified, the SKU is available in all locations.

name
  • string

The name of SKU

resourceType
  • string

The type of resource the SKU applies to.

restrictions
skuProperties
terms
  • string[]

Available reservation terms for this resource

Error

Name Type Description
error

ErrorResponseCode

Name Type Description
ActivateQuoteFailed
  • string
AppliedScopesNotAssociatedWithCommerceAccount
  • 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
ReservationIdNotInReservationOrder
  • string
ReservationOrderCreationFailed
  • string
ReservationOrderIdAlreadyExists
  • string
ReservationOrderNotEnabled
  • string
ReservationOrderNotFound
  • string
RiskCheckFailed
  • string
RoleAssignmentCreationFailed
  • string
ServerTimeout
  • string
UnauthenticatedRequestsThrottled
  • string
UnsupportedReservationTerm
  • string

ExtendedErrorInfo

Name Type Description
code
message
  • string

SkuProperty

Name Type Description
name
  • string

An invariant to describe the feature.

value
  • string

An invariant if the feature is measured by quantity.

SkuRestriction

Name Type Description
reasonCode
  • string

The reason for restriction.

type
  • string

The type of restrictions.

values
  • string[]

The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.