Skip to content

Conversation

jonathanserbent
Copy link
Member

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!

  • Other, please clarify:
    • This API version was initially planned for an October release, but our team changed plans and decided to delay this API version until next year. When we do release this new API version we will likely have additional new API changes, so rather than rename the version we want to pull this version out so we can go through the proper API review again with the new changes.

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.

…view (#36652)"

This reverts commit dca492c.

# Conflicts:
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchCreateAutoGeneratedDomainNameLabel.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchCreateOrUpdateService.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchCreateOrUpdateServiceAuthOptions.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchCreateOrUpdateServiceDisableLocalAuth.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchCreateOrUpdateServiceWithCmkEnforcement.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchCreateOrUpdateServiceWithDataExfiltration.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchCreateOrUpdateServiceWithIdentity.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchCreateOrUpdateWithSemanticSearch.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchGetService.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchListServicesByResourceGroup.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchListServicesBySubscription.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchUpdateService.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchUpdateServiceAuthOptions.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchUpdateServiceDisableLocalAuth.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchUpdateServiceToRemoveIdentity.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchUpdateServiceWithCmkEnforcement.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchUpdateServiceWithDataExfiltration.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchUpdateServiceWithSemanticSearch.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/SearchUpdateServiceWithSku.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/examples/UpgradeSearchServiceToLatestVersion.json
#	specification/search/resource-manager/Microsoft.Search/preview/2025-10-01-preview/search.json
Copy link

github-actions bot commented Oct 2, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR targets either the main branch of the public specs repo or the RPSaaSMaster branch of the private specs repo. These branches are not intended for iterative development. Therefore, you must acknowledge you understand that after this PR is merged, the APIs are considered shipped to Azure customers. Any further attempts at in-place modifications to the APIs will be subject to Azure's versioning and breaking change policies. Additionally, for control plane APIs, you must acknowledge that you are following all the best practices documented by ARM at aka.ms/armapibestpractices. If you do intend to release the APIs to your customers by merging this PR, add the PublishToCustomers label to your PR in acknowledgement of the above. Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).


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 labels Oct 2, 2025
@github-actions github-actions bot added 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 2, 2025
Copy link

github-actions bot commented Oct 2, 2025

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/search/armsearch
Java com.azure.resourcemanager:azure-resourcemanager-search
JavaScript @azure/arm-search

@mikekistler mikekistler added the Versioning-Approved-BranchPolicyException Changes violate the branch policy but exception has been granted. aka.ms/azsdk/pr-brch-deep label Oct 2, 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 Oct 2, 2025
@ravimeda ravimeda 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 Oct 3, 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 BreakingChange-JavaScript-Sdk BreakingChange-Python-Sdk BreakingChange-Python-Sdk-Approved resource-manager Search Versioning-Approved-BranchPolicyException Changes violate the branch policy but exception has been granted. aka.ms/azsdk/pr-brch-deep 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