Skip to content

Fabric Mirroring Review Fixes#43298

Open
mohitsinha-ms wants to merge 5 commits into
Azure:mysql/2025-12-01from
tugupt:fabric-mirroring-review-fixes
Open

Fabric Mirroring Review Fixes#43298
mohitsinha-ms wants to merge 5 commits into
Azure:mysql/2025-12-01from
tugupt:fabric-mirroring-review-fixes

Conversation

@mohitsinha-ms
Copy link
Copy Markdown

Choose a PR Template

Switch to "Preview" on this description then select one of the choices below.

Click here to open a PR for a Data Plane API.

Click here to open a PR for a Control Plane (ARM) API.

Click here to open a PR for only SDK configuration.

@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 May 18, 2026
@mohitsinha-ms
Copy link
Copy Markdown
Author

mohitsinha-ms commented May 18, 2026

Addresses 4 ARM API review comments on FabricMirroringSettings from PR #39083:

  1. Fix singleton naming — FabricMirroringSettingsName union, lowercase "default" in examples
  2. Remove deprecated 202 from PUT — Dropped ArmAcceptedLroResponse + suppression, async headers on 201
  3. Fix list pagination — ArmListSinglePageByParent → ArmResourceListByParent
  4. Fix FIXME suppression — Proper justification for server-intrinsic singleton

Only Fabric Mirroring changes. ReaderEndpoint/Rename Server not addressed here.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 18, 2026

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR has breaking changes in the generated SDK for Go (label: BreakingChange-Go-Sdk). Refer to step 3 in the PR workflow diagram.

Important checks have failed. As of today they are not blocking this PR, but in near future they may.
Addressing the following failures is highly recommended:
  • ⚠️ The check named Swagger BreakingChange has failed. To unblock this PR, follow the process at aka.ms/brch.


Comment generated by summarize-checks workflow run.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 18, 2026

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language API Review for Package
TypeSpec Microsoft.DBforMySQL
Go sdk/resourcemanager/mysql/armmysqlflexibleservers
Python azure-mgmt-mysqlflexibleservers
C# Azure.ResourceManager.MySql
Java com.azure.resourcemanager:azure-resourcemanager-mysqlflexibleserver

Comment generated by After APIView workflow run.

@microsoft-github-policy-service
Copy link
Copy Markdown
Contributor

@mohitsinha-ms 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.
  1. 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.
  2. 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.
  3. 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.
  4. 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.
  5. 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.

SegmentName = "fabricMirroringSettings",
NamePattern = "^[a-zA-Z0-9-]{3,24}$"
NamePattern = "",
Type = FabricMirroringSettingsName
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Review: Resource accepted arbitrary 3-24 char names but is a singleton. Name MUST be lowercase default with enum.

Fix: Added FabricMirroringSettingsName union with Default: "default", updated ResourceNameParameter with Type, all examples use lowercase default.

}

#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FabricMirroringSettings is a server-intrinsic singleton whose lifecycle is tied to the parent server. Settings are toggled via PUT with state Enabled/Disabled rather than created or deleted independently."
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Addresses: BLOCKING — Suppression Criteria / RPC-Delete-V1-05 (Fix FIXME suppression)

Review: Placeholder FIXME suppression masks real contract gap (no DELETE on proxy resource).

Fix: Replaced with definitive justification. Same pattern as AdvancedThreatProtection and Configuration which also suppress DELETE.

ArmAsyncOperationHeader<FinalResult = FabricMirroringSetting> &
Azure.Core.Foundations.RetryAfterHeader
> | ArmAcceptedLroResponse
>
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Review: Async PUT returning 202 is deprecated for new resource types.
Fix: Removed ArmAcceptedLroResponse + suppression. PUT returns 200/201 only with async LRO headers.


@doc("List Fabric Mirroring settings by server.")
listByServer is Azure.ResourceManager.Legacy.ArmListSinglePageByParent<FabricMirroringSetting>;
listByServer is ArmResourceListByParent<FabricMirroringSetting>;
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Review: ArmListSinglePageByParent with nextLink is inconsistent.
Fix: Replaced with ArmResourceListByParent to emit x-ms-pageable.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Does your API support pagination? Does this change match your API definition?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

FabricMirroringSettings is a singleton (only 'default' allowed), so the list always returns at most 1 item and pagination is not functionally needed.

However, the ARM reviewer flagged that the previous ArmListSinglePageByParent was inconsistent -- it exposed nextLink in the response schema without x-ms-pageable.

So I thought Using ArmResourceListByParent resolves this inconsistency and matches the pattern used by all other list operations in this service (AdvancedThreatProtection, Configuration, Database, etc.). The service should return nextLink: null in responses.

@mohitsinha-ms mohitsinha-ms marked this pull request as draft May 19, 2026 04:40
@mohitsinha-ms mohitsinha-ms marked this pull request as ready for review May 19, 2026 04:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BreakingChange-Go-Sdk customer-reported Issues that are reported by GitHub users external to the Azure organization. MySQL

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants