Skip to content

Conversation

@hahahahahaiyiwen
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!

  • 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:
    • edit this with your clarification

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 Oct 17, 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 new-api-version resource-manager TypeSpec Authored with TypeSpec WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 17, 2025
@github-actions
Copy link

github-actions bot commented Oct 17, 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.AppConfiguration-AppConfiguration
Go sdk/resourcemanager/appconfiguration/armappconfiguration
Java com.azure.resourcemanager:azure-resourcemanager-appconfiguration
JavaScript @azure/arm-appconfiguration
TypeSpec Microsoft.AppConfiguration

@hahahahahaiyiwen hahahahahaiyiwen added PublishToCustomers Acknowledgement the changes will be published to Azure customers. WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview labels Oct 17, 2025
@github-actions github-actions bot added NotReadyForARMReview ARMAutoSignedOff 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 ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review ARMAutoSignedOff labels Oct 17, 2025
@hahahahahaiyiwen
Copy link
Member Author

Breaking change was introduced in 2025-02-01-preview with the tsp migration. #36878

This PR doesn't introduce any breaking changes.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Adds new preview API version 2025-06-01-preview for Microsoft.AppConfiguration, introducing Azure Front Door configuration support and corresponding examples. Key changes include:

  • New version enum value (v2025_06_01_preview) and versioned azureFrontDoor properties added to models.
  • Added extensive example JSON files for all operations under the new preview version (both TypeSpec examples and generated OpenAPI examples).
  • Updated readme.md to include new tag and input file for the 2025-06-01-preview package.

Reviewed Changes

Copilot reviewed 79 out of 80 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/readme.md Adds tag and mapping for new 2025-06-01-preview API version.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/models.tsp Introduces azureFrontDoor versioned property and related model; imports versioning.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/main.tsp Adds v2025_06_01_preview enum value.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/RegionalCheckNameNotAvailable.json New example for regional name unavailability.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/RegionalCheckNameAvailable.json New example for regional name availability.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/PrivateLinkResourcesListByConfigurationStore.json New example (contains misspelled provider in type).
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/PrivateLinkResourceGet.json New example (contains misspelled provider in type).
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/OperationsList.json New operations list example (contains grammatical error in a description).
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/DeletedConfigurationStoresPurge.json New purge deleted store example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/DeletedConfigurationStoresList.json New list deleted stores example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/DeletedConfigurationStoresGet.json New get deleted store example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresUpdateWithIdentity.json Update with identity example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresUpdatePrivateEndpointConnection.json Update private endpoint connection example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresUpdateDisableLocalAuth.json Update disabling local auth example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresUpdate.json Generic update example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresRegenerateKey.json Regenerate key example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresListReplicas.json List replicas example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresListPrivateEndpointConnections.json List private endpoint connections example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresListKeys.json List keys example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresListByResourceGroup.json List stores by resource group example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresList.json List stores by subscription example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresGetSnapshot.json Get snapshot example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresGetReplica.json Get replica example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresGetPrivateEndpointConnection.json Get private endpoint connection example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresGetKeyValue.json Get key-value example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresGet.json Get configuration store example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresDeleteReplica.json Delete replica example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresDeletePrivateEndpointConnection.json Delete private endpoint connection example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresDeleteKeyValue.json Delete key-value example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresDelete.json Delete configuration store example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresCreateWithTelemetry.json Create store with telemetry example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresCreateWithLocalAuthDisabled.json Create store with local auth disabled example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresCreateWithIdentity.json Create store with identity example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresCreateWithDataPlaneProxy.json Create store with data plane proxy example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresCreateWithAzureFrontDoor.json Create store with Azure Front Door example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresCreateSnapshot.json Create snapshot example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresCreateReplica.json Create replica example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresCreateKeyValue.json Create key-value example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/ConfigurationStoresCreate.json Basic create store example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/CheckNameNotAvailable.json Name not available example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/preview/2025-06-01-preview/examples/CheckNameAvailable.json Name available example.
specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/examples/2025-06-01-preview/*.json (multiple) Duplicated TypeSpec examples for new API version (mirror of preview examples).
Comments suppressed due to low confidence (3)

…onfiguration/AppConfiguration/preview/2025-06-01-preview/examples/PrivateLinkResourcesListByConfigurationStore.json

Co-authored-by: Copilot <[email protected]>
…onfiguration/AppConfiguration/preview/2025-06-01-preview/examples/PrivateLinkResourceGet.json

Co-authored-by: Copilot <[email protected]>
@mikekistler mikekistler added the BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. label Oct 21, 2025
@github-actions github-actions bot added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required ARMAutoSignedOff ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed NotReadyForARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 21, 2025
@hahahahahaiyiwen hahahahahaiyiwen merged commit 946d10b into Azure:main Oct 21, 2025
48 of 50 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ARMAutoSignedOff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager TypeSpec Authored with TypeSpec

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants