openapi-directory/api/azure.com/commerce.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"title":"UsageManagementClient","version":"2015-06-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"commerce","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Commerce/RateCard":{"get":{"description":"Enables you to query for the resource/meter metadata and related prices used in a given subscription by Offer ID, Currency, Locale and Region. The metadata associated with the billing meters, including but not limited to service names, types, resources, units of measure, and regions, is subject to change at any time and without notice. If you intend to use this billing data in an automated fashion, please use the billing meter GUID to uniquely identify each billable item. If the billing meter GUID is scheduled to change due to a new billing model, you will be notified in advance of the change. ","externalDocs":{"url":"https://docs.microsoft.com/rest/api/commerce/ratecard"},"operationId":"RateCard_Get","parameters":[{"description":"The filter to apply on the operation. It ONLY supports the 'eq' and 'and' logical operators at this time. All the 4 query parameters 'OfferDurableId',  'Currency', 'Locale', 'Region' are required to be a part of the $filter.","in":"query","name":"$filter","required":true,"schema":{"type":"string"},"examples":{"GetRateCard":{"value":"OfferDurableId eq 'MS-AZR-0003P' and Currency eq 'USD' and Locale eq 'en-US' and RegionInfo eq 'US'"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"Normal response for a successful query. The response body will contain the data that matches the filters specified in the query parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceRateCardInfo"},"examples":{"GetRateCard":{"$ref":"#/components/examples/GetRateCard"}}},"text/json":{"schema":{"$ref":"#/components/schemas/ResourceRateCardInfo"},"examples":{"GetRateCard":{"$ref":"#/components/examples/GetRateCard"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["RateCard"],"x-ms-odata":"#/components/schemas/RateCardQueryParameters"}},"/subscriptions/{subscriptionId}/providers/Microsoft.Commerce/UsageAggregates":{"get":{"description":"Query aggregated Azure subscription consumption data for a date range.","externalDocs":{"url":"https://docs.microsoft.com/rest/api/commerce/usageaggregates"},"operationId":"UsageAggregates_List","parameters":[{"description":"The start of the time range to retrieve data for.","in":"query","name":"reportedStartTime","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"The end of the time range to retrieve data for.","in":"query","name":"reportedEndTime","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"`True` returns usage data in instance-level detail, `false` causes server-side aggregation with fewer details. For example, if you have 3 website instances, by default you will get 3 line items for website consumption. If you specify showDetails = false, the data will be aggregated as a single line item for website consumption within the time period (for the given subscriptionId, meterId, usageStartTime and usageEndTime).","in":"query","name":"showDetails","required":false,"schema":{"type":"boolean"}},{"description":"`Daily` (default) returns the data in daily granularity, `Hourly` returns the data in hourly granularity.","in":"query","name":"aggregationGranularity","required":false,"x-ms-enum":{"modelAsString":false,"name":"AggregationGranularity"},"schema":{"type":"string","enum":["Daily","Hourly"],"default":"Daily"}},{"description":"Used when a continuation token string is provided in the response body of the previous call, enabling paging through a large result set. If not present, the data is retrieved from the beginning of the day/hour (based on the granularity) passed in. ","in":"query","name":"continuationToken","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"Normal response for a successful query. The response body will contain the data that matches the filters specified in the query parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageAggregationListResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/UsageAggregationListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["UsageAggregates"],"x-ms-pageable":{"nextLinkName":"nextLink"}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"GetRateCard":{"value":{"Meters":[{"EffectiveDate":"2017-09-01T00:00:00Z","IncludedQuantity":0,"MeterCategory":"Test Category","MeterId":"1d7518e5-bc2f-4a93-9057-1b3047856645","MeterName":"Test Meter","MeterRates":{"0":1.99,"100":0.99},"MeterRegion":"US West","MeterSubCategory":"Test Subcategory","MeterTags":["Third Party"],"Unit":"Hours"}],"OfferTerms":[]}}},"parameters":{"ApiVersionParameter":{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"GetRateCard":{"value":"2015-06-01-preview"}}},"SubscriptionIdParameter":{"description":"It uniquely identifies Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"GetRateCard":{"value":"6d61cc05-8f8f-4916-b1b9-f1d9c25aae27"}}}},"schemas":{"ErrorResponse":{"description":"Describes the format of Error response.","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"},"InfoField":{"description":"Key-value pairs of instance details in the legacy format.","properties":{"project":{"description":"Identifies the name of the instance provisioned by the user.","type":"string"}}},"MeterInfo":{"description":"Detailed information about the meter.","properties":{"EffectiveDate":{"description":"Indicates the date from which the meter rate is effective.","format":"date-time","type":"string"},"IncludedQuantity":{"description":"The resource quantity that is included in the offer at no cost. Consumption beyond this quantity will be charged.","format":"float","type":"number"},"MeterCategory":{"description":"The category of the meter, e.g., 'Cloud services', 'Networking', etc..","type":"string"},"MeterId":{"description":"The unique identifier of the resource.","format":"uuid","type":"string"},"MeterName":{"description":"The name of the meter, within the given meter category","type":"string"},"MeterRates":{"additionalProperties":{"format":"float","type":"number"},"description":"The list of key/value pairs for the meter rates, in the format 'key':'value' where key = the meter quantity, and value = the corresponding price","type":"object"},"MeterRegion":{"description":"The region in which the Azure service is available.","type":"string"},"MeterSubCategory":{"description":"The subcategory of the meter, e.g., 'A6 Cloud services', 'ExpressRoute (IXP)', etc..","type":"string"},"MeterTags":{"description":"Provides additional meter data. 'Third Party' indicates a meter with no discount. Blanks indicate First Party.","items":{"type":"string"},"type":"array"},"Unit":{"description":"The unit in which the meter consumption is charged, e.g., 'Hours', 'GB', etc.","type":"string"}}},"MonetaryCommitment":{"allOf":[{"$ref":"#/components/schemas/OfferTermInfo"}],"description":"Indicates that a monetary commitment is required for this offer","properties":{"ExcludedMeterIds":{"description":"An array of meter ids that are excluded from the given offer terms.","items":{"format":"uuid","type":"string"},"type":"array"},"TieredDiscount":{"additionalProperties":{"format":"decimal","type":"number"},"description":"The list of key/value pairs for the tiered meter rates, in the format 'key':'value' where key = price, and value = the corresponding discount percentage. This field is used only by offer terms of type 'Monetary Commitment'.","type":"object"}},"x-ms-discriminator-value":"Monetary Commitment"},"MonetaryCredit":{"allOf":[{"$ref":"#/components/schemas/OfferTermInfo"}],"description":"Indicates that this is a monetary credit offer.","properties":{"Credit":{"description":"The amount of credit provided under the terms of the given offer level.","format":"decimal","type":"number"},"ExcludedMeterIds":{"description":"An array of meter ids that are excluded from the given offer terms.","items":{"format":"uuid","type":"string"},"type":"array"}},"x-ms-discriminator-value":"Monetary Credit"},"OfferTermInfo":{"description":"Describes the offer term.","discriminator":{"propertyName":"Name"},"properties":{"EffectiveDate":{"description":"Indicates the date from which the offer term is effective.","format":"date-time","type":"string"},"Name":{"description":"Name of the offer term","enum":["Recurring Charge","Monetary Commitment","Monetary Credit"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"OfferTermInfo"}}},"required":["Name"]},"RateCardQueryParameters":{"description":"Parameters that are used in the odata $filter query parameter for providing RateCard information.","properties":{"Currency":{"description":"The currency in which the rates need to be provided.","type":"string"},"Locale":{"description":"The culture in which the resource metadata needs to be localized.","type":"string"},"OfferDurableId":{"description":"The Offer ID parameter consists of the 'MS-AZR-' prefix, plus the Offer ID number (e.g., MS-AZR-0026P). See https://azure.microsoft.com/en-us/support/legal/offer-details/ for more information on the list of available Offer IDs, country/region availability, and billing currency.","pattern":"^MS-AZR-\\d{4}P(-\\d{4}P)*$","type":"string"},"RegionInfo":{"description":"2 letter ISO code where the offer was purchased.","type":"string"}},"required":["OfferDurableId","Currency","Locale","RegionInfo"]},"RecurringCharge":{"allOf":[{"$ref":"#/components/schemas/OfferTermInfo"}],"description":"Indicates a recurring charge is present for this offer.","properties":{"RecurringCharge":{"description":"The amount of recurring charge as per the offer term.","type":"integer"}},"x-ms-discriminator-value":"Recurring Charge"},"ResourceRateCardInfo":{"description":"Price and Metadata information for resources","properties":{"Currency":{"description":"The currency in which the rates are provided.","type":"string"},"IsTaxIncluded":{"description":"All rates are pretax, so this will always be returned as 'false'.","type":"boolean"},"Locale":{"description":"The culture in which the resource information is localized.","type":"string"},"Meters":{"description":"A list of meters.","items":{"$ref":"#/components/schemas/MeterInfo"},"type":"array"},"OfferTerms":{"description":"A list of offer terms.","items":{"$ref":"#/components/schemas/OfferTermInfo"},"type":"array"}}},"UsageAggregation":{"description":"Describes the usageAggregation.","properties":{"id":{"description":"Unique Id for the usage aggregate.","type":"string"},"name":{"description":"Name of the usage aggregate.","type":"string"},"properties":{"$ref":"#/components/schemas/UsageSample"},"type":{"description":"Type of the resource being returned.","type":"string"}}},"UsageAggregationListResult":{"description":"The Get UsageAggregates operation response.","properties":{"nextLink":{"description":"Gets or sets the link to the next set of results.","type":"string"},"value":{"description":"Gets or sets details for the requested aggregation.","items":{"$ref":"#/components/schemas/UsageAggregation"},"type":"array"}}},"UsageSample":{"description":"Describes a sample of the usageAggregation.","properties":{"infoFields":{"$ref":"#/components/schemas/InfoField"},"instanceData":{"description":"Key-value pairs of instance details represented as a string.","type":"string"},"meterCategory":{"description":"Category of the consumed resource.","type":"string"},"meterId":{"description":"Unique ID for the resource that was consumed (aka ResourceID).","type":"string"},"meterName":{"description":"Friendly name of the resource being consumed.","type":"string"},"meterRegion":{"description":"Region of the meterId used for billing purposes","type":"string"},"meterSubCategory":{"description":"Sub-category of the consumed resource.","type":"string"},"quantity":{"description":"The amount of the resource consumption that occurred in this time frame.","format":"float","type":"number"},"subscriptionId":{"description":"The subscription identifier for the Azure user.","format":"uuid","type":"string"},"unit":{"description":"The unit in which the usage for this resource is being counted, e.g. Hours, GB.","type":"string"},"usageEndTime":{"description":"UTC end time for the usage bucket to which this usage aggregate belongs.","format":"date-time","type":"string"},"usageStartTime":{"description":"UTC start time for the usage bucket to which this usage aggregate belongs.","format":"date-time","type":"string"}}}}}}