/azure/prices

POST /api/azure/prices

Price: 1 credit

Look up one Azure meter by its meter id and return every retail price row published for it: one row per region, rate kind and pricing tier, each with the retail and unit price, the billing unit, the tier the price starts at, the reservation term where there is one, the date the price takes effect, and the service, product and SKU the meter belongs to. Narrows to one region or one rate kind, and converts the prices to any of the currencies Microsoft publishes rates in.

How to use it

A meter id is not a row id: one meter is priced separately per region, per rate kind and per pricing tier, so this returns a set rather than a single record — narrow with `region` and `price_type` when you want one price. Take the id from azure/prices/search; a SKU name or an ARM machine name is not a meter id and belongs in that endpoint instead. Several rows can differ only by `effective_from`, which may be in the future because announced changes are published ahead of time.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• meter_id string required — Azure meter id, the identifier every retail price row carries (examples: "2e1c40e1-df96-5494-80f5-52d91a411a5d"; minLength: 1)
• region string nullable — Keep only the rows priced for this region, given as the ARM region name. Unset returns every region the meter is priced in (examples: "eastus", "westeurope"; minLength: 1)
• price_type string nullable — Keep only pay-as-you-go, dev/test or reservation rows of this meter. Unset returns every kind (one of: "Consumption", "DevTestConsumption", "Reservation")
• currency string — Currency the prices are converted to before they are returned (default: "USD"; one of: "AED", "ARS", "AUD", "BRL", "CAD", "CHF", "CNY", "CZK", "DKK", "EUR", "GBP", "HKD", "HUF", "IDR", "ILS", "INR", "JPY", "KRW", "MXN", "MYR", "NOK", "NZD", "PLN", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "ZAR")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "AzurePrice")
• id string required
• meter_id string nullable
• meter_name string nullable
• sku_id string nullable
• sku_name string nullable
• arm_sku_name string nullable
• product_id string nullable
• product_name string nullable
• service_id string nullable
• service_name string nullable
• service_family string nullable
• region string nullable
• location string nullable
• is_primary_meter_region boolean nullable
• price_type string nullable
• reservation_term string nullable
• retail_price number nullable
• unit_price number nullable
• currency string nullable
• unit_of_measure string nullable
• tier_minimum_units number nullable
• effective_from string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No retail price is published under that meter id. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.