[cosmosdb-preview] Add support for Fleet/Fleetspace/FleetspaceAccount/FleetAnalytics CRUD actions (#8803)

* Added latest python SDK

* Fleet and Fleetspace New commands

* Fleet and Fleetspace commands fixes

* FleetspaceAccount commands and tests

* Fleet analytics commands

* fix issues

* fixed tests recordings

* Fixed rest of tests

---------

Co-authored-by: Praful Johari <pjohari@microsoft.com>

Author: amatarritamicrosoft

src/cosmosdb-preview/HISTORY.rst

@@ -1,6 +1,10 @@
 .. :changelog:
 Release History
 ===============
+1.6.0
+* Add support for Fleet/Fleetspace/FleetspaceAccount/FleetAnalytics CRUD actions.
+
++++++++
 1.5.0
 * Add support for Gremlin/Cassandra/Mongo RBAC role definition and assignment CRUD actions.
 

src/cosmosdb-preview/azext_cosmosdb_preview/_client_factory.py

@@ -102,3 +102,20 @@ def cf_mongo_clusters(cli_ctx, _):
 
 def cf_mongo_cluster_firewall_rules(cli_ctx, _):
     return cf_mongocluster_preview(cli_ctx).firewall_rules
+
+
+# fleet
+def cf_fleet(cli_ctx, _):
+    return cf_cosmosdb_preview(cli_ctx).fleet
+
+
+def cf_fleetspace(cli_ctx, _):
+    return cf_cosmosdb_preview(cli_ctx).fleetspace
+
+
+def cf_fleetspace_account(cli_ctx, _):
+    return cf_cosmosdb_preview(cli_ctx).fleetspace_account
+
+
+def cf_fleet_analytics(cli_ctx, _):
+    return cf_cosmosdb_preview(cli_ctx).fleet_analytics

src/cosmosdb-preview/azext_cosmosdb_preview/_help.py

@@ -1699,3 +1699,148 @@
         --scope "/dbs/mydb/colls/mycontainer" \\
         --principal-id 6328f5f7-dbf7-4244-bba8-fbb9d8066506
 """
+
+helps['cosmosdb fleet'] = """
+type: group
+short-summary: Manage Azure Cosmos DB Fleet resources.
+"""
+
+helps['cosmosdb fleet create'] = """
+type: command
+short-summary: Create a new Cosmos DB Fleet.
+examples:
+  - name: Create a fleet
+    text: |
+      az cosmosdb fleet create \\
+        --resource-group MyResourceGroup \\
+        --fleet-name MyFleet \\
+        --location westus
+"""
+
+helps['cosmosdb fleet list'] = """
+type: command
+short-summary: List Cosmos DB Fleets in a subscription or resource group.
+"""
+
+helps['cosmosdb fleet show'] = """
+type: command
+short-summary: Show details of a specific Cosmos DB Fleet.
+"""
+
+helps['cosmosdb fleet delete'] = """
+type: command
+short-summary: Delete a specific Cosmos DB Fleet.
+"""
+
+helps['cosmosdb fleetspace'] = """
+type: group
+short-summary: Manage Cosmos DB Fleetspace resources.
+"""
+
+helps['cosmosdb fleetspace create'] = """
+type: command
+short-summary: Create a new Fleetspace under a Cosmos DB Fleet.
+examples:
+  - name: Create a fleetspace
+    text: |
+      az cosmosdb fleetspace create \\
+        --resource-group MyResourceGroup \\
+        --fleet-name MyFleet \\
+        --fleetspace-name MyFleetspace \\
+        --body @fleetspace.json
+"""
+
+helps['cosmosdb fleetspace update'] = """
+type: command
+short-summary: Update an existing Cosmos DB Fleetspace.
+examples:
+  - name: Update fleetspace throughput settings
+    text: |
+      az cosmosdb fleetspace update \\
+        --resource-group MyResourceGroup \\
+        --fleet-name MyFleet \\
+        --fleetspace-name MyFleetspace \\
+        --body @fleetspace.json
+"""
+
+helps['cosmosdb fleetspace list'] = """
+type: command
+short-summary: List all Fleetspaces under a Fleet.
+"""
+
+helps['cosmosdb fleetspace show'] = """
+type: command
+short-summary: Show details of a specific Fleetspace.
+"""
+
+helps['cosmosdb fleetspace delete'] = """
+type: command
+short-summary: Delete a Fleetspace from a Fleet.
+"""
+
+helps['cosmosdb fleetspace account'] = """
+type: group
+short-summary: Manage database accounts within a Cosmos DB Fleetspace.
+"""
+
+helps['cosmosdb fleetspace account create'] = """
+type: command
+short-summary: Register an existing Cosmos DB database account to a Fleetspace.
+examples:
+  - name: Register a database account to a fleetspace
+    text: |
+      az cosmosdb fleetspace account create \\
+        --resource-group MyResourceGroup \\
+        --fleet-name MyFleet \\
+        --fleetspace-name MyFleetspace \\
+        --fleetspace-account-name MyAccount \\
+        --body @fleetspaceAccount.json
+"""
+
+helps['cosmosdb fleetspace account list'] = """
+type: command
+short-summary: List all database accounts associated with a Fleetspace.
+"""
+
+helps['cosmosdb fleetspace account show'] = """
+type: command
+short-summary: Show details of a registered database account in a Fleetspace.
+"""
+
+helps['cosmosdb fleetspace account delete'] = """
+type: command
+short-summary: Unregister a database account from a Fleetspace.
+"""
+
+helps['cosmosdb fleet analytics'] = """
+type: group
+short-summary: Manage Azure Cosmos DB Fleet Analytics resources.
+"""
+
+helps['cosmosdb fleet analytics create'] = """
+type: command
+short-summary: Create a new Fleet Analytics resource under a Cosmos DB Fleet.
+examples:
+  - name: Create a Fleet Analytics resource
+    text: |
+      az cosmosdb fleet analytics create \\
+        --resource-group MyResourceGroup \\
+        --fleet-name MyFleet \\
+        --fleet-analytics-name MyFleetAnalytics \\
+        --body @fleetAnalytics.json
+"""
+
+helps['cosmosdb fleet analytics show'] = """
+type: command
+short-summary: Show details of a specific Fleet Analytics resource.
+"""
+
+helps['cosmosdb fleet analytics list'] = """
+type: command
+short-summary: List all Fleet Analytics resources under a Fleet.
+"""
+
+helps['cosmosdb fleet analytics delete'] = """
+type: command
+short-summary: Delete a Fleet Analytics resource from a Fleet.
+"""

src/cosmosdb-preview/azext_cosmosdb_preview/_params.py

@@ -29,7 +29,10 @@
     validate_cassandra_role_assignment_id,
     validate_mongoMI_role_definition_body,
     validate_mongoMI_role_definition_id,
-    validate_mongoMI_role_assignment_id)
+    validate_mongoMI_role_assignment_id,
+    validate_fleetspace_body,
+    validate_fleetspaceAccount_body,
+    validate_fleet_analytics_body)
 
 from azext_cosmosdb_preview.actions import (
     CreateGremlinDatabaseRestoreResource,
@@ -196,6 +199,37 @@
 """
 
 
+FLEETSPACE_PROPERTIES_EXAMPLE = """--body "{
+    \\"properties\\": {
+        \\"throughputPoolConfiguration\\": {
+            \\"minThroughput\\": 100000,
+            \\"maxThroughput\\": 300000,
+            \\"serviceTier\\": \\"GeneralPurpose\\",
+            \\"dataRegions\\": [\\"West US 2\\"]
+        },
+    }
+}"
+"""
+
+FLEETSPACE_ACCOUNT_PROPERTIES_EXAMPLE = """--body "{
+    \\"properties\\": {
+        \\"globalDatabaseAccountProperties\\": {
+            \\"resourceId\\": \\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-rg/providers/Microsoft.DocumentDB/databaseAccounts/example-account\\",
+            \\"armLocation\\": \\"East US\\"
+        }
+    }
+}"
+"""
+
+FLEET_ANALYTICS_PROPERTIES_EXAMPLE = """--body "{
+    \\"properties\\": {
+        \\"storageLocationType\\": \\"StorageAccount\\",
+        \\"storageLocationUri\\": \\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/exampleaccount\\"
+    }
+}"
+"""
+
+
 class ThroughputTypes(str, Enum):
     autoscale = "autoscale"
     manual = "manual"
@@ -794,3 +828,43 @@ def load_arguments(self, _):
         c.argument('role_definition_name', options_list=['--role-definition-name', '-n'], help="Unique Name of the Role Definition that this Role Assignment refers to. Eg. 'Contoso Reader Role'.")
         c.argument('scope', options_list=['--scope', '-s'], help="Data plane resource path at which this Role Assignment is being granted.")
         c.argument('principal_id', options_list=['--principal-id', '-p'], help="AAD Object ID of the principal to which this Role Assignment is being granted.")
+
+    # Cosmos DB Fleet
+    with self.argument_context('cosmosdb fleet') as c:
+        c.argument('resource_group', options_list=['--resource-group', '-g'], help='Name of the resource group.', required=True)
+        c.argument('fleet_name', options_list=['--fleet-name', '-n'], help='Name of the Fleet resource.', required=True)
+
+    with self.argument_context('cosmosdb fleet create') as c:
+        c.argument('location', options_list=['--location', '-l'], help='Location of the Fleet.', required=True)
+        c.argument('tags', help="Tags in 'key=value key2=value2' format.")
+
+    # Cosmos DB Fleet Analytics
+    with self.argument_context('cosmosdb fleet analytics') as c:
+        c.argument('resource_group', options_list=['--resource-group', '-g'], help='Name of the resource group.', required=True)
+        c.argument('fleet_name', options_list=['--fleet-name'], help='Name of the Cosmos DB Fleet.', required=True)
+        c.argument('fleet_analytics_name', options_list=['--fleet-analytics-name', '-n'], help='Name of the Fleet Analytics resource.', required=True)
+
+    with self.argument_context('cosmosdb fleet analytics create') as c:
+        c.argument('fleet_analytics_body', options_list=['--body', '-b'], validator=validate_fleet_analytics_body, completer=FilesCompleter(), help="Fleet Analytics body with properties (fields: storageLocationType, storageLocationUri). You can enter it as a string or as a file, e.g., --body @fleetAnalytics.json or " + FLEET_ANALYTICS_PROPERTIES_EXAMPLE)
+
+    # Cosmos DB Fleetspace
+    with self.argument_context('cosmosdb fleetspace') as c:
+        c.argument('resource_group', options_list=['--resource-group', '-g'], help='Name of the resource group.', required=True)
+        c.argument('fleet_name', options_list=['--fleet-name'], help='Name of the Cosmos DB Fleet.', required=True)
+        c.argument('fleetspace_name', options_list=['--fleetspace-name', '-n'], help='Name of the Fleetspace resource.', required=True)
+
+    with self.argument_context('cosmosdb fleetspace create') as c:
+        c.argument('fleetspace_body', options_list=['--body', '-b'], validator=validate_fleetspace_body, completer=FilesCompleter(), help="Fleetspace body with properties.throughputPoolConfiguration (fields: minThroughput, maxThroughput, serviceTier, dataRegions). You can enter it as a string or as a file, e.g., --body @fleetspace.json or " + FLEETSPACE_PROPERTIES_EXAMPLE)
+
+    with self.argument_context('cosmosdb fleetspace update') as c:
+        c.argument('fleetspace_body', options_list=['--body', '-b'], validator=validate_fleetspace_body, completer=FilesCompleter(), help="Fleetspace body with properties.throughputPoolConfiguration (fields: minThroughput, maxThroughput, serviceTier, dataRegions). You can enter it as a string or as a file, e.g., --body @fleetspace.json or " + FLEETSPACE_PROPERTIES_EXAMPLE)
+
+    # Cosmos DB Fleetspace account
+    with self.argument_context('cosmosdb fleetspace account') as c:
+        c.argument('resource_group', options_list=['--resource-group', '-g'], help='Name of the resource group.', required=True)
+        c.argument('fleet_name', options_list=['--fleet-name'], help='Name of the Cosmos DB Fleet.', required=True)
+        c.argument('fleetspace_name', options_list=['--fleetspace-name'], help='Name of the Fleetspace resource.', required=True)
+        c.argument('fleetspace_account_name', options_list=['--fleetspace-account-name', '-n'], help='Name of the Fleetspace Account resource.', required=True)
+
+    with self.argument_context('cosmosdb fleetspace account create') as c:
+        c.argument('fleetspace_account_body', options_list=['--body', '-b'], validator=validate_fleetspaceAccount_body, completer=FilesCompleter(), help="Fleetspace Account body with properties.globalDatabaseAccountProperties (fields: armLocation, resourceId). You can enter it as a string or as a file, e.g., --body @fleetspaceAccount.json or " + FLEETSPACE_ACCOUNT_PROPERTIES_EXAMPLE)

src/cosmosdb-preview/azext_cosmosdb_preview/_validators.py

@@ -429,3 +429,101 @@ def validate_mongoMI_role_assignment_id(ns):
     """ Extracts Guid role assignment Id """
     if ns.role_assignment_id is not None:
         ns.role_assignment_id = _parse_resource_path(ns.role_assignment_id, False, "mongoMIRoleAssignments")
+
+
+def validate_fleetspace_body(cmd, ns):
+    from azure.cli.core.util import get_file_json, shell_safe_json_parse
+    import os
+
+    if ns.fleetspace_body is not None:
+        if os.path.exists(ns.fleetspace_body):
+            body = get_file_json(ns.fleetspace_body)
+        else:
+            body = shell_safe_json_parse(ns.fleetspace_body)
+
+        if not isinstance(body, dict):
+            raise InvalidArgumentValueError('Invalid fleetspace body. Must be a JSON object.')
+
+        props = body.get('properties', {})
+        if not isinstance(props, dict):
+            raise InvalidArgumentValueError('Missing or invalid "properties" field in fleetspace body.')
+
+        tp_config = props.get('throughputPoolConfiguration', {})
+        if not isinstance(tp_config, dict):
+            raise InvalidArgumentValueError('Missing or invalid "throughputPoolConfiguration" in properties.')
+
+        for field in ['minThroughput', 'maxThroughput', 'serviceTier', 'dataRegions']:
+            if field not in tp_config:
+                raise InvalidArgumentValueError(f'Missing "{field}" in throughputPoolConfiguration.')
+
+        if not isinstance(tp_config['minThroughput'], int) or tp_config['minThroughput'] <= 0:
+            raise InvalidArgumentValueError('"minThroughput" must be a positive integer.')
+
+        if not isinstance(tp_config['maxThroughput'], int) or tp_config['maxThroughput'] <= 0:
+            raise InvalidArgumentValueError('"maxThroughput" must be a positive integer.')
+
+        if not isinstance(tp_config['serviceTier'], str):
+            raise InvalidArgumentValueError('"serviceTier" must be a string.')
+
+        if not isinstance(tp_config['dataRegions'], list) or not all(isinstance(r, str) for r in tp_config['dataRegions']):
+            raise InvalidArgumentValueError('"dataRegions" must be a list of strings.')
+
+        ns.fleetspace_body = body
+
+
+def validate_fleet_analytics_body(cmd, ns):
+    from azure.cli.core.util import get_file_json, shell_safe_json_parse
+    import os
+
+    if ns.fleet_analytics_body is not None:
+        if os.path.exists(ns.fleet_analytics_body):
+            body = get_file_json(ns.fleet_analytics_body)
+        else:
+            body = shell_safe_json_parse(ns.fleet_analytics_body)
+
+        if not isinstance(body, dict):
+            raise InvalidArgumentValueError('Fleet Analytics body must be a valid JSON object.')
+
+        props = body.get("properties")
+        if not isinstance(props, dict):
+            raise InvalidArgumentValueError('Missing or invalid "properties" field.')
+
+        slt = props.get("storageLocationType")
+        if slt not in ["StorageAccount", "FabricLakehouse"]:
+            raise InvalidArgumentValueError('"storageLocationType" must be "StorageAccount" or "FabricLakehouse".')
+
+        slu = props.get("storageLocationUri")
+        if not isinstance(slu, str) or not slu.strip():
+            raise InvalidArgumentValueError('"storageLocationUri" must be a non-empty string.')
+
+        ns.fleet_analytics_body = body
+
+
+def validate_fleetspaceAccount_body(cmd, ns):
+    from azure.cli.core.util import get_file_json, shell_safe_json_parse
+    import os
+
+    if ns.fleetspace_account_body is not None:
+        if os.path.exists(ns.fleetspace_account_body):
+            body = get_file_json(ns.fleetspace_account_body)
+        else:
+            body = shell_safe_json_parse(ns.fleetspace_account_body)
+
+        if not isinstance(body, dict):
+            raise InvalidArgumentValueError("Fleetspace Account body must be a valid JSON object.")
+
+        props = body.get("properties")
+        if not isinstance(props, dict):
+            raise InvalidArgumentValueError('Missing or invalid "properties" field.')
+
+        gdp = props.get("globalDatabaseAccountProperties")
+        if not isinstance(gdp, dict):
+            raise InvalidArgumentValueError('Missing or invalid "globalDatabaseAccountProperties".')
+
+        if "resourceId" not in gdp or not isinstance(gdp["resourceId"], str) or not gdp["resourceId"].startswith("/subscriptions/"):
+            raise InvalidArgumentValueError('"resourceId" must be a valid ARM resource ID string.')
+
+        if "armLocation" not in gdp or not isinstance(gdp["armLocation"], str):
+            raise InvalidArgumentValueError('"armLocation" must be a valid string.')
+
+        ns.fleetspace_account_body = body