Enabling archival and unarchival of a reservation. (#11246)

Co-authored-by: Sornakumar Sundararajan <sornaks@microsoft.com>
Azure · Oct 30, 2020 · 2b96e78 · 2b96e78
1 parent 195ca6e
commit 2b96e78
Show file tree

Hide file tree

Showing 4 changed files with 120 additions and 5 deletions.
diff --git a/custom-words.txt b/custom-words.txt
@@ -1989,6 +1989,8 @@ Appxmanifest
 msixpackage
 xml
 Creds
+unarchive
+unarchiving
 ssoadfs
 Idempotence
-privatelinkhub
+privatelinkhub
diff --git a/...reservations/resource-manager/Microsoft.Capacity/preview/2019-04-01/examples/Archive.json b/...reservations/resource-manager/Microsoft.Capacity/preview/2019-04-01/examples/Archive.json
@@ -0,0 +1,10 @@
+{
+  "parameters": {
+    "api-version": "2019-04-01",
+    "reservationOrderId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da",
+    "reservationId": "356e7ae4-84d0-4da6-ab4b-d6b94f3557da"
+  },
+  "responses": {
+    "200": {}
+  }
+}
diff --git a/...servations/resource-manager/Microsoft.Capacity/preview/2019-04-01/examples/Unarchive.json b/...servations/resource-manager/Microsoft.Capacity/preview/2019-04-01/examples/Unarchive.json
@@ -0,0 +1,10 @@
+{
+  "parameters": {
+    "api-version": "2019-04-01",
+    "reservationOrderId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da",
+    "reservationId": "356e7ae4-84d0-4da6-ab4b-d6b94f3557da"
+  },
+  "responses": {
+    "200": {}
+  }
+}
diff --git a/...ion/reservations/resource-manager/Microsoft.Capacity/preview/2019-04-01/reservations.json b/...ion/reservations/resource-manager/Microsoft.Capacity/preview/2019-04-01/reservations.json
@@ -594,6 +594,80 @@
         }
       }
     },
+    "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}/archive": {
+      "post": {
+        "summary": "Archive a `Reservation`.",
+        "description": "Archiving a `Reservation` moves it to `Archived` state.",
+        "operationId": "Reservation_Archive",
+        "x-ms-examples": {
+          "Archive": {
+            "$ref": "./examples/Archive.json"
+          }
+        },
+        "parameters": [
+          {
+            "$ref": "#/parameters/ReservationOrderIdParameter"
+          },
+          {
+            "$ref": "#/parameters/ReservationIdParameter"
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          }
+        ],
+        "tags": [
+          "Reservation, Archive"
+        ],
+        "responses": {
+          "200": {
+            "description": "Archived a reservation."
+          },
+          "default": {
+            "description": "Unexpected error",
+            "schema": {
+              "$ref": "#/definitions/Error"
+            }
+          }
+        }
+      }
+    },
+    "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}/unarchive": {
+      "post": {
+        "summary": "Unarchive a `Reservation`.",
+        "description": "Unarchiving a `Reservation` moves it to the state it was before archiving.\n",
+        "operationId": "Reservation_Unarchive",
+        "x-ms-examples": {
+          "Unarchive": {
+            "$ref": "./examples/Unarchive.json"
+          }
+        },
+        "parameters": [
+          {
+            "$ref": "#/parameters/ReservationOrderIdParameter"
+          },
+          {
+            "$ref": "#/parameters/ReservationIdParameter"
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          }
+        ],
+        "tags": [
+          "Reservation, Unarchive"
+        ],
+        "responses": {
+          "200": {
+            "description": "Unarchive complete for the reservation."
+          },
+          "default": {
+            "description": "Unexpected error",
+            "schema": {
+              "$ref": "#/definitions/Error"
+            }
+          }
+        }
+      }
+    },
     "/providers/Microsoft.Capacity/operations": {
       "get": {
         "summary": "Get operations.",
@@ -1639,6 +1713,27 @@
           "format": "double"
         }
       }
+    },
+    "AvailableScopeRequest": {
+      "type": "object",
+      "properties": {
+        "properties": {
+          "$ref": "#/definitions/AvailableScopeRequestProperties"
+        }
+      }
+    },
+    "AvailableScopeRequestProperties": {
+      "description": "List of scopes for which availability should be checked",
+      "type": "object",
+      "properties": {
+        "scopes": {
+          "description": "Scopes to be checked for availability",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
     }
   },
   "parameters": {
@@ -1647,11 +1742,9 @@
       "x-ms-parameter-location": "method",
       "in": "body",
       "required": true,
+      "description": "Parameter for listing the available scopes",
       "schema": {
-        "type": "array",
-        "items": {
-          "type": "string"
-        }
+        "$ref": "#/definitions/AvailableScopeRequest"
       }
     },
     "PurchaseParameter": {