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

OK. The request has succeeded.

Name	Datatype	Description
name	string	The name of sku
billingPlans	object	The billing plan options available for this sku.
capabilities	array
locations	array
msrp	object	Pricing information about the sku
resourceType	string	The type of resource the sku applies to.
restrictions	array
size	string	The size of this sku
skuProperties	array
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	select	subscriptionId	reservedResourceType, location, publisherId, offerId, planId, $filter, $skip, $take

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
subscriptionId	string	Id of the subscription
$filter	string	May be used to filter by Catalog properties. The filter supports 'eq', 'or', and 'and'.
$skip	number	The number of reservations to skip from the list before returning results
$take	number	To number of reservations to return
location	string	Filters the skus based on the location specified in this parameter. This can be an Azure region or global
offerId	string	Offer id used to get the third party products
planId	string	Plan id used to get the third party products
publisherId	string	Publisher id used to get the third party products
reservedResourceType	string	The type of the resource for which the skus should be provided.

SELECT examples

get

OK. The request has succeeded.

SELECT
name,
billingPlans,
capabilities,
locations,
msrp,
resourceType,
restrictions,
size,
skuProperties,
terms,
tier
FROM azure.reservations.catalogs
WHERE subscriptionId = '{{ subscriptionId }}' -- 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 }}'
;