Microsoft Azure

Azure Reservation

This API describe Azure Reservation

Developer tools#openapi#cloud

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 14

Reservation, Calculate

  • POSTCalculate price for a `ReservationOrder`./providers/Microsoft.Capacity/calculatePrice?api-version=stringCalculate price for placing a ReservationOrder.

Operation

  • GETGet operations./providers/Microsoft.Capacity/operations?api-version=stringList all the operations.

Reservation

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

Reservation, Purchase

  • PUTPurchase `ReservationOrder`/providers/Microsoft.Capacity/reservationOrders/:reservationOrderId?api-version=stringPurchase ReservationOrder and create resource under the specified URI.

Reservation, Merge

  • POSTMerges two `Reservation`s./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/merge?api-version=stringMerge the specified Reservations into a new Reservation. The two Reservations being merged must have same properties.

Reservation, AvailableScopes

  • POSTGet Available Scopes for `Reservation`./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/reservations/:reservationId/availableScopes?api-version=stringGet Available Scopes for Reservation.

Reservation, Split

  • POSTSplit the `Reservation`./providers/Microsoft.Capacity/reservationOrders/:reservationOrderId/split?api-version=stringSplit a Reservation into two Reservations with specified quantity distribution.

AppliedReservation

  • GETGet list of applicable `Reservation`s./subscriptions/:subscriptionId/providers/Microsoft.Capacity/appliedReservations?api-version=stringGet applicable Reservations that are applied to this subscription or a resource group under this subscription.

Catalog

  • GETGet the regions and skus that are available for RI purchase for the specified Azure subscription./subscriptions/:subscriptionId/providers/Microsoft.Capacity/catalogs?api-version=string&reservedResourceType=string&location=string

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
14 operations on 12 pathsGET 8POST 4PUT 1PATCH 1
Main resources
Reservation 6AppliedReservation 1ApplyScope 1Catalog 1Operation 1Reservation, AvailableScopes 1Reservation, Calculate 1Reservation, Merge 1Reservation, Purchase 1Reservation, Split 1
Response formats
application/json
Description format
Swagger 2.0, API version 2019-04-01
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Azure Reservation 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 Reservation 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 “Calculate price for a `ReservationOrder`.” (POST /providers/Microsoft.Capacity/calculatePrice?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Reservation?

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

Who publishes the Azure Reservation?

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 Reservation?

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

How do I authenticate with the Azure Reservation?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Reservation have?

14 operations on 12 paths (8 GET, 4 POST, 1 PUT, 1 PATCH). The largest groups are Reservation, AppliedReservation, ApplyScope, Catalog.

Is forking the Azure Reservation 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.