Skip to content

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

Open
Aayush Gupta (AAGUPTA6209) wants to merge 1 commit into
Azure:devfrom
AAGUPTA6209:mysql-flexible-server-rename
Open

Aayush Gupta (AAGUPTA6209) wants to merge 1 commit into
Azure:devfrom
AAGUPTA6209:mysql-flexible-server-rename

Conversation

@AAGUPTA6209

@AAGUPTA6209 Aayush Gupta (AAGUPTA6209) commented Oct 19, 2026 •

Copy link
Copy Markdown

🤖 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.

Add a preview rename command that validates the destination name, submits the service request, and returns the initial response and operation URL without polling. Document the workflow and add unit and opt-in live coverage.
@AAGUPTA6209
Aayush Gupta (AAGUPTA6209) requested a review from a team as a code owner October 19, 2026 16:38
Copilot AI balanced review requested due to automatic review settings October 19, 2026 16:38
@azure-pipelines

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

@microsoft-github-policy-service microsoft-github-policy-service Bot added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Oct 19, 2026
@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 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

Copy link
Copy Markdown
Contributor

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

@yonzhan

Copy link
Copy Markdown
Collaborator

/azp run

@azure-pipelines

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

@AAGUPTA6209 Aayush Gupta (AAGUPTA6209) changed the title [MySQL] az mysql flexible-server rename: Add server rename support (preview) [MySQL] az mysql flexible-server rename: Add server rename support (preview) Oct 21, 2026
@AAGUPTA6209

Copy link
Copy Markdown
Author

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

@AAGUPTA6209

Copy link
Copy Markdown
Author

/azp run

@azure-pipelines

Copy link
Copy Markdown
Commenter does not have sufficient privileges for PR 34240 in repo Azure/azure-cli

@AAGUPTA6209

Copy link
Copy Markdown
Author

Hi Yong Zhang (@yonzhan) The pipeline was failing because the title was not compliant as per policies, I have updated the title, can you please re-run the pipeline?

@yonzhan

Copy link
Copy Markdown
Collaborator

/azp run

@azure-pipelines

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

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

act-observability-squad Auto-Assign Auto assign by bot customer-reported Issues that are reported by GitHub users external to the Azure organization. Reservations az reservations

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants