mgmt cosmos, support automaticfailover for CosmosDBAccount (#45751)

* code change

* add revapi.json to include premium packages check

* Update sdk/resourcemanager/azure-resourcemanager-cosmos/src/main/java/com/azure/resourcemanager/cosmos/models/CosmosDBAccount.java

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* address comments

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: XiaofeiCao

eng/code-quality-reports/src/main/resources/revapi/revapi.json

@@ -177,8 +177,8 @@
         {
           "regex": true,
           "code": "java\\.method\\.addedToInterface",
-          "new": "method .* com\\.azure\\.resourcemanager\\..*",
-          "justification": "resourcemanager interfaces are allowed to add methods."
+          "new": "method .* com\\.azure\\.resourcemanager\\.(?!appplatform|appservice|authorization|cdn|compute|containerinstance|containerregistry|containerservice|cosmos|dns|eventhubs|keyvault|monitor|msi|network|privatedns|redis|resources|search|servicebus|sql|storage|trafficmanager).*",
+          "justification": "resourcemanager interfaces are allowed to add methods, except for the 24 specific premium libraries."
         },
         {
           "regex": true,

sdk/resourcemanager/azure-resourcemanager-cosmos/CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### Features Added
 
+- Supported `automaticFailoverEnabled()`, `enableAutomaticFailover` and `disableAutomaticFailover` in `CosmosDBAccount`.
+
 ### Breaking Changes
 
 ### Bugs Fixed

sdk/resourcemanager/azure-resourcemanager-cosmos/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "java",
   "TagPrefix": "java/resourcemanager/azure-resourcemanager-cosmos",
-  "Tag": "java/resourcemanager/azure-resourcemanager-cosmos_b947f3e69a"
+  "Tag": "java/resourcemanager/azure-resourcemanager-cosmos_cf91e9829d"
 }

sdk/resourcemanager/azure-resourcemanager-cosmos/src/main/java/com/azure/resourcemanager/cosmos/implementation/CosmosDBAccountImpl.java

@@ -322,6 +322,11 @@ public boolean localAuthDisabled() {
         return ResourceManagerUtils.toPrimitiveBoolean(this.innerModel().disableLocalAuth());
     }
 
+    @Override
+    public boolean automaticFailoverEnabled() {
+        return ResourceManagerUtils.toPrimitiveBoolean(this.innerModel().enableAutomaticFailover());
+    }
+
     @Override
     public CosmosDBAccountImpl withKind(DatabaseAccountKind kind) {
         this.innerModel().withKind(kind);
@@ -801,6 +806,18 @@ public CosmosDBAccountImpl disableLocalAuth() {
         return this;
     }
 
+    @Override
+    public CosmosDBAccountImpl enableAutomaticFailover() {
+        this.innerModel().withEnableAutomaticFailover(true);
+        return this;
+    }
+
+    @Override
+    public CosmosDBAccountImpl disableAutomaticFailover() {
+        this.innerModel().withEnableAutomaticFailover(false);
+        return this;
+    }
+
     interface HasLocations {
         String location();
 

sdk/resourcemanager/azure-resourcemanager-cosmos/src/main/java/com/azure/resourcemanager/cosmos/models/CosmosDBAccount.java

@@ -306,6 +306,18 @@ public interface CosmosDBAccount extends GroupableResource<CosmosManager, Databa
      */
     boolean localAuthDisabled();
 
+    /**
+     * Checks whether automatic failover is enabled.
+     * Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage.
+     * Automatic failover will result in a new write region for the account and is chosen based on the failover
+     * priorities configured for the account.
+     *
+     * @return whether automatic failover is enabled
+     */
+    default boolean automaticFailoverEnabled() {
+        throw new UnsupportedOperationException("[automaticFailoverEnabled] is not supported in " + getClass());
+    }
+
     /** Grouping of cosmos db definition stages. */
     interface Definition extends DefinitionStages.Blank, DefinitionStages.WithGroup, DefinitionStages.WithKind,
         DefinitionStages.WithWriteReplication, DefinitionStages.WithReadReplication, DefinitionStages.WithCreate {
@@ -544,13 +556,28 @@ interface WithLocalAuth {
             WithCreate disableLocalAuth();
         }
 
+        /**
+         * The stage of CosmosDB account definition allowing to enable automatic failover.
+         */
+        interface WithAutomaticFailover {
+            /**
+             * Disables automatic failover.
+             *
+             * @return the next stage of the definition
+             */
+            default WithCreate disableAutomaticFailover() {
+                throw new UnsupportedOperationException("[disableAutomaticFailover] is not supported in " + getClass());
+            }
+        }
+
         /**
          * The stage of the definition which contains all the minimum required inputs for the resource to be created,
          * but also allows for any other optional settings to be specified.
          */
         interface WithCreate extends Creatable<CosmosDBAccount>, WithConsistencyPolicy, WithReadReplication,
             WithIpRules, WithVirtualNetworkRule, WithMultipleLocations, WithConnector, WithKeyBasedMetadataWriteAccess,
-            WithPrivateEndpointConnection, DefinitionWithTags<WithCreate>, WithPublicNetworkAccess, WithLocalAuth {
+            WithPrivateEndpointConnection, DefinitionWithTags<WithCreate>, WithPublicNetworkAccess, WithLocalAuth,
+            WithAutomaticFailover {
         }
     }
 
@@ -564,7 +591,8 @@ interface UpdateStages {
         interface WithOptionals extends Resource.UpdateWithTags<WithOptionals>, Appliable<CosmosDBAccount>,
             UpdateStages.WithConsistencyPolicy, UpdateStages.WithVirtualNetworkRule, UpdateStages.WithMultipleLocations,
             UpdateStages.WithConnector, UpdateStages.WithKeyBasedMetadataWriteAccess,
-            UpdateStages.WithPrivateEndpointConnection, UpdateStages.WithIpRules, UpdateStages.WithPublicNetworkAccess {
+            UpdateStages.WithPrivateEndpointConnection, UpdateStages.WithIpRules, UpdateStages.WithPublicNetworkAccess,
+            UpdateStages.WithAutomaticFailover {
         }
 
         /** The stage of the cosmos db definition allowing the definition of a write location. */
@@ -763,5 +791,30 @@ interface WithPublicNetworkAccess {
              */
             Update disablePublicNetworkAccess();
         }
+
+        /**
+         * The stage of CosmosDB account update allowing to toggle automatic failover.
+         */
+        interface WithAutomaticFailover {
+            /**
+             * Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage.
+             * Automatic failover will result in a new write region for the account and is chosen based on the failover
+             * priorities configured for the account.
+             *
+             * @return the next stage of the update
+             */
+            default Update enableAutomaticFailover() {
+                throw new UnsupportedOperationException("[enableAutomaticFailover] is not supported in " + getClass());
+            }
+
+            /**
+             * Disables automatic failover.
+             *
+             * @return the next stage of the update
+             */
+            default Update disableAutomaticFailover() {
+                throw new UnsupportedOperationException("[disableAutomaticFailover] is not supported in " + getClass());
+            }
+        }
     }
 }

sdk/resourcemanager/azure-resourcemanager-cosmos/src/test/java/com/azure/resourcemanager/cosmos/CosmosDBTests.java

@@ -299,4 +299,28 @@ public void canUpdatePublicNetworkAccess() {
         cosmosDBAccount.update().enablePublicNetworkAccess().apply();
         Assertions.assertEquals(PublicNetworkAccess.ENABLED, cosmosDBAccount.publicNetworkAccess());
     }
+
+    @Test
+    public void canEnableAutomaticFailover() {
+        final String cosmosDbAccountName = generateRandomResourceName("cosmosdb", 22);
+
+        CosmosDBAccount cosmosDBAccount = cosmosManager.databaseAccounts()
+            .define(cosmosDbAccountName)
+            .withRegion(Region.US_WEST_CENTRAL)
+            .withNewResourceGroup(rgName)
+            .withDataModelAzureTable()
+            .withEventualConsistency()
+            .withWriteReplication(Region.US_EAST2)
+            .withReadReplication(Region.US_WEST)
+            .disableLocalAuth()
+            .create();
+        // By default, it's enabled.
+        Assertions.assertTrue(cosmosDBAccount.automaticFailoverEnabled());
+
+        cosmosDBAccount.update().disableAutomaticFailover().apply();
+        Assertions.assertFalse(cosmosDBAccount.automaticFailoverEnabled());
+
+        cosmosDBAccount.update().enableAutomaticFailover().apply();
+        Assertions.assertTrue(cosmosDBAccount.automaticFailoverEnabled());
+    }
 }