Generated from 1f26996e492bf786c2acd06e0a4e46159c52df70 (#4091)

Adds storage account quick failover API

lib/services/storageManagement2/lib/models/index.d.ts

@@ -793,6 +793,8 @@ export interface TrackedResource extends Resource {
  * 'Allow', 'Deny'
  * @member {boolean} [isHnsEnabled] Account HierarchicalNamespace enabled if
  * sets to true.
+ * @member {boolean} [failoverInProgress] If the failover is in progress, the
+ * value will be true, otherwise, it will be null.
  */
 export interface StorageAccount extends TrackedResource {
   readonly sku?: Sku;
@@ -814,6 +816,7 @@ export interface StorageAccount extends TrackedResource {
   enableHttpsTrafficOnly?: boolean;
   readonly networkRuleSet?: NetworkRuleSet;
   isHnsEnabled?: boolean;
+  readonly failoverInProgress?: boolean;
 }
 
 /**

lib/services/storageManagement2/lib/models/storageAccount.js

@@ -168,6 +168,8 @@ class StorageAccount extends models['TrackedResource'] {
    * include: 'Allow', 'Deny'
    * @member {boolean} [isHnsEnabled] Account HierarchicalNamespace enabled if
    * sets to true.
+   * @member {boolean} [failoverInProgress] If the failover is in progress, the
+   * value will be true, otherwise, it will be null.
    */
   constructor() {
     super();
@@ -391,6 +393,14 @@ class StorageAccount extends models['TrackedResource'] {
             type: {
               name: 'Boolean'
             }
+          },
+          failoverInProgress: {
+            required: false,
+            readOnly: true,
+            serializedName: 'properties.failoverInProgress',
+            type: {
+              name: 'Boolean'
+            }
           }
         }
       }

lib/services/storageManagement2/lib/operations/index.d.ts

@@ -1466,6 +1466,76 @@ export interface StorageAccounts {
     listServiceSAS(resourceGroupName: string, accountName: string, parameters: models.ServiceSasParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.ListServiceSasResponse>): void;
 
 
+    /**
+     * 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.
+     *
+     * @param {string} resourceGroupName The name of the resource group within the
+     * user's subscription. The name is case insensitive.
+     *
+     * @param {string} accountName The name of the storage account within the
+     * specified resource group. Storage account names must be between 3 and 24
+     * characters in length and use numbers and lower-case letters only.
+     *
+     * @param {object} [options] Optional Parameters.
+     *
+     * @param {object} [options.customHeaders] Headers that will be added to the
+     * request
+     *
+     * @returns {Promise} A promise is returned
+     *
+     * @resolve {HttpOperationResponse<null>} - The deserialized result object.
+     *
+     * @reject {Error|ServiceError} - The error object.
+     */
+    failoverWithHttpOperationResponse(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>;
+
+    /**
+     * 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.
+     *
+     * @param {string} resourceGroupName The name of the resource group within the
+     * user's subscription. The name is case insensitive.
+     *
+     * @param {string} accountName The name of the storage account within the
+     * specified resource group. Storage account names must be between 3 and 24
+     * characters in length and use numbers and lower-case letters only.
+     *
+     * @param {object} [options] Optional Parameters.
+     *
+     * @param {object} [options.customHeaders] Headers that will be added to the
+     * request
+     *
+     * @param {ServiceCallback} [optionalCallback] - The optional callback.
+     *
+     * @returns {ServiceCallback|Promise} If a callback was passed as the last
+     * parameter then it returns the callback else returns a Promise.
+     *
+     * {Promise} A promise is returned.
+     *
+     *                      @resolve {null} - The deserialized result object.
+     *
+     *                      @reject {Error|ServiceError} - The error object.
+     *
+     * {ServiceCallback} optionalCallback(err, result, request, response)
+     *
+     *                      {Error|ServiceError}  err        - The Error object if an error occurred, null otherwise.
+     *
+     *                      {null} [result]   - The deserialized result object if an error did not occur.
+     *
+     *                      {WebResource} [request]  - The HTTP Request object if an error did not occur.
+     *
+     *                      {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
+     */
+    failover(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>;
+    failover(resourceGroupName: string, accountName: string, callback: ServiceCallback<void>): void;
+    failover(resourceGroupName: string, accountName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void;
+
+
     /**
      * Asynchronously creates a new storage account with the specified parameters.
      * If an account is already created and a subsequent create request is issued
@@ -1751,6 +1821,76 @@ export interface StorageAccounts {
     beginCreate(resourceGroupName: string, accountName: string, parameters: models.StorageAccountCreateParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<models.StorageAccount>;
     beginCreate(resourceGroupName: string, accountName: string, parameters: models.StorageAccountCreateParameters, callback: ServiceCallback<models.StorageAccount>): void;
     beginCreate(resourceGroupName: string, accountName: string, parameters: models.StorageAccountCreateParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.StorageAccount>): void;
+
+
+    /**
+     * 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.
+     *
+     * @param {string} resourceGroupName The name of the resource group within the
+     * user's subscription. The name is case insensitive.
+     *
+     * @param {string} accountName The name of the storage account within the
+     * specified resource group. Storage account names must be between 3 and 24
+     * characters in length and use numbers and lower-case letters only.
+     *
+     * @param {object} [options] Optional Parameters.
+     *
+     * @param {object} [options.customHeaders] Headers that will be added to the
+     * request
+     *
+     * @returns {Promise} A promise is returned
+     *
+     * @resolve {HttpOperationResponse<null>} - The deserialized result object.
+     *
+     * @reject {Error|ServiceError} - The error object.
+     */
+    beginFailoverWithHttpOperationResponse(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>;
+
+    /**
+     * 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.
+     *
+     * @param {string} resourceGroupName The name of the resource group within the
+     * user's subscription. The name is case insensitive.
+     *
+     * @param {string} accountName The name of the storage account within the
+     * specified resource group. Storage account names must be between 3 and 24
+     * characters in length and use numbers and lower-case letters only.
+     *
+     * @param {object} [options] Optional Parameters.
+     *
+     * @param {object} [options.customHeaders] Headers that will be added to the
+     * request
+     *
+     * @param {ServiceCallback} [optionalCallback] - The optional callback.
+     *
+     * @returns {ServiceCallback|Promise} If a callback was passed as the last
+     * parameter then it returns the callback else returns a Promise.
+     *
+     * {Promise} A promise is returned.
+     *
+     *                      @resolve {null} - The deserialized result object.
+     *
+     *                      @reject {Error|ServiceError} - The error object.
+     *
+     * {ServiceCallback} optionalCallback(err, result, request, response)
+     *
+     *                      {Error|ServiceError}  err        - The Error object if an error occurred, null otherwise.
+     *
+     *                      {null} [result]   - The deserialized result object if an error did not occur.
+     *
+     *                      {WebResource} [request]  - The HTTP Request object if an error did not occur.
+     *
+     *                      {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
+     */
+    beginFailover(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>;
+    beginFailover(resourceGroupName: string, accountName: string, callback: ServiceCallback<void>): void;
+    beginFailover(resourceGroupName: string, accountName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void;
 }
 
 /**