Skip to content

Conversation

@marianor
Copy link
Member

@marianor marianor commented Sep 6, 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:
    • 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 Sep 6, 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 BreakingChange-Go-Sdk-Suppression brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. labels Sep 6, 2025
@github-actions
Copy link

github-actions bot commented Sep 6, 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/redisenterprise/armredisenterprise
Java com.azure.resourcemanager:azure-resourcemanager-redisenterprise
JavaScript @azure/arm-redisenterprisecache
Swagger Microsoft.Cache-RedisEnterprise

@github-actions github-actions bot added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Sep 6, 2025
@marianor marianor force-pushed the migration-feature-apis-2025-08-01-preview branch 2 times, most recently from f8bc975 to 673f646 Compare September 9, 2025 16:19
@TimLovellSmith
Copy link
Member

TimLovellSmith commented Sep 9, 2025

    "targetResourceId": {

I'm feeling a little confused about why/when we need this property. Is it supposed to be the 'id' of the redisEnterprise cluster that the migration is to? Even though its also in the URI of the migration resource?

I don't see a problem with having it, I just want to understand how its going to be used.


Refers to: specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2025-08-01-preview/redisenterprise.json:3112 in d7124cf. [](commit_id = d7124cf, deletion_comment = False)

@TimLovellSmith
Copy link
Member

                "type": "Microsoft.Cache/redis/RedisResource"

This should just be "Microsoft.Cache/redis", right?

There is no RedisResource subtype.


Refers to: specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2025-08-01-preview/redisenterprise.json:3169 in 673f646. [](commit_id = 673f646, deletion_comment = False)

@TimLovellSmith
Copy link
Member

TimLovellSmith commented Sep 9, 2025

          "description": "Sets whether the DNS is switched automatically after the data is transferred from the source cache to the target cache. This property must be true during the preview."

I think it makes sense to document the 'default' for switchDns, maybe even specify it in swagger
"default: false`,
Does this default to false, for this api version? #ByDesign


Refers to: specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2025-08-01-preview/redisenterprise.json:3177 in d7124cf. [](commit_id = d7124cf, deletion_comment = False)

@TimLovellSmith
Copy link
Member

TimLovellSmith commented Sep 9, 2025

        }

I think it makes sense to document the 'default' for skipDataMigration, maybe even specify it in swagger
"default: false`,
Does this default to false, for this api version? #ByDesign


Refers to: specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2025-08-01-preview/redisenterprise.json:3182 in d7124cf. [](commit_id = d7124cf, deletion_comment = False)

@TimLovellSmith
Copy link
Member

TimLovellSmith commented Sep 9, 2025

          "description": "Sets whether the DNS is switched automatically after the data is transferred from the source cache to the target cache. This property must be true during the preview."

Oh never mind - there is no default, because its required and you must set it to true.


In reply to: 3271694069


Refers to: specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2025-08-01-preview/redisenterprise.json:3177 in d7124cf. [](commit_id = d7124cf, deletion_comment = False)

@TimLovellSmith
Copy link
Member

        }

Oh never mind, there is no default because its required - you must opt it to 'true'.


In reply to: 3271694732


Refers to: specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2025-08-01-preview/redisenterprise.json:3182 in d7124cf. [](commit_id = d7124cf, deletion_comment = False)

@marianor
Copy link
Member Author

marianor commented Sep 9, 2025

Azure Managed Redis

We can remove this property if it is necessary

@josefree
Copy link
Member

josefree commented Sep 26, 2025

The service is under folder structure migration. The PR should proceed with new folder structure. Please contact [email protected] for any inquiries. When you reach out, ensure to bring the pull request you want to make progress.

@marianor marianor force-pushed the migration-feature-apis-2025-08-01-preview branch 2 times, most recently from b69304f to 6344bd0 Compare September 26, 2025 20:44
@github-actions github-actions bot removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Sep 26, 2025
@marianor marianor force-pushed the migration-feature-apis-2025-08-01-preview branch from fb9edf5 to 3d2c76e Compare September 26, 2025 21:08
@marianor marianor force-pushed the migration-feature-apis-2025-08-01-preview branch 2 times, most recently from 7b16299 to 29017a3 Compare September 26, 2025 21:16
@github-actions github-actions bot added ARMReview new-api-version resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 26, 2025
@marianor marianor force-pushed the migration-feature-apis-2025-08-01-preview branch from 3f66e98 to 2d10d2d Compare October 1, 2025 14:08
@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 1, 2025
@marianor marianor added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Oct 1, 2025
@marianor marianor added Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates and removed DoNotMerge <valid label in PR review process> use to hold merge after approval Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates labels Oct 15, 2025
@marianor marianor force-pushed the migration-feature-apis-2025-08-01-preview branch from 2d10d2d to 401e80f Compare October 16, 2025 14:37
@marianor marianor force-pushed the migration-feature-apis-2025-08-01-preview branch 2 times, most recently from 385bbaa to 24b613a Compare October 17, 2025 19:37
@marianor marianor enabled auto-merge (squash) October 17, 2025 23:05
@marianor marianor added brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 20, 2025
@github-actions github-actions bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 20, 2025
@marianor marianor force-pushed the migration-feature-apis-2025-08-01-preview branch from 24b613a to 9af524e Compare October 20, 2025 18:30
@github-actions github-actions bot removed the brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. label Oct 20, 2025
@marianor marianor requested a review from ravimeda October 20, 2025 20:32
Copy link
Contributor

@ramoka178 ramoka178 left a comment

Choose a reason for hiding this comment

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

Approving based on previous sign off

@marianor marianor merged commit e5013f6 into Azure:main Oct 20, 2025
40 of 41 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved-Avocado ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants