Marketplaces - List

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

GET https://management.azure.com/{scope}/providers/Microsoft.Consumption/marketplaces?api-version=2024-08-01
GET https://management.azure.com/{scope}/providers/Microsoft.Consumption/marketplaces?$filter={$filter}&$top={$top}&$skiptoken={$skiptoken}&api-version=2024-08-01

URI Parameters

Name In Required Type Description
scope
path True

string

The scope associated with marketplace operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For subscription, billing account, department, enrollment account and ManagementGroup, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'

api-version
query True

string

Version of the API to be used with the client request. The current version is 2023-03-01.

$filter
query

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'.

$skiptoken
query

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.

$top
query

integer

int32

May be used to limit the number of results to the most recent N marketplaces.

Responses

Name Type Description
200 OK

MarketplacesListResult

OK. The request has succeeded.

204 No Content

An empty response is sent when there is no information available within the selected scope.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

BillingAccountMarketplacesList
BillingAccountMarketplacesListForBillingPeriod
DepartmentMarketplacesList
DepartmentMarketplacesListForBillingPeriod
EnrollmentAccountMarketplacesList
EnrollmentAccountMarketplacesListForBillingPeriod
ManagementGroupMarketplacesList
ManagementGroupMarketplacesListForBillingPeriod
SubscriptionMarketplacesList
SubscriptionMarketplacesListForBillingPeriod

BillingAccountMarketplacesList

Sample request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/marketplaces?api-version=2024-08-01

Sample response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1",
      "name": "marketplaceId1",
      "type": "Microsoft.Consumption/marketPlaces",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "accountName": "Account1",
        "additionalProperties": "additionalProperties",
        "costCenter": "Center1",
        "departmentName": "Department1",
        "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702",
        "usageStart": "2017-02-13T00:00:00Z",
        "usageEnd": "2017-02-13T23:59:59Z",
        "instanceName": "shared1",
        "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1",
        "currency": "USD",
        "consumedQuantity": 0.00328,
        "pretaxCost": 0.67,
        "isEstimated": false,
        "offerName": "offer1",
        "resourceGroup": "TEST",
        "orderNumber": "00000000-0000-0000-0000-000000000000",
        "publisherName": "xyz",
        "planName": "plan1",
        "resourceRate": 0.24,
        "subscriptionGuid": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "azure subscription",
        "unitOfMeasure": "10 Hours",
        "isRecurringCharge": false
      }
    }
  ]
}

BillingAccountMarketplacesListForBillingPeriod

Sample request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/marketplaces?api-version=2024-08-01

Sample response

{
  "value": [
    {
      "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1",
      "name": "marketplacesId1",
      "type": "Microsoft.Consumption/marketPlaces",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "accountName": "Account1",
        "additionalProperties": "additionalProperties",
        "costCenter": "Center1",
        "departmentName": "Department1",
        "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702",
        "usageStart": "2017-02-13T00:00:00Z",
        "usageEnd": "2017-02-13T23:59:59Z",
        "instanceName": "shared1",
        "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1",
        "currency": "USD",
        "consumedQuantity": 0.00328,
        "pretaxCost": 0.67,
        "isEstimated": false,
        "meterId": "00000000-0000-0000-0000-000000000000",
        "offerName": "offer1",
        "resourceGroup": "TEST",
        "orderNumber": "00000000-0000-0000-0000-000000000000",
        "publisherName": "xyz",
        "planName": "plan2",
        "resourceRate": 0.24,
        "subscriptionGuid": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "azure subscription",
        "unitOfMeasure": "10 Hours",
        "isRecurringCharge": false
      }
    }
  ]
}

DepartmentMarketplacesList

Sample request

GET https://management.azure.com/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Consumption/marketplaces?api-version=2024-08-01

Sample response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1",
      "name": "marketplacesId1",
      "type": "Microsoft.Consumption/marketPlaces",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "accountName": "Account1",
        "additionalProperties": "additionalProperties",
        "costCenter": "Center1",
        "departmentName": "Department1",
        "billingPeriodId": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Billing/billingPeriods/201702",
        "usageStart": "2017-02-13T00:00:00Z",
        "usageEnd": "2017-02-13T23:59:59Z",
        "instanceName": "shared1",
        "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1",
        "currency": "USD",
        "consumedQuantity": 0.00328,
        "pretaxCost": 0.67,
        "isEstimated": false,
        "meterId": "00000000-0000-0000-0000-000000000000",
        "offerName": "offer1",
        "resourceGroup": "TEST",
        "orderNumber": "00000000-0000-0000-0000-000000000000",
        "publisherName": "xyz",
        "planName": "plan2",
        "resourceRate": 0.24,
        "subscriptionGuid": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "azure subscription",
        "unitOfMeasure": "10 Hours",
        "isRecurringCharge": false
      }
    }
  ]
}

DepartmentMarketplacesListForBillingPeriod

Sample request

GET https://management.azure.com/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Consumption/marketplaces?api-version=2024-08-01

Sample response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1",
      "name": "marketplacesId1",
      "type": "Microsoft.Consumption/marketPlaces",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "accountName": "Account1",
        "additionalProperties": "additionalProperties",
        "costCenter": "Center1",
        "departmentName": "Department1",
        "billingPeriodId": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Billing/billingPeriods/201702",
        "usageStart": "2017-02-13T00:00:00Z",
        "usageEnd": "2017-02-13T23:59:59Z",
        "instanceName": "shared1",
        "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1",
        "currency": "USD",
        "consumedQuantity": 0.00328,
        "pretaxCost": 0.67,
        "isEstimated": false,
        "meterId": "00000000-0000-0000-0000-000000000000",
        "offerName": "offer1",
        "resourceGroup": "TEST",
        "orderNumber": "00000000-0000-0000-0000-000000000000",
        "publisherName": "xyz",
        "planName": "plan2",
        "resourceRate": 0.24,
        "subscriptionGuid": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "azure subscription",
        "unitOfMeasure": "10 Hours",
        "isRecurringCharge": false
      }
    }
  ]
}

EnrollmentAccountMarketplacesList

Sample request

GET https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Consumption/marketplaces?api-version=2024-08-01

Sample response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1",
      "name": "marketplacesId1",
      "type": "Microsoft.Consumption/marketPlaces",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "accountName": "Account1",
        "additionalProperties": "additionalProperties",
        "costCenter": "Center1",
        "departmentName": "Department1",
        "billingPeriodId": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702",
        "usageStart": "2017-02-13T00:00:00Z",
        "usageEnd": "2017-02-13T23:59:59Z",
        "instanceName": "shared1",
        "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1",
        "currency": "USD",
        "consumedQuantity": 0.00328,
        "pretaxCost": 0.67,
        "isEstimated": false,
        "meterId": "00000000-0000-0000-0000-000000000000",
        "offerName": "offer1",
        "resourceGroup": "TEST",
        "orderNumber": "00000000-0000-0000-0000-000000000000",
        "publisherName": "xyz",
        "planName": "plan2",
        "resourceRate": 0.24,
        "subscriptionGuid": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "azure subscription",
        "unitOfMeasure": "10 Hours",
        "isRecurringCharge": false
      }
    }
  ]
}

EnrollmentAccountMarketplacesListForBillingPeriod

Sample request

GET https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Consumption/marketplaces?api-version=2024-08-01

Sample response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1",
      "name": "marketplacesId1",
      "type": "Microsoft.Consumption/marketPlaces",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "accountName": "Account1",
        "additionalProperties": "additionalProperties",
        "costCenter": "Center1",
        "departmentName": "Department1",
        "billingPeriodId": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702",
        "usageStart": "2017-02-13T00:00:00Z",
        "usageEnd": "2017-02-13T23:59:59Z",
        "instanceName": "shared1",
        "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1",
        "currency": "USD",
        "consumedQuantity": 0.00328,
        "pretaxCost": 0.67,
        "isEstimated": false,
        "meterId": "00000000-0000-0000-0000-000000000000",
        "offerName": "offer1",
        "resourceGroup": "TEST",
        "orderNumber": "00000000-0000-0000-0000-000000000000",
        "publisherName": "xyz",
        "planName": "plan2",
        "resourceRate": 0.24,
        "subscriptionGuid": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "azure subscription",
        "unitOfMeasure": "10 Hours",
        "isRecurringCharge": false
      }
    }
  ]
}

ManagementGroupMarketplacesList

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/marketplaces?api-version=2024-08-01

