Skip to content

[SQL] Add reader endpoint APIs for 2026-11-01-preview - #47504

Draft
rajashree012 wants to merge 5 commits into
Azure:release-sql-Microsoft.Sql-2026-11-01-previewfrom
rajashree012:dev/rapolsan/readerendpoint-202611
Draft

rajashree012 wants to merge 5 commits into
Azure:release-sql-Microsoft.Sql-2026-11-01-previewfrom
rajashree012:dev/rapolsan/readerendpoint-202611

Conversation

@rajashree012

Copy link
Copy Markdown
Member

ARM (Control Plane) API Specification Update Pull Request

Purpose of this PR

  • New resource provider.
  • New API version for an existing resource provider.
  • Update existing version for a new feature (private preview only).
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec.
  • Other: Add reader endpoint specifications to the upcoming 2026-11-01-preview SQL release branch, with matching TypeSpec source and generated OpenAPI.

Summary

Adds six reader endpoint operations for November 2026 preview only:

  • Get, create or update, update, delete, and list reader endpoints under a server.
  • List reader endpoints associated with a primary database.

Includes six request/response examples, reader endpoint models, and the November input-file registrations. Preserves request requirements, response codes, Location-based long-running operations, pagination, property mutability, and read-only location. The create/update request example omits read-only location; responses retain it.

No older API versions or workflow files are changed. The public schema uses ReaderEndpoint as its model name and the SQL project's existing common-type version. Narrow TypeSpec suppressions preserve the existing contract and feature-splitting conventions; their approval remains part of API review.

Validation

  • tsp compile . completed successfully with the AutoRest emitter.
  • Azure SDK MCP azsdk_run_typespec_validation returned Succeeded.
  • OAV semantic validation passed for both generated reader specifications.
  • OAV example validation passed for both operation groups and all six examples.
  • Contract comparison passed for six operations, six schemas, six examples, and 27 reachable references.
  • 17,750 pre-existing generated files remain byte-identical; November common.json only gains reader definitions.

Due diligence checklist

  • This PR modifies Azure Resource Manager specifications, not data-plane specifications.
  • Resource Provider guidelines, ARM contract, and REST guideline review completed and approved.
  • Release plan created and confirmed.

Draft / release readiness

This is intentionally a draft. Service deployment, release readiness, required API/suppression reviews, and CI results must be confirmed before merging. This PR does not assert production availability or authorize release publication.

The change is split into a generated Swagger commit followed by its matching TypeSpec, examples, and registration commit.

rapolsan and others added 2 commits October 21, 2026 18:00
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@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 22, 2026
@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

Thank you for your contribution rajashree012! We will review the pull request and get back to you soon.

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 7 pipeline(s).
3 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@github-actions

github-actions Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ The suppressions added to the AutoRest config files (README.mds) require review. Refer to step 1 in the PR workflow diagram, or to step 3, depending on the kind of suppression you did.
  • ❌ This PR introduced or changed TypeSpec suppressions that require review.
    Check the TypeSpec suppressions requiring review comment on this PR for the list of suppressions, their justifications, and source locations.
    Reviewers: apply the typespec-suppressions-approved label after confirming every justification is acceptable.


Comment generated by summarize-checks workflow run.

@github-actions

github-actions Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

API Change Check

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

Language API Review for Package
Go sdk/resourcemanager/sql/armsql
JavaScript @azure/arm-sql
Java com.azure.resourcemanager:azure-resourcemanager-sql
Python azure-mgmt-sql

Comment generated by After APIView workflow run.

Require tracked-resource location, expose provisioning state, retain nested properties and optional PATCH databases, and add minimal and tags-only examples. Emit the read-only state inline so Swagger validators preserve its visibility.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rajashree012

Copy link
Copy Markdown
Member Author

/arm-review

@github-actions github-actions Bot added the typespec-suppressions-review-required PR reviewer must review all reported typespec suppressions label Oct 22, 2026
@github-actions

github-actions Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

TypeSpec suppressions requiring review

Status: ❌ Approval required — 1 suppression

This PR adds or updates the TypeSpec suppressions listed below. Suppressions are strongly discouraged — they bypass linter rules that protect API quality and consistency. Authors should avoid adding new suppressions and prefer fixing the underlying issue; reviewers should approve only when there is a clear, compelling justification and no reasonable alternative. Review each linked rule and source location, then apply typespec-suppressions-approved only if every justification is acceptable. The Status column shows ✅ once the label is applied and ❌ while approval is pending.

New suppressions (1)

StatusRuleSourceJustification
❌@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes
Ensure delete operations have the appropriate status codes.
ReaderEndpoint.tsp#L212Preserve the SQL RP deletion contract: completed deletion of an existing resource returns 200, pending deletion returns 202, and an absent resource returns 204. ARM exception approval is required.

For an overview of TypeSpec linting rules click here.
For a mapping from ARM lintdiff rules to corresponding TypeSpec linting rules click here.

💬 Have feedback on the TypeSpec suppression flow? Let us know.

@achyuth-ms

Copy link
Copy Markdown
Member

/arm-review

@rajashree012

Copy link
Copy Markdown
Member Author

/arm-review

@github-actions

Copy link
Copy Markdown

ARM API Review Summary

Reviewed PR #47504 at head SHA 4842c335955cf4e694c5743acc30831c71682a29 | Triggered by: issue_comment

Approval labels observed: none.

Category Count
🔴 Blocking 0
🟠 Warning 0
🔵 Suggestion 0

No issues found. The ReaderEndpoint TypeSpec, generated ARM OpenAPI, LRO behavior, CRUD/list operations, pagination, mutability, examples, version registration, and scoped suppressions are consistent.

posted-by: arm-api-reviewer-agent | rule: summary | category: summary | severity: suggestion | classification: new | critic: pass | head-sha: 4842c33

🔍 ARM API review by ARM API Review: Automated Workflow

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

ARM API Review

Posting findings from the ARM API Reviewer agent (critic-verified, 1 iteration, no findings) against commit 4842c335955cf4e694c5743acc30831c71682a29. All findings are reported in the summary comment.

Approval labels observed: none.

posted-by: arm-api-reviewer-agent | rule: summary | category: summary | severity: suggestion | classification: existing | critic: pass | head-sha: 4842c33

🔍 ARM API review by ARM API Review: Automated Workflow

rapolsan and others added 2 commits October 22, 2026 23:53
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Document completed 200, pending 202, and absent 204 DELETE responses with targeted exceptions requiring ARM approval. Reuse the existing generator-only feature registry without changing generated contracts.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

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

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

Labels

customer-reported Issues that are reported by GitHub users external to the Azure organization. resource-manager SQL SuppressionReviewRequired TypeSpec Authored with TypeSpec typespec-suppressions-review-required PR reviewer must review all reported typespec suppressions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants