marketplaces

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

Overview

Name	marketplaces
Type	Resource
Id	azure.consumption.marketplaces

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accountName	string	Account name.
additionalInfo	string	Additional information.
additionalProperties	string	Additional details of this usage item. By default this is not populated, unless it's specified in $expand.
billingPeriodId	string	The id of the billing period resource that the usage belongs to.
consumedQuantity	number	The quantity of usage.
consumedService	string	Consumed service name.
costCenter	string	The cost center of this department if it is a department and a costcenter exists.
currency	string	The ISO currency in which the meter is charged, for example, USD.
departmentName	string	Department name.
etag	string	The etag for the resource.
instanceId	string	The uri of the resource instance that the usage is about.
instanceName	string	The name of the resource instance that the usage is about.
isEstimated	boolean	The estimated usage is subject to change.
isRecurringCharge	boolean	Flag indicating whether this is a recurring charge or not.
meterId	string	The meter id (GUID).
offerName	string	The type of offer.
orderNumber	string	The order number.
planName	string	The name of plan.
pretaxCost	number	The amount of cost before tax.
publisherName	string	The name of publisher.
resourceGroup	string	The name of resource group.
resourceRate	number	The marketplace resource rate.
subscriptionGuid	string	Subscription guid.
subscriptionName	string	Subscription name.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
unitOfMeasure	string	The unit of measure.
usageEnd	string (date-time)	The end of the date time range covered by the usage detail.
usageStart	string (date-time)	The start of the date time range covered by the usage detail.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	scope	$filter, $top, $skiptoken	Lists the marketplaces for a scope at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.

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
scope	string	The fully qualified Azure Resource manager identifier of the resource. Required.
$filter	string	May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Default value is None.
$skiptoken	string	Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Default value is None.
$top	integer	May be used to limit the number of results to the most recent N marketplaces. Default value is None.

SELECT examples

list

Lists the marketplaces for a scope at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.

SELECT
id,
name,
accountName,
additionalInfo,
additionalProperties,
billingPeriodId,
consumedQuantity,
consumedService,
costCenter,
currency,
departmentName,
etag,
instanceId,
instanceName,
isEstimated,
isRecurringCharge,
meterId,
offerName,
orderNumber,
planName,
pretaxCost,
publisherName,
resourceGroup,
resourceRate,
subscriptionGuid,
subscriptionName,
systemData,
tags,
type,
unitOfMeasure,
usageEnd,
usageStart
FROM azure.consumption.marketplaces
WHERE scope = '{{ scope }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skiptoken = '{{ $skiptoken }}'
;