Added migrate command

Author: mettursathish

src/migrate/HISTORY.rst

@@ -3,6 +3,10 @@
 Release History
 ===============
 
+4.0.0b1
++++++++++++++++
+* Added replication list, get and start migration commands.
+
 3.0.0b1
 +++++++++++++++
 * Refactor codebase for improved readability and maintainability.

src/migrate/azext_migrate/_help.py

@@ -304,6 +304,130 @@
                 --os-disk-id "disk-0"
 """
 
+helps['migrate local replication list'] = """
+    type: command
+    short-summary: List all protected items (replicating servers) in a project.
+    long-summary: |
+        Lists all servers that have replication enabled
+        in an Azure Migrate project.
+        This command shows the replication status, health,
+        and configuration details for each protected server.
+
+        The command returns information including:
+        - Protection state (e.g., Protected, ProtectedReplicating, EnablingFailed)
+        - Replication health (Normal, Warning, Critical)
+        - Source machine name and target VM name
+        - Replication policy name
+        - Resource IDs (used for remove command)
+        - Health errors if any
+
+        Note: This command uses a preview API version
+        and may experience breaking changes in future releases.
+    parameters:
+        - name: --resource-group -g
+          short-summary: Resource group containing the Azure Migrate project.
+          long-summary: >
+            The name of the resource group where
+            the Azure Migrate project is located.
+        - name: --project-name
+          short-summary: Name of the Azure Migrate project.
+          long-summary: >
+            The Azure Migrate project that contains
+            the replicating servers.
+        - name: --subscription-id
+          short-summary: Azure subscription ID.
+          long-summary: >
+            The subscription containing the Azure Migrate project.
+            Uses the default subscription if not specified.
+    examples:
+        - name: List all replicating servers in a project
+          text: |
+            az migrate local replication list \\
+                --resource-group myRG \\
+                --project-name myMigrateProject
+        - name: List replicating servers with a specific subscription
+          text: |
+            az migrate local replication list \\
+                --resource-group myRG \\
+                --project-name myMigrateProject \\
+                --subscription-id 00000000-0000-0000-0000-000000000000
+"""
+
+helps['migrate local replication get'] = """
+    type: command
+    short-summary: Get detailed information about a specific replicating server.
+    long-summary: |
+        Retrieves comprehensive details about a specific protected item (replicating server)
+        including its protection state, replication health, configuration settings,
+        and historical information about failover operations.
+
+        You can retrieve the protected item either by:
+        - Full ARM resource ID (--protected-item-id or --id)
+        - Name with project context (--protected-item-name with --resource-group and --project-name)
+
+        The command returns detailed information including:
+        - Basic information (name, resource ID, correlation ID)
+        - Protection status (state, health, resync requirements)
+        - Configuration (policy, replication extension)
+        - Failover history (test, planned, unplanned)
+        - Allowed operations
+        - Machine details (source and target information)
+        - Health errors with recommended actions (if any)
+
+        Note: This command uses a preview API version
+        and may experience breaking changes in future releases.
+    parameters:
+        - name: --protected-item-id --id
+          short-summary: Full ARM resource ID of the protected item.
+          long-summary: >
+            The complete ARM resource ID of the protected item.
+            If provided, --resource-group and --project-name are not required.
+            This ID can be obtained from the 'list' or 'new' commands.
+        - name: --protected-item-name --name
+          short-summary: Name of the protected item (replicating server).
+          long-summary: >
+            The name of the protected item to retrieve.
+            When using this option, both --resource-group and --project-name
+            are required to locate the item.
+        - name: --resource-group -g
+          short-summary: Resource group containing the Azure Migrate project.
+          long-summary: >
+            The name of the resource group where the Azure Migrate project is located.
+            Required when using --protected-item-name.
+        - name: --project-name
+          short-summary: Name of the Azure Migrate project.
+          long-summary: >
+            The Azure Migrate project that contains the replicating server.
+            Required when using --protected-item-name.
+        - name: --subscription-id
+          short-summary: Azure subscription ID.
+          long-summary: >
+            The subscription containing the Azure Migrate project.
+            Uses the default subscription if not specified.
+    examples:
+        - name: Get a protected item by its full ARM resource ID
+          text: |
+            az migrate local replication get \\
+                --protected-item-id "/subscriptions/xxxx/resourceGroups/myRG/providers/Microsoft.DataReplication/replicationVaults/myVault/protectedItems/myItem"
+        - name: Get a protected item by name using project context
+          text: |
+            az migrate local replication get \\
+                --protected-item-name myProtectedItem \\
+                --resource-group myRG \\
+                --project-name myMigrateProject
+        - name: Get a protected item with specific subscription
+          text: |
+            az migrate local replication get \\
+                --name myProtectedItem \\
+                --resource-group myRG \\
+                --project-name myMigrateProject \\
+                --subscription-id 00000000-0000-0000-0000-000000000000
+        - name: Get a protected item using short parameter names
+          text: |
+            az migrate local replication get \\
+                --id "/subscriptions/xxxx/resourceGroups/myRG/providers/Microsoft.DataReplication/replicationVaults/myVault/protectedItems/myItem"
+"""
+
 helps['migrate local replication remove'] = """
     type: command
     short-summary: Stop replication for a migrated server.

src/migrate/azext_migrate/_params.py

@@ -184,6 +184,42 @@ def load_arguments(self, _):
             required=True)
         c.argument('subscription_id', subscription_id_type)
 
+    with self.argument_context('migrate local replication list') as c:
+        c.argument(
+            'resource_group',
+            options_list=['--resource-group', '-g'],
+            help='The name of the resource group where the migrate '
+                 'project is present.',
+            required=True)
+        c.argument(
+            'project_name',
+            project_name_type,
+            help='The name of the migrate project.',
+            required=True)
+        c.argument('subscription_id', subscription_id_type)
+
+    with self.argument_context('migrate local replication get') as c:
+        c.argument(
+            'protected_item_name',
+            options_list=['--protected-item-name', '--name'],
+            help='The name of the protected item (replicating server).')
+        c.argument(
+            'protected_item_id',
+            options_list=['--protected-item-id', '--id'],
+            help='The full ARM resource ID of the protected item. '
+                 'If provided, --resource-group and --project-name are not required.')
+        c.argument(
+            'resource_group',
+            options_list=['--resource-group', '-g'],
+            help='The name of the resource group where the migrate '
+                 'project is present. Required when using --protected-item-name.')
+        c.argument(
+            'project_name',
+            project_name_type,
+            help='The name of the migrate project. Required when using '
+                 '--protected-item-name.')
+        c.argument('subscription_id', subscription_id_type)
+
     with self.argument_context('migrate local replication remove') as c:
         c.argument(
             'target_object_id',

src/migrate/azext_migrate/commands.py

@@ -12,5 +12,10 @@ def load_command_table(self, _):
     with self.command_group('migrate local replication') as g:
         g.custom_command('init', 'initialize_replication_infrastructure')
         g.custom_command('new', 'new_local_server_replication')
+        g.custom_command('list', 'list_local_server_replications')
+        g.custom_command('get', 'get_local_server_replication')
         g.custom_command('remove', 'remove_local_server_replication')
         g.custom_command('get-job', 'get_local_replication_job')
+        
+    with self.command_group('migrate local') as g:
+        g.custom_command('start-migration', 'start_local_server_migration')