Skip to content

Conversation

@scottmacchia-msft
Copy link
Contributor

Data Plane API Specification Update Pull Request

Tip

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

The content of this pull request is the result of a discussion with Mike Kistler and Ramakant Moka. Our team has been using an enum value for supported compliance standards through our Enhanced Security & Compliance (ESC) feature.

While the choice of using an enum was perfectly fine in the first year of this feature, the Databricks product team has started rapidly adding newly supported compliance standards. Due to the usage of an enum value, our team (Azure Databricks RP) must ship a new API version every time a new compliance standard is supported. With the rapid expansion of the feature, we are now shipping a new API version every two months solely for supporting a new compliance standard.

To mitigate this oversaturation of API versions, we will convert the enum value to a string with detailed guidance on the ESC documentation page. The docs will include the list of supported values to ensure no customer confusion.

PR review workflow diagram

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

spec_pr_review_workflow_diagram

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

Change Scope

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.

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
Swagger-Suppression-Process
to get approval.

Release planner

A release plan should have been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

Getting help

  • First, please carefully read through this PR description, from top to bottom.
  • 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.
  • 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.

@github-actions
Copy link

github-actions bot commented Oct 29, 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 resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required NotReadyForARMReview and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 29, 2025
@github-actions
Copy link

github-actions bot commented Oct 29, 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.Databricks-Databricks
Python azure-mgmt-databricks
JavaScript @azure/arm-databricks

@mikekistler mikekistler added the Versioning-Approved-Benign https://github.com/Azure/azure-sdk-tools/issues/6374 label Nov 3, 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 Nov 3, 2025
@ramoka178 ramoka178 added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Nov 3, 2025
@Yuqing-cat Yuqing-cat added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Nov 8, 2025
@Yuqing-cat Yuqing-cat merged commit a496319 into Azure:main Nov 8, 2025
76 of 77 checks passed
anushkasingh16 pushed a commit to anushkasingh16/azure-rest-api-specs that referenced this pull request Nov 11, 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 PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager Versioning-Approved-Benign 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.

4 participants