catalogs

Creates, updates, deletes, gets or lists a catalogs resource.

Overview

Name	catalogs
Type	Resource
Id	azure.reservations.catalogs

Fields

The following fields are returned by SELECT queries:

get_catalog

Name	Datatype	Description
name	string	The name of sku.
billingPlans	object	The billing plan options available for this sku.
capabilities	array	:vartype capabilities: list[~azure.mgmt.reservations.models.SkuCapability]
locations	array	:vartype locations: list[str]
msrp	object	Pricing information about the sku.
resourceType	string	The type of resource the sku applies to.
restrictions	array	:vartype restrictions: list[~azure.mgmt.reservations.models.SkuRestriction]
size	string	The size of this sku.
skuProperties	array	:vartype sku_properties: list[~azure.mgmt.reservations.models.SkuProperty]
terms	array	Available reservation terms for this resource.
tier	string	The tier of this sku.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_catalog	select	subscription_id	reservedResourceType, location, publisherId, offerId, planId, $filter, $skip, $take	Get the regions and skus that are available for RI purchase for the specified Azure subscription. Get the regions and skus that are available for RI purchase for the specified Azure subscription.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subscription_id	string	The ID of the target subscription. The value must be an UUID. Required.
$filter	string	May be used to filter by Catalog properties. The filter supports 'eq', 'or', and 'and'. Default value is None.
$skip	number	The number of reservations to skip from the list before returning results. Default value is None.
$take	number	To number of reservations to return. Default value is None.
location	string	Filters the skus based on the location specified in this parameter. This can be an azure region or global. Default value is None.
offerId	string	Offer id used to get the third party products. Default value is None.
planId	string	Plan id used to get the third party products. Default value is None.
publisherId	string	Publisher id used to get the third party products. Default value is None.
reservedResourceType	string	The type of the resource for which the skus should be provided. Default value is None.

SELECT examples

get_catalog

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

SELECT
name,
billingPlans,
capabilities,
locations,
msrp,
resourceType,
restrictions,
size,
skuProperties,
terms,
tier
FROM azure.reservations.catalogs
WHERE subscription_id = '{{ subscription_id }}' -- required
AND reservedResourceType = '{{ reservedResourceType }}'
AND location = '{{ location }}'
AND publisherId = '{{ publisherId }}'
AND offerId = '{{ offerId }}'
AND planId = '{{ planId }}'
AND $filter = '{{ $filter }}'
AND $skip = '{{ $skip }}'
AND $take = '{{ $take }}'
;