[Storage] Support Failover #4107
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "parameters": { | ||
| "subscriptionId": "{subscription-id}", | ||
| "resourceGroupName": "res4228", | ||
| "accountName": "sto2434", | ||
| "api-version": "2018-07-01", | ||
| "monitor": "true" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": "" | ||
| }, | ||
| "202": { | ||
| "body": "" | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "parameters": { | ||
| "subscriptionId": "{subscription-id}", | ||
| "resourceGroupName": "res4228", | ||
| "accountName": "sto2434", | ||
| "api-version": "2018-07-01", | ||
| "monitor": "true" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "status": "Live", | ||
| "lastSyncTime": "2017-05-24T13:25:33Z" | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -164,7 +164,10 @@ | |
| "description": "Accepted -- Create or update request accepted; operation will complete asynchronously." | ||
| } | ||
| }, | ||
| "x-ms-long-running-operation": true, | ||
| "x-ms-long-running-operation-options": { | ||
| "final-state-via": "location" | ||
| } | ||
| }, | ||
| "delete": { | ||
| "tags": [ | ||
|
|
@@ -555,6 +558,82 @@ | |
| } | ||
| } | ||
| } | ||
| }, | ||
| "/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" | ||
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/lastSyncTime": { | ||
| "get": { | ||
| "tags": [ | ||
| "StorageAccounts" | ||
| ], | ||
| "operationId": "StorageAccounts_GetLastSyncTime", | ||
| "description": "Retrieve last sync time for his or her RA-GRS and GRS accounts.", | ||
| "x-ms-examples": { | ||
| "StorageAccountGetProperties": { | ||
| "$ref": "./examples/StorageAccountGetLastSyncTime.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 -- last sync time retrieved successfully for the storage account.", | ||
| "schema": { | ||
| "$ref": "#/definitions/GetLastSyncTimeResult" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
|
|
@@ -1375,8 +1454,14 @@ | |
| }, | ||
| "isHnsEnabled": { | ||
| "type": "boolean", | ||
| "x-ms-client-name": "IsHnsEnabled", | ||
| "description": "Account HierarchicalNamespace enabled if sets to true." | ||
| }, | ||
| "failoverInProgress": { | ||
|
There was a problem hiding this comment. can you make this a generic property like "status" with states like failing over etc. It will allow you reuse the same property for other status related information in future. There was a problem hiding this comment. This status is a very special status just for Get LST from secondary location status. I don't see any possibility that it can be reused by any other APIs in the recent future. So I would prefer to keep it as what it is now. There was a problem hiding this comment. Ok lets atleast make this a string enum. bools are less descriptive and dont allow for future expansion of states. There was a problem hiding this comment. @ravbhatnagar There was a problem hiding this comment. Ok, thats fine. i just wanted to note that we are strongly recommending teams against using bools. Even if its just two states, string enums work much better. Its fine if you dont want to change it. There was a problem hiding this comment. Thanks！ I will take care of every bool value usage in swagger. |
||
| "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." | ||
|
|
@@ -1876,6 +1961,31 @@ | |
| } | ||
| }, | ||
| "description": "The List service SAS credentials operation response." | ||
| }, | ||
| "GetLastSyncTimeResult": { | ||
| "properties": { | ||
| "status": { | ||
| "readOnly": true, | ||
| "type": "string", | ||
| "description": "The status of the secondary location of the Storage Account. Live: Indicates that the secondary location is active and operational; Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress, this typically occurs when replication is first enabled; Unavailable: Indicates that the secondary location is temporarily unavailable. ", | ||
| "enum": [ | ||
| "Live", | ||
| "Bootstrap", | ||
| "Unavailable" | ||
| ], | ||
| "x-ms-enum": { | ||
| "name": "ReplicationStatus", | ||
| "modelAsString": true | ||
| } | ||
| }, | ||
| "lastSyncTime": { | ||
| "readOnly": true, | ||
| "type": "string", | ||
| "format": "date-time", | ||
| "description": "All primary writes preceding this value are guaranteed to be replicated to secondary. Primary writes after this point in time may or may not be replicated. It is the minimum last sync time of the account’s Blob/Table/Queue/File endpoints. The value may be account’s creation time if LastSyncTime is not available. This can happen if the replication status is bootstrap or unavailable. " | ||
| } | ||
| }, | ||
| "description": "The response from the get last synctime operation." | ||
| } | ||
| }, | ||
| "parameters": { | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why isnt last sync time exposes as a property on the storage account itself?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From the feature team:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In that case, it could be returned using a $expand query parameter. Only when the user explicitly specifies this, then you return this as a property on the storage account. By default, just doing get does not return it.
It really seems like a property of the account and in the current way of modeling it makes it looks like a nested resource under storageAccount which it is not.