Adds storage account quick failover API (#4457)

Azure · Nov 14, 2018 · 10ec74f · 10ec74f
1 parent f8465de
commit 10ec74f
Show file tree

Hide file tree

Showing 2 changed files with 63 additions and 0 deletions.
diff --git a/...resource-manager/Microsoft.Storage/stable/2018-07-01/examples/StorageAccountFailover.json b/...resource-manager/Microsoft.Storage/stable/2018-07-01/examples/StorageAccountFailover.json
@@ -0,0 +1,17 @@
+{
+  "parameters": {
+    "subscriptionId": "{subscription-id}",
+    "resourceGroupName": "res4228",
+    "accountName": "sto2434",
+    "api-version": "2018-07-01",
+    "monitor": "true"
+  },
+  "responses": {
+    "200": {
+      "body": ""
+    },
+    "202": {
+      "body": ""
+    }
+  }
+}
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json
@@ -555,6 +555,46 @@
           }
         }
       }
+    },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/failover": {
+      "post": {
+        "tags": [
+          "StorageAccounts"
+        ],
+        "operationId": "StorageAccounts_Failover",
+        "description": "Failover request can be triggered for a storage account in case of availability issues. The failover occurs from the storage account's primary cluster to secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover.",
+        "x-ms-examples": {
+          "StorageAccountCreate": {
+            "$ref": "./examples/StorageAccountFailover.json"
+          }
+        },
+        "parameters": [
+          {
+            "$ref": "#/parameters/ResourceGroupName"
+          },
+          {
+            "$ref": "#/parameters/StorageAccountName"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK -- Returned when the storage account failover is completed, and the secondary cluster has become primary."
+          },
+          "202": {
+            "description": "Accepted -- Failover request accepted; operation will complete asynchronously."
+          }
+        },
+        "x-ms-long-running-operation": true,
+        "x-ms-long-running-operation-options": {
+          "final-state-via": "location"
+        }
+      }
     }
   },
   "definitions": {
@@ -1377,6 +1417,12 @@
           "type": "boolean",
            "x-ms-client-name": "IsHnsEnabled",
            "description": "Account HierarchicalNamespace enabled if sets to true."
+        },
+        "failoverInProgress": {
+          "type": "boolean",
+          "x-ms-client-name": "FailoverInProgress ",
+          "description": "If the failover is in progress, the value will be true, otherwise, it will be null.",
+          "readOnly": true
         }
       },
       "description": "Properties of the storage account."