Microsoft Azure

Azure Reservations

This API describe Azure Reservation

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This API describe Azure Reservation

Endpoints 22

Catalog

  • GETGet the regions and skus that are available for RI purchase for the specified Azure subscription./subscriptions/:subscriptionId/providers/Microsoft.Capacity/catalogs?reservedResourceType=string&location=string&publisherId=string&offerId=string&planId=string&$filter=string&$skip=0.0&$take=0.0Get the regions and skus that are available for RI purchase for the specified Azure subscription.

AppliedReservation

  • GETGet list of applicable `Reservation`s./subscriptions/:subscriptionId/providers/Microsoft.Capacity/appliedReservationsGet applicable Reservations that are applied to this subscription or a resource group under this subscription.

Operation

  • GETGet operations./providers/Microsoft.Capacity/operationsList all the operations.

Reservation

  • GETGet all `ReservationOrder`s./providers/Microsoft.Capacity/reservationOrdersList of all the ReservationOrders that the user has access to in the current tenant.
  • GETGet a specific `ReservationOrder`./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId?$expand=stringGet the details of the ReservationOrder.
  • GETGet `Reservation`s in a given reservation Order/providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/reservationsList Reservations within a single ReservationOrder.
  • GETGet `Reservation` details./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/reservations/:reservationId?$expand=stringGet specific Reservation details.
  • PATCHUpdates a `Reservation`./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/reservations/:reservationIdUpdates the applied scopes of the Reservation.
  • GETGet `Reservation` revisions./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/reservations/:reservationId/revisionsList of all the revisions for the Reservation.

Reservation, AvailableScopes

  • POSTGet Available Scopes for `Reservation`./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/reservations/:reservationId/availableScopesCheck whether the scopes from request is valid for Reservation.

Reservation, Archive

  • POSTArchive a `Reservation`./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/reservations/:reservationId/archiveArchiving a Reservation moves it to Archived state.

Reservation, Unarchive

  • POSTUnarchive a `Reservation`./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/reservations/:reservationId/unarchiveRestores a Reservation to the state it was before archiving.

Reservation, Purchase

  • PUTPurchase `ReservationOrder`/providers/Microsoft.Capacity/reservationOrders/:reservationOrderIdPurchase ReservationOrder and create resource under the specified URI.

Reservation, Split

  • POSTSplit the `Reservation`./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/splitSplit a Reservation into two Reservations with specified quantity distribution.

Reservation, Merge

  • POSTMerges two `Reservation`s./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/mergeMerge the specified Reservations into a new Reservation. The two Reservations being merged must have same properties.

ReservationOrder, ChangeDirectory

  • POSTChange directory of `ReservationOrder`./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/changeDirectoryChange directory (tenant) of ReservationOrder and all Reservation under it to specified tenant id

CalculateRefund

  • POSTCalculate the refund amount of a reservation order./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/calculateRefundCalculate price for returning Reservations if there are no policy errors.

Return

  • POSTReturn a reservation./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/returnReturn a reservation and get refund information.

Reservation, Calculate

  • POSTCalculate price for a `ReservationOrder`./providers/Microsoft.Capacity/calculatePriceCalculate price for placing a ReservationOrder.

Exchange

  • POSTCalculates the refund amounts and price of the new purchases./providers/Microsoft.Capacity/calculateExchangeCalculates price for exchanging Reservations if there are no policy errors.
  • POSTExchange Reservation(s)/providers/Microsoft.Capacity/exchangeReturns one or more Reservations in exchange for one or more Reservation purchases.
  • GETReservation_ListAll/providers/Microsoft.Capacity/reservations?$filter=string&$orderby=string&refreshSummary=string&$skiptoken=0.0&selectedState=string&take=0.0List the reservations and the roll up counts of reservations group by provisioning states that the user has access to in the current tenant.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
22 operations on 20 pathsPOST 11GET 9PUT 1PATCH 1
Main resources
Reservation 6Exchange 2AppliedReservation 1ApplyScope 1CalculateRefund 1Catalog 1Operation 1Reservation, Archive 1Reservation, AvailableScopes 1Reservation, Calculate 1
Response formats
application/json
Description format
Swagger 2.0, API version 2022-11-01

How to test the Azure Reservations in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Reservations collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get the regions and skus that are available for RI purchase for the specified Azure subscription.” (GET /subscriptions/:subscriptionId/providers/Microsoft.Capacity/catalogs?reservedResourceType=string&location=string&publisherId=string&offerId=string&planId=string&$filter=string&$skip=0.0&$take=0.0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Reservations?

This API describe Azure Reservation It is listed under Developer tools and has 22 endpoints.

Who publishes the Azure Reservations?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Reservations?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Reservations?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Reservations have?

22 operations on 20 paths (11 POST, 9 GET, 1 PUT, 1 PATCH). The largest groups are Reservation, Exchange, AppliedReservation, ApplyScope.

Is forking the Azure Reservations free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.