Skip to content

Conversation

@wenqibu
Copy link
Contributor

@wenqibu wenqibu commented Aug 18, 2025

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • Add an optional property partitionOption for SalesforceV2 source

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
  • A release plan has been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
  • For guidance on SDK breaking change review, refer to https://aka.ms/ci-fix.

@github-actions
Copy link

github-actions bot commented Aug 18, 2025

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Comment generated by summarize-checks workflow run.

@github-actions github-actions bot added ARMReview data-plane resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Aug 18, 2025
@github-actions
Copy link

github-actions bot commented Aug 18, 2025

API Change Check

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

Language API Review for Package
Swagger Microsoft.DataFactory
Swagger Microsoft.Synapse
Go sdk/resourcemanager/datafactory/armdatafactory
Java com.azure.resourcemanager:azure-resourcemanager-datafactory
JavaScript @azure/arm-datafactory
C# Azure.ResourceManager.DataFactory

@github-actions github-actions bot added VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required NotReadyForARMReview BreakingChange-JavaScript-Sdk and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Aug 18, 2025
@ruowan ruowan added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Aug 18, 2025
@JeffreyRichter JeffreyRichter added the Versioning-Approved-BugFix https://github.com/Azure/azure-sdk-tools/issues/6374 label Aug 18, 2025
@github-actions github-actions bot added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview labels Aug 18, 2025
@mikeharder
Copy link
Member

@wenqibu: I think you may need to split this into two PRs, one for data-plane, and one for resource-manager. My understanding is PRs should never contain changes to both data-plane and resource-manager. Your ARM reviewer may be able to confirm or deny this.

@ruowan
Copy link
Member

ruowan commented Aug 27, 2025

Hi, @mikeharder This is our by design process. The data plane and management actually are the same change. And the data plane change for synapse, it's by design and the ADF team and synapse team has reach the agreement. This process is to make sure our change for swagger consistent both in ADF and synapse.

So could you pls kindly approve the change?

@mikeharder
Copy link
Member

Hi, @mikeharder This is our by design process. The data plane and management actually are the same change. And the data plane change for synapse, it's by design and the ADF team and synapse team has reach the agreement. This process is to make sure our change for swagger consistent both in ADF and synapse.

So could you pls kindly approve the change?

I'm not an ARM reviewer. Your PR is in the queue for ARM review. Looking at previous PRs to these specs, they were reviewed by ARM but not data-plane (I don't think), so we can continue doing this going forward.

@TimLovellSmith
Copy link
Member

Please fix the description - fill out the PR template and intake form including due diligence.

PR Template: You may need to temporarily create a new PR to get the correct template comment and copy it to the top of this PR. Once you have done that, you will see the intake form you need to fill out. It also has a lot of helpful links and other information to help you successfully complete your PR.

(Also github has a way to mark PRs as draft, if this is still draft)

@github-actions github-actions bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 27, 2025
@wenqibu
Copy link
Contributor Author

wenqibu commented Sep 1, 2025

@TimLovellSmith updated, please help approve, thanks

@github-actions github-actions bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 12, 2025
@razvanbadea-msft razvanbadea-msft added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 12, 2025
@github-actions github-actions bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 12, 2025
@kazrael2119
Copy link
Member

/azp run SDK Validation - JS

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@ruowan ruowan merged commit 618194c into Azure:main Sep 15, 2025
38 of 39 checks passed
markcowl pushed a commit to markcowl/azure-rest-api-specs that referenced this pull request Sep 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review data-plane PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager Versioning-Approved-BugFix https://github.com/Azure/azure-sdk-tools/issues/6374 VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants