Skip to content
Permalink
Fetching contributors…
Cannot retrieve contributors at this time
3700 lines (3699 sloc) 126 KB
{
"swagger": "2.0",
"info": {
"version": "2018-03-31",
"title": "ConsumptionManagementClient",
"description": "Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions."
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow.",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/usageDetails": {
"get": {
"tags": [
"UsageDetails"
],
"operationId": "UsageDetails_List",
"description": "Lists the usage details for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"UsageDetailsList": {
"$ref": "./examples/UsageDetailsList.json"
},
"UsageDetailsListFilterByTag": {
"$ref": "./examples/UsageDetailsListFilterByTag.json"
},
"UsageDetailsListGroupByTagDate": {
"$ref": "./examples/UsageDetailsListGroupByTagDate.json"
}
},
"parameters": [
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"name": "$expand",
"description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$filter",
"description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N usageDetails.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"name": "$apply",
"description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)",
"in": "query",
"required": false,
"type": "string",
"x-ms-parameter-location": "method",
"x-ms-parameter-grouping": {
"name": "QueryOptions"
},
"x-ms-client-name": "Apply"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/UsageDetailsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": {
"get": {
"tags": [
"UsageDetails"
],
"operationId": "UsageDetails_ListByBillingPeriod",
"description": "Lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"UsageDetailsListForBillingPeriod": {
"$ref": "./examples/UsageDetailsListForBillingPeriod.json"
},
"UsageDetailsExpand": {
"$ref": "./examples/UsageDetailsExpand.json"
},
"UsageDetailsListForBillingPeriodGroupByTag": {
"$ref": "./examples/UsageDetailsListForBillingPeriodGroupByTag.json"
}
},
"parameters": [
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/billingPeriodNameParameter"
},
{
"name": "$expand",
"description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$filter",
"description": "May be used to filter usageDetails 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'. Tag filter is a key value pair string where key and value is separated by a colon (:).",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$apply",
"description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period",
"in": "query",
"required": false,
"type": "string",
"x-ms-parameter-location": "method",
"x-ms-parameter-grouping": {
"name": "QueryOptions"
},
"x-ms-client-name": "Apply"
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N usageDetails.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/UsageDetailsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/usageDetails": {
"get": {
"tags": [
"UsageDetails"
],
"operationId": "UsageDetailsByBillingAccount_List",
"description": "Lists the usage details by billingAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"UsageDetailsList": {
"$ref": "./examples/UsageDetailsListByBillingAccount.json"
}
},
"parameters": [
{
"$ref": "#/parameters/billingAccountIdParameter"
},
{
"name": "$expand",
"description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$filter",
"description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N usageDetails.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"name": "$apply",
"description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)",
"in": "query",
"required": false,
"type": "string",
"x-ms-parameter-location": "method",
"x-ms-parameter-grouping": {
"name": "QueryOptions"
},
"x-ms-client-name": "Apply"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/UsageDetailsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": {
"get": {
"tags": [
"UsageDetails"
],
"operationId": "UsageDetailsByBillingAccount_ListByBillingPeriod",
"description": "Lists the usage details based on billingAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"UsageDetailsListForBillingPeriod": {
"$ref": "./examples/UsageDetailsListForBillingPeriodByBillingAccount.json"
}
},
"parameters": [
{
"$ref": "#/parameters/billingAccountIdParameter"
},
{
"$ref": "#/parameters/billingPeriodNameParameter"
},
{
"name": "$expand",
"description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$filter",
"description": "May be used to filter usageDetails 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'. Tag filter is a key value pair string where key and value is separated by a colon (:).",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$apply",
"description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period",
"in": "query",
"required": false,
"type": "string",
"x-ms-parameter-location": "method",
"x-ms-parameter-grouping": {
"name": "QueryOptions"
},
"x-ms-client-name": "Apply"
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N usageDetails.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/UsageDetailsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Consumption/usageDetails": {
"get": {
"tags": [
"UsageDetails"
],
"operationId": "UsageDetailsByDepartment_List",
"description": "Lists the usage details by departmentId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"UsageDetailsList": {
"$ref": "./examples/UsageDetailsListByDepartment.json"
}
},
"parameters": [
{
"$ref": "#/parameters/departmentIdParameter"
},
{
"name": "$expand",
"description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$filter",
"description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N usageDetails.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"name": "$apply",
"description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)",
"in": "query",
"required": false,
"type": "string",
"x-ms-parameter-location": "method",
"x-ms-parameter-grouping": {
"name": "QueryOptions"
},
"x-ms-client-name": "Apply"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/UsageDetailsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": {
"get": {
"tags": [
"UsageDetails"
],
"operationId": "UsageDetailsByDepartment_ListByBillingPeriod",
"description": "Lists the usage details based on departmentId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"UsageDetailsListForBillingPeriod": {
"$ref": "./examples/UsageDetailsListForBillingPeriodByDepartment.json"
}
},
"parameters": [
{
"$ref": "#/parameters/departmentIdParameter"
},
{
"$ref": "#/parameters/billingPeriodNameParameter"
},
{
"name": "$expand",
"description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$filter",
"description": "May be used to filter usageDetails 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'. Tag filter is a key value pair string where key and value is separated by a colon (:).",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$apply",
"description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period",
"in": "query",
"required": false,
"type": "string",
"x-ms-parameter-location": "method",
"x-ms-parameter-grouping": {
"name": "QueryOptions"
},
"x-ms-client-name": "Apply"
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N usageDetails.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/UsageDetailsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Consumption/usageDetails": {
"get": {
"tags": [
"UsageDetails"
],
"operationId": "UsageDetailsByEnrollmentAccount_List",
"description": "Lists the usage details by enrollmentAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"UsageDetailsList": {
"$ref": "./examples/UsageDetailsListByEnrollmentAccount.json"
}
},
"parameters": [
{
"$ref": "#/parameters/enrollmentAccountIdParameter"
},
{
"name": "$expand",
"description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$filter",
"description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N usageDetails.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"name": "$apply",
"description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)",
"in": "query",
"required": false,
"type": "string",
"x-ms-parameter-location": "method",
"x-ms-parameter-grouping": {
"name": "QueryOptions"
},
"x-ms-client-name": "Apply"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/UsageDetailsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": {
"get": {
"tags": [
"UsageDetails"
],
"operationId": "UsageDetailsByEnrollmentAccount_ListByBillingPeriod",
"description": "Lists the usage details based on enrollmentAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"UsageDetailsListForBillingPeriod": {
"$ref": "./examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json"
}
},
"parameters": [
{
"$ref": "#/parameters/enrollmentAccountIdParameter"
},
{
"$ref": "#/parameters/billingPeriodNameParameter"
},
{
"name": "$expand",
"description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$filter",
"description": "May be used to filter usageDetails 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'. Tag filter is a key value pair string where key and value is separated by a colon (:).",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$apply",
"description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period",
"in": "query",
"required": false,
"type": "string",
"x-ms-parameter-location": "method",
"x-ms-parameter-grouping": {
"name": "QueryOptions"
},
"x-ms-client-name": "Apply"
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N usageDetails.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/UsageDetailsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/marketplaces": {
"get": {
"tags": [
"Marketplaces"
],
"x-ms-odata": "#/definitions/Marketplace",
"operationId": "Marketplaces_List",
"description": "Lists the marketplaces for a scope by subscriptionId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"MarketplacesList": {
"$ref": "./examples/MarketplacesList.json"
}
},
"parameters": [
{
"name": "$filter",
"description": "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'.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N marketplaces.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/MarketplacesListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces": {
"get": {
"tags": [
"Marketplaces"
],
"x-ms-odata": "#/definitions/Marketplace",
"operationId": "Marketplaces_ListByBillingPeriod",
"description": "Lists the marketplaces for a scope by billing period and subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"MarketplacesListForBillingPeriod": {
"$ref": "./examples/MarketplacesListForBillingPeriod.json"
}
},
"parameters": [
{
"name": "$filter",
"description": "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'.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N marketplaces.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/billingPeriodNameParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/MarketplacesListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/marketplaces": {
"get": {
"tags": [
"Marketplaces"
],
"x-ms-odata": "#/definitions/Marketplace",
"operationId": "MarketplacesByBillingAccount_List",
"description": "Lists the marketplaces for a scope by billingAccountId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"MarketplacesList": {
"$ref": "./examples/MarketplacesByBillingAccountList.json"
}
},
"parameters": [
{
"name": "$filter",
"description": "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'.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N marketplaces.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/billingAccountIdParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/MarketplacesListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces": {
"get": {
"tags": [
"Marketplaces"
],
"x-ms-odata": "#/definitions/Marketplace",
"operationId": "MarketplacesByBillingAccount_ListByBillingPeriod",
"description": "Lists the marketplaces for a scope by billing period and billingAccountId. Marketplaces are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"MarketplacesListForBillingPeriod": {
"$ref": "./examples/MarketplacesByBillingAccountListForBillingPeriod.json"
}
},
"parameters": [
{
"name": "$filter",
"description": "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'.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N marketplaces.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/billingAccountIdParameter"
},
{
"$ref": "#/parameters/billingPeriodNameParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/MarketplacesListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Consumption/marketplaces": {
"get": {
"tags": [
"Marketplaces"
],
"x-ms-odata": "#/definitions/Marketplace",
"operationId": "MarketplacesByDepartment_List",
"description": "Lists the marketplaces for a scope by departmentId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"MarketplacesList": {
"$ref": "./examples/MarketplacesByDepartmentList.json"
}
},
"parameters": [
{
"name": "$filter",
"description": "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'.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N marketplaces.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/departmentIdParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/MarketplacesListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces": {
"get": {
"tags": [
"Marketplaces"
],
"x-ms-odata": "#/definitions/Marketplace",
"operationId": "MarketplacesByDepartment_ListByBillingPeriod",
"description": "Lists the marketplaces for a scope by billing period and departmentId. Marketplaces are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"MarketplacesListForBillingPeriod": {
"$ref": "./examples/MarketplacesByDepartment_ListByBillingPeriod.json"
}
},
"parameters": [
{
"name": "$filter",
"description": "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'.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N marketplaces.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/departmentIdParameter"
},
{
"$ref": "#/parameters/billingPeriodNameParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/MarketplacesListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Consumption/marketplaces": {
"get": {
"tags": [
"Marketplaces"
],
"x-ms-odata": "#/definitions/Marketplace",
"operationId": "MarketplacesByEnrollmentAccounts_List",
"description": "Lists the marketplaces for a scope by enrollmentAccountId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"MarketplacesList": {
"$ref": "./examples/MarketplacesByEnrollmentAccountList.json"
}
},
"parameters": [
{
"name": "$filter",
"description": "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'.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N marketplaces.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/enrollmentAccountIdParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/MarketplacesListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces": {
"get": {
"tags": [
"Marketplaces"
],
"x-ms-odata": "#/definitions/Marketplace",
"operationId": "MarketplacesByEnrollmentAccounts_ListByBillingPeriod",
"description": "Lists the marketplaces for a scope by billing period and enrollmentAccountId. Marketplaces are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"MarketplacesListForBillingPeriod": {
"$ref": "./examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json"
}
},
"parameters": [
{
"name": "$filter",
"description": "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'.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the most recent N marketplaces.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/enrollmentAccountIdParameter"
},
{
"$ref": "#/parameters/billingPeriodNameParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/MarketplacesListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/balances": {
"get": {
"tags": [
"Balances"
],
"operationId": "GetBalancesByBillingAccount",
"description": "Gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"Balances": {
"$ref": "./examples/BalancesByBillingAccount.json"
}
},
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/billingAccountIdParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/Balance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/balances": {
"get": {
"tags": [
"Balances"
],
"operationId": "GetBalancesByBillingAccount_ByBillingPeriod",
"description": "Gets the balances for a scope by billing period and billingAccountId. Balances are available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"Balances": {
"$ref": "./examples/BalancesByBillingAccountForBillingPeriod.json"
}
},
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/billingAccountIdParameter"
},
{
"$ref": "#/parameters/billingPeriodNameParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/Balance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationSummaries": {
"get": {
"tags": [
"ReservedInstances"
],
"operationId": "ReservationsSummaries_ListByReservationOrder",
"description": "Lists the reservations summaries for daily or monthly grain.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"ReservationSummariesDaily": {
"$ref": "./examples/ReservationSummariesDaily.json"
},
"ReservationSummariesMonthly": {
"$ref": "./examples/ReservationSummariesMonthly.json"
}
},
"parameters": [
{
"$ref": "#/parameters/reservationOrderIdParameter"
},
{
"$ref": "#/parameters/grainParameter"
},
{
"name": "$filter",
"description": "Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'",
"in": "query",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/ReservationSummariesListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries": {
"get": {
"tags": [
"ReservedInstances"
],
"operationId": "ReservationsSummaries_ListByReservationOrderAndReservation",
"description": "Lists the reservations summaries for daily or monthly grain.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"ReservationSummariesDailyWithReservationId": {
"$ref": "./examples/ReservationSummariesDailyWithReservationId.json"
},
"ReservationSummariesMonthlyWithReservationId": {
"$ref": "./examples/ReservationSummariesMonthlyWithReservationId.json"
}
},
"parameters": [
{
"$ref": "#/parameters/reservationOrderIdParameter"
},
{
"$ref": "#/parameters/reservationIdParameter"
},
{
"$ref": "#/parameters/grainParameter"
},
{
"name": "$filter",
"description": "Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'",
"in": "query",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/ReservationSummariesListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationDetails": {
"get": {
"tags": [
"ReservedInstances"
],
"operationId": "ReservationsDetails_ListByReservationOrder",
"description": "Lists the reservations details for provided date range.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"ReservationDetails": {
"$ref": "./examples/ReservationDetails.json"
}
},
"parameters": [
{
"$ref": "#/parameters/reservationOrderIdParameter"
},
{
"name": "$filter",
"description": "Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ",
"in": "query",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/ReservationDetailsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationDetails": {
"get": {
"tags": [
"ReservedInstances"
],
"operationId": "ReservationsDetails_ListByReservationOrderAndReservation",
"description": "Lists the reservations details for provided date range.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"ReservationDetailsWithReservationId": {
"$ref": "./examples/ReservationDetailsWithReservationId.json"
}
},
"parameters": [
{
"$ref": "#/parameters/reservationOrderIdParameter"
},
{
"$ref": "#/parameters/reservationIdParameter"
},
{
"name": "$filter",
"description": "Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ",
"in": "query",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/ReservationDetailsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/reservationRecommendations": {
"get": {
"tags": [
"ReservationRecommendations"
],
"operationId": "ReservationRecommendations_List",
"description": "List of recommendations for purchasing reserved instances.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"ReservationRecommendations": {
"$ref": "./examples/ReservationRecommendationsList.json"
},
"ReservationRecommendationsFilterByScopeLookBackPeriod": {
"$ref": "./examples/ReservationRecommendationsFilterByScopeLookBackPeriod.json"
}
},
"parameters": [
{
"name": "$filter",
"description": "May be used to filter reservationRecommendations by properties/scope and properties/lookBackPeriod.",
"in": "query",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/ReservationRecommendationsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/budgets": {
"get": {
"tags": [
"Budgets"
],
"operationId": "Budgets_List",
"description": "Lists all budgets for a subscription.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"BudgetsList": {
"$ref": "./examples/BudgetsList.json"
}
},
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/BudgetsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Consumption/budgets": {
"get": {
"tags": [
"Budgets"
],
"operationId": "Budgets_ListByResourceGroupName",
"description": "Lists all budgets for a resource group under a subscription.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"BudgetsList": {
"$ref": "./examples/BudgetsList.json"
}
},
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/BudgetsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/budgets/{budgetName}": {
"get": {
"tags": [
"Budgets"
],
"operationId": "Budgets_Get",
"description": "Gets the budget for a subscription by budget name.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"Budget": {
"$ref": "./examples/Budget.json"
}
},
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/budgetNameParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/Budget"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"put": {
"tags": [
"Budgets"
],
"operationId": "Budgets_CreateOrUpdate",
"description": "The operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"CreateOrUpdateBudget": {
"$ref": "./examples/CreateOrUpdateBudget.json"
}
},
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/budgetNameParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Budget"
},
"description": "Parameters supplied to the Create Budget operation."
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/Budget"
}
},
"201": {
"description": "Created.",
"schema": {
"$ref": "#/definitions/Budget"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"tags": [
"Budgets"
],
"operationId": "Budgets_Delete",
"description": "The operation to delete a budget.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"DeleteBudget": {
"$ref": "./examples/DeleteBudget.json"
}
},
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/budgetNameParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Consumption/budgets/{budgetName}": {
"get": {
"tags": [
"Budgets"
],
"operationId": "Budgets_GetByResourceGroupName",
"description": "Gets the budget for a resource group under a subscription by budget name.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"Budget": {
"$ref": "./examples/Budget.json"
}
},
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/budgetNameParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/Budget"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"put": {
"tags": [
"Budgets"
],
"operationId": "Budgets_CreateOrUpdateByResourceGroupName",
"description": "The operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"CreateOrUpdateBudget": {
"$ref": "./examples/CreateOrUpdateBudget.json"
}
},
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/budgetNameParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Budget"
},
"description": "Parameters supplied to the Create Budget operation."
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/Budget"
}
},
"201": {
"description": "Created.",
"schema": {
"$ref": "#/definitions/Budget"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"tags": [
"Budgets"
],
"operationId": "Budgets_DeleteByResourceGroupName",
"description": "The operation to delete a budget.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"DeleteBudget": {
"$ref": "./examples/DeleteBudget.json"
}
},
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/budgetNameParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/providers/Microsoft.Consumption/operations": {
"get": {
"tags": [
"Operations"
],
"operationId": "Operations_List",
"description": "Lists all of the available consumption REST API operations.",
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/OperationListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/pricesheets/default": {
"get": {
"tags": [
"PriceSheet"
],
"operationId": "PriceSheet_Get",
"description": "Gets the price sheet for a scope by subscriptionId. Price sheet is available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"PriceSheet": {
"$ref": "./examples/PriceSheet.json"
}
},
"parameters": [
{
"name": "$expand",
"description": "May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the top N results.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/PriceSheetResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/default": {
"get": {
"tags": [
"PriceSheet"
],
"operationId": "PriceSheet_GetByBillingPeriod",
"description": "Get the price sheet for a scope by subscriptionId and billing period. Price sheet is available via this API only for May 1, 2014 or later.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"PriceSheetForBillingPeriod": {
"$ref": "./examples/PriceSheetForBillingPeriod.json"
},
"PriceSheetExpand": {
"$ref": "./examples/PriceSheetExpand.json"
}
},
"parameters": [
{
"name": "$expand",
"description": "May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$skiptoken",
"description": "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.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$top",
"description": "May be used to limit the number of results to the top N results.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/billingPeriodNameParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/PriceSheetResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/costTags": {
"get": {
"tags": [
"CostTags"
],
"operationId": "CostTags_Get",
"description": "Get cost tags for a billing account.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"CostTags_Get": {
"$ref": "./examples/CostTags.json"
}
},
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/billingAccountIdParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/CostTags"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"put": {
"tags": [
"CostTags"
],
"description": "The operation to create or update cost tags associated with a billing account. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.",
"operationId": "CostTags_CreateOrUpdate",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"CreateOrUpdateCostTags": {
"$ref": "./examples/CreateOrUpdateCostTags.json"
}
},
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/billingAccountIdParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CostTags"
},
"description": "Parameters supplied to the Create cost tags operation."
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/CostTags"
}
},
"201": {
"description": "Created.",
"schema": {
"$ref": "#/definitions/CostTags"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/providers/Microsoft.CostManagement/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/tags": {
"get": {
"tags": [
"Tags"
],
"operationId": "Tags_Get",
"description": "Get all available tag keys for a billing account.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
"x-ms-examples": {
"Tags_Get": {
"$ref": "./examples/Tags.json"
}
},
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/billingAccountIdParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/Tags"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
}
},
"definitions": {
"MeterDetails": {
"description": "The properties of the meter detail.",
"properties": {
"meterName": {
"description": "The name of the meter, within the given meter category",
"type": "string",
"readOnly": true
},
"meterCategory": {
"description": "The category of the meter, for example, 'Cloud services', 'Networking', etc..",
"type": "string",
"readOnly": true
},
"meterSubCategory": {
"description": "The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc..",
"type": "string",
"readOnly": true
},
"unit": {
"description": "The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc.",
"type": "string",
"readOnly": true
},
"meterLocation": {
"description": "The location in which the Azure service is available.",
"type": "string",
"readOnly": true
},
"totalIncludedQuantity": {
"description": "The total included quantity associated with the offer.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"pretaxStandardRate": {
"description": "The pretax listing price.",
"type": "number",
"format": "decimal",
"readOnly": true
}
}
},
"UsageDetail": {
"description": "An usage detail resource.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/UsageDetailProperties",
"title": "Usage detail properties"
}
}
},
"UsageDetailsListResult": {
"description": "Result of listing usage details. It contains a list of available usage details in reverse chronological order by billing period.",
"properties": {
"value": {
"description": "The list of usage details.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/UsageDetail"
}
},
"nextLink": {
"description": "The link (url) to the next page of results.",
"type": "string",
"readOnly": true
}
}
},
"UsageDetailProperties": {
"description": "The properties of the usage detail.",
"properties": {
"billingPeriodId": {
"description": "The id of the billing period resource that the usage belongs to.",
"type": "string",
"readOnly": true
},
"invoiceId": {
"description": "The id of the invoice resource that the usage belongs to.",
"type": "string",
"readOnly": true
},
"usageStart": {
"description": "The start of the date time range covered by the usage detail.",
"type": "string",
"format": "date-time",
"readOnly": true
},
"usageEnd": {
"description": "The end of the date time range covered by the usage detail.",
"type": "string",
"format": "date-time",
"readOnly": true
},
"instanceName": {
"description": "The name of the resource instance that the usage is about.",
"type": "string",
"readOnly": true
},
"instanceId": {
"description": "The uri of the resource instance that the usage is about.",
"type": "string",
"readOnly": true
},
"instanceLocation": {
"description": "The location of the resource instance that the usage is about.",
"type": "string",
"readOnly": true
},
"currency": {
"description": "The ISO currency in which the meter is charged, for example, USD.",
"type": "string",
"readOnly": true
},
"usageQuantity": {
"description": "The quantity of usage.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"billableQuantity": {
"description": "The billable usage quantity.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"pretaxCost": {
"description": "The amount of cost before tax.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"isEstimated": {
"description": "The estimated usage is subject to change.",
"type": "boolean",
"readOnly": true
},
"meterId": {
"description": "The meter id (GUID).",
"type": "string",
"format": "uuid",
"readOnly": true
},
"meterDetails": {
"description": "The details about the meter. By default this is not populated, unless it's specified in $expand.",
"$ref": "#/definitions/MeterDetails",
"readOnly": true
},
"subscriptionGuid": {
"description": "Subscription guid.",
"type": "string",
"format": "uuid",
"readOnly": true
},
"subscriptionName": {
"description": "Subscription name.",
"type": "string",
"readOnly": true
},
"accountName": {
"description": "Account name.",
"type": "string",
"readOnly": true
},
"departmentName": {
"description": "Department name.",
"type": "string",
"readOnly": true
},
"product": {
"description": "Product name.",
"type": "string",
"readOnly": true
},
"consumedService": {
"description": "Consumed service name.",
"type": "string",
"readOnly": true
},
"costCenter": {
"description": "The cost center of this department if it is a department and a costcenter exists",
"type": "string",
"readOnly": true
},
"additionalProperties": {
"description": "Additional details of this usage item. By default this is not populated, unless it's specified in $expand.",
"type": "string",
"readOnly": true
}
}
},
"Marketplace": {
"description": "An marketplace resource.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/MarketplaceProperties",
"title": "Marketplace properties"
}
}
},
"MarketplacesListResult": {
"description": "Result of listing marketplaces. It contains a list of available marketplaces in reverse chronological order by billing period.",
"type": "object",
"properties": {
"value": {
"description": "The list of marketplaces.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/Marketplace"
}
},
"nextLink": {
"description": "The link (url) to the next page of results.",
"type": "string",
"readOnly": true
}
}
},
"MarketplaceProperties": {
"description": "The properties of the marketplace usage detail.",
"type": "object",
"properties": {
"billingPeriodId": {
"description": "The id of the billing period resource that the usage belongs to.",
"type": "string",
"readOnly": true
},
"usageStart": {
"description": "The start of the date time range covered by the usage detail.",
"type": "string",
"format": "date-time",
"readOnly": true
},
"usageEnd": {
"description": "The end of the date time range covered by the usage detail.",
"type": "string",
"format": "date-time",
"readOnly": true
},
"resourceRate": {
"description": "The marketplace resource rate.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"offerName": {
"description": "The type of offer.",
"type": "string",
"readOnly": true
},
"resourceGroup": {
"description": "The name of resource group.",
"type": "string",
"readOnly": true
},
"orderNumber": {
"description": "The order number.",
"type": "string",
"readOnly": true
},
"instanceName": {
"description": "The name of the resource instance that the usage is about.",
"type": "string",
"readOnly": true
},
"instanceId": {
"description": "The uri of the resource instance that the usage is about.",
"type": "string",
"readOnly": true
},
"currency": {
"description": "The ISO currency in which the meter is charged, for example, USD.",
"type": "string",
"readOnly": true
},
"consumedQuantity": {
"description": "The quantity of usage.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"unitOfMeasure": {
"description": "The unit of measure.",
"type": "string",
"readOnly": true
},
"pretaxCost": {
"description": "The amount of cost before tax.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"isEstimated": {
"description": "The estimated usage is subject to change.",
"type": "boolean",
"readOnly": true
},
"meterId": {
"description": "The meter id (GUID).",
"type": "string",
"format": "uuid",
"readOnly": true
},
"subscriptionGuid": {
"description": "Subscription guid.",
"type": "string",
"format": "uuid",
"readOnly": true
},
"subscriptionName": {
"description": "Subscription name.",
"type": "string",
"readOnly": true
},
"accountName": {
"description": "Account name.",
"type": "string",
"readOnly": true
},
"departmentName": {
"description": "Department name.",
"type": "string",
"readOnly": true
},
"consumedService": {
"description": "Consumed service name.",
"type": "string",
"readOnly": true
},
"costCenter": {
"description": "The cost center of this department if it is a department and a costcenter exists",
"type": "string",
"readOnly": true
},
"additionalProperties": {
"description": "Additional details of this usage item. By default this is not populated, unless it's specified in $expand.",
"type": "string",
"readOnly": true
},
"publisherName": {
"description": "The name of publisher.",
"type": "string",
"readOnly": true
},
"planName": {
"description": "The name of plan.",
"type": "string",
"readOnly": true
}
}
},
"Balance": {
"description": "A balance resource.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/BalanceProperties",
"title": "Balance properties"
}
}
},
"BalanceProperties": {
"description": "The properties of the balance.",
"type": "object",
"properties": {
"currency": {
"description": "The ISO currency in which the meter is charged, for example, USD.",
"type": "string",
"readOnly": true
},
"beginningBalance": {
"description": "The beginning balance for the billing period.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"endingBalance": {
"description": "The ending balance for the billing period (for open periods this will be updated daily).",
"type": "number",
"format": "decimal",
"readOnly": true
},
"newPurchases": {
"description": "Total new purchase amount.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"adjustments": {
"description": "Total adjustment amount.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"utilized": {
"description": "Total Commitment usage.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"serviceOverage": {
"description": "Overage for Azure services.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"chargesBilledSeparately": {
"description": "Charges Billed separately.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"totalOverage": {
"description": "serviceOverage + chargesBilledSeparately.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"totalUsage": {
"description": "Azure service commitment + total Overage.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"azureMarketplaceServiceCharges": {
"description": "Total charges for Azure Marketplace.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"billingFrequency": {
"description": "The billing frequency.",
"type": "string",
"enum": [
"Month",
"Quarter",
"Year"
],
"x-ms-enum": {
"name": "BillingFrequency",
"modelAsString": true
}
},
"priceHidden": {
"description": "Price is hidden or not.",
"type": "boolean",
"readOnly": true
},
"newPurchasesDetails": {
"description": "List of new purchases.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "the name of new purchase.",
"type": "string",
"readOnly": true
},
"value": {
"description": "the value of new purchase.",
"type": "number",
"format": "decimal",
"readOnly": true
}
}
},
"readOnly": true
},
"adjustmentDetails": {
"description": "List of Adjustments (Promo credit, SIE credit etc.).",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "the name of new adjustment.",
"type": "string",
"readOnly": true
},
"value": {
"description": "the value of new adjustment.",
"type": "number",
"format": "decimal",
"readOnly": true
}
}
},
"readOnly": true
}
}
},
"ReservationSummaries": {
"description": "reservation summaries resource.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ReservationSummariesProperties",
"title": "Reservation Summaries properties"
}
}
},
"ReservationSummariesListResult": {
"description": "Result of listing reservation summaries.",
"properties": {
"value": {
"description": "The list of reservation summaries.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/ReservationSummaries"
}
},
"nextLink": {
"description": "The link (url) to the next page of results.",
"type": "string",
"readOnly": true
}
}
},
"ReservationSummariesProperties": {
"description": "The properties of the reservation summaries.",
"properties": {
"reservationOrderId": {
"description": "The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.",
"type": "string",
"readOnly": true
},
"reservationId": {
"description": "The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.",
"type": "string",
"readOnly": true
},
"skuName": {
"description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.",
"type": "string",
"readOnly": true
},
"reservedHours": {
"description": "This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days",
"type": "number",
"format": "decimal",
"readOnly": true
},
"usageDate": {
"description": "Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month.",
"type": "string",
"format": "date-time",
"readOnly": true
},
"usedHours": {
"description": "Total used hours by the reservation",
"type": "number",
"format": "decimal",
"readOnly": true
},
"minUtilizationPercentage": {
"description": "This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day",
"type": "number",
"format": "decimal",
"readOnly": true
},
"avgUtilizationPercentage": {
"description": "This is average utilization for the entire time range. (day or month depending on the grain)",
"type": "number",
"format": "decimal",
"readOnly": true
},
"maxUtilizationPercentage": {
"description": "This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day.",
"type": "number",
"format": "decimal",
"readOnly": true
}
}
},
"ReservationDetails": {
"description": "reservation details resource.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ReservationDetailsProperties",
"title": "Reservation Details properties"
}
}
},
"ReservationDetailsListResult": {
"description": "Result of listing reservation details.",
"properties": {
"value": {
"description": "The list of reservation details.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/ReservationDetails"
}
},
"nextLink": {
"description": "The link (url) to the next page of results.",
"type": "string",
"readOnly": true
}
}
},
"ReservationRecommendationsProperties": {
"description": "The properties of the reservation recommendations.",
"properties": {
"lookBackPeriod": {
"description": "The number of days of usage to look back for recommendations.",
"type": "string",
"readOnly": true
},
"meterId": {
"description": "The meter id (GUID)",
"type": "string",
"format": "uuid",
"readOnly": true
},
"term": {
"description": "RI recommendations in one or three year terms.",
"type": "string",
"readOnly": true
},
"costWithNoReservedInstances": {
"description": "The total amount of cost without reserved instances.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"recommendedQuantity": {
"description": "Recommended quality for reserved instances.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"totalCostWithReservedInstances": {
"description": "The total amount of cost with reserved instances.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"netSavings": {
"description": "Total estimated savings with reserved instances.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"firstUsageDate": {
"description": "The usage date for looking back.",
"type": "string",
"format": "date-time",
"readOnly": true
},
"scope": {
"description": "Shared or single recommendation.",
"type": "string",
"readOnly": true
}
}
},
"ReservationRecommendations": {
"description": "Reservation recommendations resource.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Resource"
},
{
"$ref": "#/definitions/ResourceAttributes"
}
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ReservationRecommendationsProperties",
"title": "Reservation Recommendations properties"
}
}
},
"ReservationRecommendationsListResult": {
"description": "Result of listing reservation recommendations.",
"properties": {
"value": {
"description": "The list of reservation recommendations.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/ReservationRecommendations"
}
},
"nextLink": {
"description": "The link (url) to the next page of results.",
"type": "string",
"readOnly": true
}
}
},
"ReservationDetailsProperties": {
"description": "The properties of the reservation details.",
"properties": {
"reservationOrderId": {
"description": "The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.",
"type": "string",
"readOnly": true
},
"reservationId": {
"description": "The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.",
"type": "string",
"readOnly": true
},
"skuName": {
"description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.",
"type": "string",
"readOnly": true
},
"reservedHours": {
"description": "This is the total hours reserved for the day. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"usageDate": {
"description": "The date on which consumption occurred.",
"type": "string",
"format": "date-time",
"readOnly": true
},
"usedHours": {
"description": "This is the total hours used by the instance.",
"type": "number",
"format": "decimal",
"readOnly": true
},
"instanceId": {
"description": "This identifier is the name of the resource or the fully qualified Resource ID.",
"type": "string",
"readOnly": true
},
"totalReservedQuantity": {
"description": "This is the total count of instances that are reserved for the reservationId.",
"type": "number",
"format": "decimal",
"readOnly": true
}
}
},
"Tags": {
"description": "A resource listing all tags.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/ProxyResource"
}
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/TagProperties",
"title": "Tag properties"
}
}
},
"TagProperties": {
"description": "The properties of the tag.",
"properties": {
"tags": {
"description": "A list of Tag.",
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
}
}
},
"Tag": {
"description": "The tag resource.",
"properties": {
"key": {
"description": "Tag key.",
"type": "string"
}
}
},
"BudgetsListResult": {
"description": "Result of listing budgets. It contains a list of available budgets in the scope provided.",
"properties": {
"value": {
"description": "The list of budgets.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/Budget"
}
},
"nextLink": {
"description": "The link (url) to the next page of results.",
"type": "string",
"readOnly": true
}
}
},
"Budget": {
"description": "A budget resource.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/ProxyResource"
}
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/BudgetProperties",
"title": "Budget properties"
}
}
},
"BudgetProperties": {
"description": "The properties of the budget.",
"properties": {
"category": {
"description": "The category of the budget, whether the budget tracks cost or usage.",
"type": "string",
"enum": [
"Cost",
"Usage"
],