[MySQL] az mysql flexible-server rename: Add server rename support (preview)

[Aayush Gupta (AAGUPTA6209)]

🤖 PR Validation — ⚠️ Review suggested

Breaking Changes	Tests
⚠️ None	️✔️ 130/130

⚠️AzureCLI-BreakingChangeTest

⚠️mysql

rule	cmd_name	rule_message	suggest_message
⚠️ 1001 - CmdAdd	mysql flexible-server rename	cmd mysql flexible-server rename added

Related command

az mysql flexible-server rename

Description

Add a preview command to rename an existing Azure Database for MySQL flexible server within the same subscription, resource group, and location.

Implementation

• Register az mysql flexible-server rename as a preview command with a confirmation prompt and --yes support.
• Add the required --new-name argument.
• Accept the source server through --resource-group and --name, or a single MySQL flexible server resource ID through --ids.
• Normalize the destination name to lowercase, reject empty or unchanged names, and reuse existing server-name and name-availability validation.
• Retrieve the source server and submit the destination request using createMode: Rename, its canonical resource ID, and its existing location.
• Return the initial service response without polling for completion:
  • statusCode: initial HTTP status.
  • content: initial response body as text.
  • azureAsyncOperation: operation-status URL from the response header, or null if absent.
• Accept --no-wait for compatibility. Submission-only behavior and output are the same with or without this flag.
• Add command help, mocked unit/CLI tests, and opt-in live scenarios.

No SDK dependency or API-version change is introduced by this PR.

Behavior and prerequisites

• Rename support must be enabled by the MySQL service for the target environment.
• HTTP acceptance does not indicate completion. Users must monitor the operation and verify the destination server after success.
• Rename changes the server resource ID and fully qualified domain name. Connection strings, dependent resource references, and infrastructure-as-code state may need updating.
• Zero downtime and continued availability of the old endpoint are not guaranteed.
• Availability and restrictions for replication topologies, high availability, and networking remain service-controlled.
• After an interrupted or failed submission, users should inspect the operation and server state before retrying.

Testing Guide

Local automated validation

$Python below refers to the source-linked development Python executable.

Style checks

& $Python -B -m azdev style mysql

Result: PASS — Pylint and Flake8.

CLI command/help linter

& $Python -B -m azdev linter mysql --ci-exclusions

Result: PASS — no command/help or custom Pylint violations at the default severity threshold.

The GitHub workflow additionally specifies --min-severity medium; that stricter configuration was not run locally.

Focused rename and regression tests