Sample response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201810/providers/Microsoft.Consumption/marketplaces/marketplaceId1",
      "name": "marketplacesId1",
      "type": "Microsoft.Consumption/marketPlaces",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "accountName": "Account1",
        "additionalProperties": "additionalProperties",
        "costCenter": "Center1",
        "departmentName": "Department1",
        "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201810",
        "usageStart": "2018-10-13T00:00:00Z",
        "usageEnd": "2018-10-13T23:59:59Z",
        "instanceName": "shared1",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1",
        "currency": "USD",
        "consumedQuantity": 0.00328,
        "pretaxCost": 0.67,
        "isEstimated": false,
        "meterId": "00000000-0000-0000-0000-000000000000",
        "offerName": "offer1",
        "resourceGroup": "TEST",
        "orderNumber": "00000000-0000-0000-0000-000000000000",
        "publisherName": "xyz",
        "planName": "plan2",
        "resourceRate": 0.24,
        "subscriptionGuid": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "azure subscription",
        "unitOfMeasure": "10 Hours",
        "isRecurringCharge": false
      }
    },
    {
      "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201810/providers/Microsoft.Consumption/marketplaces/marketplaceId2",
      "name": "marketplacesId2",
      "type": "Microsoft.Consumption/marketPlaces",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "accountName": "Account2",
        "additionalProperties": "additionalProperties",
        "costCenter": "Center2",
        "departmentName": "Department2",
        "billingPeriodId": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201810",
        "usageStart": "2018-10-13T00:00:00Z",
        "usageEnd": "2018-10-13T23:59:59Z",
        "instanceName": "shared2",
        "instanceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared2",
        "currency": "USD",
        "consumedQuantity": 0.00328,
        "pretaxCost": 0.67,
        "isEstimated": false,
        "meterId": "11111111-1111-1111-1111-111111111111",
        "offerName": "offer1",
        "resourceGroup": "TEST",
        "orderNumber": "11111111-1111-1111-1111-111111111111",
        "publisherName": "xyz",
        "planName": "plan2",
        "resourceRate": 0.24,
        "subscriptionGuid": "11111111-1111-1111-1111-111111111111",
        "subscriptionName": "azure subscription",
        "unitOfMeasure": "10 Hours",
        "isRecurringCharge": false
      }
    }
  ]
}

ManagementGroupMarketplacesListForBillingPeriod

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/marketplaces?api-version=2024-08-01

Sample response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201808/providers/Microsoft.Consumption/marketplaces/marketplaceId1",
      "name": "marketplacesId1",
      "type": "Microsoft.Consumption/marketPlaces",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "accountName": "Account1",
        "additionalProperties": "additionalProperties",
        "costCenter": "Center1",
        "departmentName": "Department1",
        "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201808",
        "usageStart": "2018-08-13T00:00:00Z",
        "usageEnd": "2018-08-13T23:59:59Z",
        "instanceName": "shared1",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1",
        "currency": "USD",
        "consumedQuantity": 0.00328,
        "pretaxCost": 0.67,
        "isEstimated": false,
        "meterId": "00000000-0000-0000-0000-000000000000",
        "offerName": "offer1",
        "resourceGroup": "TEST",
        "orderNumber": "00000000-0000-0000-0000-000000000000",
        "publisherName": "xyz",
        "planName": "plan2",
        "resourceRate": 0.24,
        "subscriptionGuid": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "azure subscription",
        "unitOfMeasure": "10 Hours",
        "isRecurringCharge": false
      }
    },
    {
      "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201808/providers/Microsoft.Consumption/marketplaces/marketplaceId2",
      "name": "marketplacesId2",
      "type": "Microsoft.Consumption/marketPlaces",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "accountName": "Account2",
        "additionalProperties": "additionalProperties",
        "costCenter": "Center2",
        "departmentName": "Department2",
        "billingPeriodId": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201810",
        "usageStart": "2018-08-13T00:00:00Z",
        "usageEnd": "2018-08-13T23:59:59Z",
        "instanceName": "shared2",
        "instanceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared2",
        "currency": "USD",
        "consumedQuantity": 0.00328,
        "pretaxCost": 0.67,
        "isEstimated": false,
        "meterId": "11111111-1111-1111-1111-111111111111",
        "offerName": "offer1",
        "resourceGroup": "TEST",
        "orderNumber": "11111111-1111-1111-1111-111111111111",
        "publisherName": "xyz",
        "planName": "plan2",
        "resourceRate": 0.24,
        "subscriptionGuid": "11111111-1111-1111-1111-111111111111",
        "subscriptionName": "azure subscription",
        "unitOfMeasure": "10 Hours",
        "isRecurringCharge": false
      }
    }
  ]
}

SubscriptionMarketplacesList

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/marketplaces?api-version=2024-08-01

