Mark backup & restore operations as long running (#9898)

* Adding 7.2-preview version (#8397) * Adding 7.2-preview version Signed-off-by: vasanthrajams <[email protected]> * Resolve PR feedback * Fix output-folder for go code generation Co-authored-by: Heath Stewart <[email protected]> * Marking backup/restore/selective key restore operation as LRO In this PR, marking the all long running operations appropriately using x-ms-long-running-operation. Signed-off-by: vasanthrajams <[email protected]> * pretty check Co-authored-by: Heath Stewart <[email protected]> Co-authored-by: vasanthrajams <[email protected]>
Azure · Jun 26, 2020 · 5917eba · 5917eba
1 parent c1ea606
commit 5917eba
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 11 deletions.
diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/backuprestore.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/backuprestore.json
@@ -33,6 +33,10 @@
           "FullBackup"
         ],
         "operationId": "FullBackup",
+        "x-ms-long-running-operation": true,
+        "x-ms-long-running-operation-options": {
+          "final-state-via": "azure-async-operation"
+        },
         "description": "Creates a full backup using a user-provided SAS token to an Azure blob storage container.",
         "parameters": [
           {
@@ -124,6 +128,10 @@
           "FullRestore"
         ],
         "operationId": "FullRestoreOperation",
+        "x-ms-long-running-operation": true,
+        "x-ms-long-running-operation-options": {
+          "final-state-via": "azure-async-operation"
+        },
         "description": "Restores all key materials using the SAS token pointing to a previously stored Azure Blob storage backup folder",
         "parameters": [
           {
@@ -152,7 +160,7 @@
               }
             },
             "schema": {
-              "$ref": "#/definitions/FullRestoreOperation"
+              "$ref": "#/definitions/RestoreOperation"
             }
           },
           "default": {
@@ -174,15 +182,15 @@
         "tags": [
           "FullRestore"
         ],
-        "operationId": "FullRestoreStatus",
-        "description": "Returns the status of full restore operation",
+        "operationId": "RestoreStatus",
+        "description": "Returns the status of restore operation",
         "parameters": [
           {
             "name": "jobId",
             "in": "path",
             "required": true,
             "type": "string",
-            "description": "The Job Id returned part of the full restore operation"
+            "description": "The Job Id returned part of the restore operation"
           },
           {
             "$ref": "#/parameters/ApiVersionParameter"
@@ -192,7 +200,7 @@
           "200": {
             "description": "OK - Returns the full restore status",
             "schema": {
-              "$ref": "#/definitions/FullRestoreOperation"
+              "$ref": "#/definitions/RestoreOperation"
             }
           },
           "default": {
@@ -203,8 +211,8 @@
           }
         },
         "x-ms-examples": {
-          "Full restore status": {
-            "$ref": "./examples/FullRestore-pending-example.json"
+          "Restore status": {
+            "$ref": "./examples/Restore-pending-example.json"
           }
         }
       }
@@ -215,6 +223,10 @@
           "Keys"
         ],
         "operationId": "SelectiveKeyRestoreOperation",
+        "x-ms-long-running-operation": true,
+        "x-ms-long-running-operation-options": {
+          "final-state-via": "azure-async-operation"
+        },
         "description": "Restores all key versions of a given key using user supplied SAS token pointing to a previously stored Azure Blob storage backup folder",
         "parameters": [
           {
@@ -381,7 +393,7 @@
       },
       "description": "Full backup operation"
     },
-    "FullRestoreOperation": {
+    "RestoreOperation": {
       "properties": {
         "status": {
           "type": "string",
@@ -393,11 +405,11 @@
         },
         "error": {
           "$ref": "common.json#/definitions/Error",
-          "description": "Error encountered, if any, during the full restore operation."
+          "description": "Error encountered, if any, during the restore operation."
         },
         "jobId": {
           "type": "string",
-          "description": "Identifier for the full restore operation."
+          "description": "Identifier for the restore operation."
         },
         "startTime": {
           "type": "integer",
@@ -410,7 +422,7 @@
           "description": "The end time of the restore operation"
         }
       },
-      "description": "Full restore operation"
+      "description": "Restore operation"
     }
   },
   "parameters": {

diff --git a/...examples/FullRestore-pending-example.json → ...iew/examples/Restore-pending-example.json b/...examples/FullRestore-pending-example.json → ...iew/examples/Restore-pending-example.json