& $Python -B -m unittest `
    azure.cli.command_modules.mysql.tests.latest.test_mysql_flexible_server_rename `
    azure.cli.command_modules.mysql.tests.latest.test_mysql_custom `
    azure.cli.command_modules.mysql.tests.latest.test_mysql_util `
    azure.cli.command_modules.mysql.tests.latest.test_mysql_flexible_server_georestore `
    azure.cli.command_modules.mysql.tests.latest.test_mysql_flexible_server_rename_live

Result: PASS — 56 tests collected, 52 passed, 4 opt-in live tests skipped.

Coverage includes request serialization, canonical source IDs, initial response preservation, default and --no-wait behavior, name validation, resource ID validation, confirmation handling, service errors, transport failures, and timeouts.

Full MySQL regression suite

Executed full unittest discovery through an offline harness that verified recordings existed for active scenarios and blocked live network connections.

Result: 89 tests collected: 78 passed, 10 skipped, 1 error.

The error occurred in the existing Windows test
TestWindowsExecutableResolution.test_real_launch_ignores_current_directory_executable:

KeyError: 'SystemRoot'

Investigation reproduced the error using only existing tests unchanged by this PR. Scenario-test cleanup replaces Windows' case-insensitive os.environ mapping with a plain dictionary, causing a subsequent mixed-case SystemRoot lookup to fail.

Reran the affected utility-test module in a fresh process:

& $Python -B -m unittest -v azure.cli.command_modules.mysql.tests.latest.test_mysql_util

Result: PASS — all 23 tests passed, including the test that failed after scenario execution.

No unrelated test-framework changes were made. The combined local full-suite run is not being reported as passing.

Whitespace validation

git diff --check upstream/dev...HEAD

Result: PASS.

Manual live validation

Manual replica-rename validation completed successfully using the local CLI against a rename-enabled canary environment.

This result does not establish support for every topology or region, or verify data-plane continuity.

Manual reproduction

Use an approved test server in a rename-enabled environment. These commands operate on real Azure resources.

1. Inspect the source:

   az mysql flexible-server show --resource-group <resource-group> --name <old-name>
   

2. Submit the rename and review the confirmation prompt:

   az mysql flexible-server rename --resource-group <resource-group> --name <old-name> --new-name <new-name>
   

3. Poll the returned operation URL:

   az rest --method get --url "<azureAsyncOperation>"
   

   Repeat the GET while the operation is in progress. Stop and investigate if it fails or is canceled. Do not resubmit rename merely because completion is pending.

4. After Succeeded, inspect the destination:

   az mysql flexible-server show --resource-group <resource-group> --name <new-name>
   

   Verify the new name, resource ID, endpoint, and Ready state. For a replica, verify the source-server reference.

5. Verify the old identity no longer resolves:

   az mysql flexible-server show --resource-group <resource-group> --name <old-name>
   

   Expected result: ResourceNotFound.

Coverage limitations

• Four opt-in live scenarios are included: standalone, high availability, same-region replication, and cross-region replication.
• These scenarios create billable resources and were not executed during this automated validation.
• They use LiveScenarioTest; they are not recorded playback scenarios and should not be assumed to run in normal PR CI.
• Live scenarios validate control-plane state and resource references, not data-plane continuity.
• PR CI results should be reviewed separately from these local results.

History Notes

[MySQL] az mysql flexible-server rename: Add server rename support (preview)

---

This checklist is used to make sure that common guidelines for a pull request are followed.

• The PR title and description has followed the guideline in Submitting Pull Requests.

• I adhere to the Command Guidelines.

• I adhere to the Error Handling Guidelines.

[azure-pipelines]

Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

[microsoft-github-policy-service]

Thank you for your contribution Aayush Gupta (@AAGUPTA6209)! We will review the pull request and get back to you soon.

[Copilot]

🔵 Needs a closer look

The resource identity change warrants human review, especially because the opt-in live scenarios remain unexecuted.

No open issues 🎉

What changed in this PR

Adds preview support for az mysql flexible-server rename within the existing MySQL command module.

Changes:

• Registers the command with confirmation, source validation, and destination-name validation.
• Submits rename requests and returns the initial response without polling.
• Adds help, mocked tests, and opt-in live scenarios.

File	Description
src/​azure-cli/​azure/​cli/​command_modules/​mysql/​tests/​latest/​test_mysql_flexible_server_rename.py	Tests requests, validation, responses, and CLI behavior.
src/​azure-cli/​azure/​cli/​command_modules/​mysql/​tests/​latest/​test_mysql_flexible_server_rename_live.py	Adds standalone, HA, and replication live scenarios.
src/​azure-cli/​azure/​cli/​command_modules/​mysql/​tests/​latest/​test_mysql_custom.py	Extends the argument-registration test helper.
src/​azure-cli/​azure/​cli/​command_modules/​mysql/​custom.py	Implements rename submission and initial-response output.
src/​azure-cli/​azure/​cli/​command_modules/​mysql/​commands.py	Registers the preview command and confirmation prompt.
src/​azure-cli/​azure/​cli/​command_modules/​mysql/​_validators.py	Validates source resource IDs.
src/​azure-cli/​azure/​cli/​command_modules/​mysql/​_params.py	Adds destination-name and compatibility arguments.
src/​azure-cli/​azure/​cli/​command_modules/​mysql/​_help.py	Documents usage, operational risks, and completion monitoring.

_{Review effort: Balanced}

[x-engineering-agent]

Hi Aayush Gupta (@AAGUPTA6209),
Since the current milestone time is less than 7 days, this pr will be reviewed in the next milestone.

[Yong Zhang (yonzhan)]

/azp run

[azure-pipelines]

Azure Pipelines:
Successfully started running 3 pipeline(s).

[microsoft-github-policy-service]

Aayush Gupta (@AAGUPTA6209) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

1. Definitions.
   “Code” means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   “Project” means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative (www.opensource.org).
   “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   “Submission” means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.
2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.
3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.
4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.
5. Licenses.

• Copyright License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.
• Patent License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.
• Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.
8. Information about Submissions. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.
9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.
10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.