Sample response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketPlaces/marketplaceId1",
      "name": "marketplaceId1",
      "type": "Microsoft.Consumption/marketPlaces",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "accountName": "Account1",
        "additionalProperties": "additionalProperties",
        "costCenter": "Center1",
        "departmentName": "Department1",
        "billingPeriodId": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702",
        "usageStart": "2017-02-13T00:00:00Z",
        "usageEnd": "2017-02-13T23:59:59Z",
        "instanceName": "shared1",
        "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1",
        "currency": "USD",
        "consumedQuantity": 0.00328,
        "pretaxCost": 0.67,
        "isEstimated": false,
        "offerName": "offer1",
        "resourceGroup": "TEST",
        "orderNumber": "00000000-0000-0000-0000-000000000000",
        "publisherName": "xyz",
        "planName": "plan1",
        "resourceRate": 0.24,
        "subscriptionGuid": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "azure subscription",
        "unitOfMeasure": "10 Hours",
        "isRecurringCharge": false
      }
    }
  ]
}

SubscriptionMarketplacesListForBillingPeriod

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/marketplaces?api-version=2024-08-01

Sample response

{
  "value": [
    {
      "id": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketPlaces/marketplacesId1",
      "name": "marketplacesId1",
      "type": "Microsoft.Consumption/marketPlaces",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "accountName": "Account1",
        "additionalProperties": "additionalProperties",
        "costCenter": "Center1",
        "departmentName": "Department1",
        "billingPeriodId": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702",
        "usageStart": "2017-02-13T00:00:00Z",
        "usageEnd": "2017-02-13T23:59:59Z",
        "instanceName": "shared1",
        "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1",
        "currency": "USD",
        "consumedQuantity": 0.00328,
        "pretaxCost": 0.67,
        "isEstimated": false,
        "meterId": "00000000-0000-0000-0000-000000000000",
        "offerName": "offer1",
        "resourceGroup": "TEST",
        "orderNumber": "00000000-0000-0000-0000-000000000000",
        "publisherName": "xyz",
        "planName": "plan2",
        "resourceRate": 0.24,
        "subscriptionGuid": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "azure subscription",
        "unitOfMeasure": "10 Hours",
        "isRecurringCharge": false
      }
    }
  ]
}

Definitions

Name Description
ErrorDetails

The details of the error.

ErrorResponse

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Some Error responses:

  • 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header.

  • 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.

  • 504 Gateway Timeout - Service timed out while processing the request. Reduce the date range in the request, if possible.

Marketplace

A marketplace resource.

MarketplacesListResult

Result of listing marketplaces. It contains a list of available marketplaces in reverse chronological order by billing period.

ErrorDetails

The details of the error.

Name Type Description
code

string

Error code.

message

string

Error message indicating why the operation failed.

ErrorResponse

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Some Error responses:

  • 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header.

  • 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.

  • 504 Gateway Timeout - Service timed out while processing the request. Reduce the date range in the request, if possible.

Name Type Description
error

ErrorDetails

The details of the error.

Marketplace

A marketplace resource.

Name Type Description
etag

string

The etag for the resource.

id

string

The full qualified ARM ID of an event.

name

string

The ID that uniquely identifies an event.

properties.accountName

string

Account name.

properties.additionalInfo

string

Additional information.

properties.additionalProperties

string

Additional details of this usage item. By default this is not populated, unless it's specified in $expand.

properties.billingPeriodId

string

The id of the billing period resource that the usage belongs to.

properties.consumedQuantity

number

The quantity of usage.

properties.consumedService

string

Consumed service name.

properties.costCenter

string

The cost center of this department if it is a department and a costcenter exists

properties.currency

string

The ISO currency in which the meter is charged, for example, USD.

properties.departmentName

string

Department name.

properties.instanceId

string

The uri of the resource instance that the usage is about.

properties.instanceName

string

The name of the resource instance that the usage is about.

properties.isEstimated

boolean

The estimated usage is subject to change.

properties.isRecurringCharge

boolean

Flag indicating whether this is a recurring charge or not.

properties.meterId

string

The meter id (GUID).

properties.offerName

string

The type of offer.

properties.orderNumber

string

The order number.

properties.planName

string

The name of plan.

properties.pretaxCost

number

The amount of cost before tax.

properties.publisherName

string

The name of publisher.

properties.resourceGroup

string

The name of resource group.

properties.resourceRate

number

The marketplace resource rate.

properties.subscriptionGuid

string

Subscription guid.

properties.subscriptionName

string

Subscription name.

properties.unitOfMeasure

string

The unit of measure.

properties.usageEnd

string

The end of the date time range covered by the usage detail.

properties.usageStart

string

The start of the date time range covered by the usage detail.

tags

object

Resource tags.

type

string

Resource type.

MarketplacesListResult

Result of listing marketplaces. It contains a list of available marketplaces in reverse chronological order by billing period.

Name Type Description
nextLink

string

The link (url) to the next page of results.

value

Marketplace[]

The list of marketplaces.