[PS] Migrate RedisEnterpriseCache module to autorest v4 by JoyerJin · Pull Request #28618 · Azure/azure-powershell

JoyerJin · 2025-09-26T08:44:40Z

Description

Preannouncement PR: #28621

Mandatory Checklist

Please choose the target release of Azure PowerShell. (⚠️Target release is a different concept from API readiness. Please click below links for details.)
- General release
- Public preview
- Private preview
- Engineering build
- No need for a release
Check this box to confirm: I have read the Submitting Changes section of CONTRIBUTING.md and reviewed the following information:

SHOULD update ChangeLog.md file(s) appropriately
- Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
  - A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
- Should not change ChangeLog.md if no new release is required, such as fixing test case only.
SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
SHOULD have proper test coverage for changes in pull request.
SHOULD NOT adjust version of module manually in pull request

azure-client-tools-bot-prd · 2025-09-26T08:44:43Z

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

Copilot

Pull Request Overview

This pull request migrates the RedisEnterpriseCache module from AutoRest v3 to AutoRest v4, involving significant changes to the code generation tooling and breaking changes to cmdlet interfaces and parameter types.

Updates the module to use AutoRest v4 with new API version 2025-05-01-preview
Changes numerous parameter types from strongly-typed enums to strings
Modifies parameter set structures and adds new parameter overloads for improved usability

Reviewed Changes

Copilot reviewed 80 out of 82 changed files in this pull request and generated 5 comments.

File	Description
tools/StaticAnalysis/Exceptions/Az.RedisEnterpriseCache/BreakingChangeIssues.csv	Documents breaking changes for cmdlet types and parameters to maintain compatibility tracking
src/RedisEnterpriseCache/RedisEnterpriseCache/help/*.md	Updates help documentation to reflect new parameter types and syntax changes
src/RedisEnterpriseCache/RedisEnterpriseCache/Az.RedisEnterpriseCache.psd1	Updates module metadata including version requirements and build configuration
src/RedisEnterpriseCache/RedisEnterpriseCache.Autorest/test/*.ps1	Removes test implementations and updates test environment configuration

src/RedisEnterpriseCache/RedisEnterpriseCache.Autorest/test/env.json

src/RedisEnterpriseCache/RedisEnterpriseCache/help/Update-AzRedisEnterpriseCache.md

...edisEnterpriseCache/help/Invoke-AzRedisEnterpriseCacheForceDatabaseLinkToReplicationGroup.md

src/RedisEnterpriseCache/RedisEnterpriseCache/help/Az.RedisEnterpriseCache.md

github-actions · 2026-01-09T04:54:59Z

To the author of the pull request,
This PR was labeled "Contains Breaking Change" because breaking changes have been detected by the static analysis pipeline.

According to our policy, breaking changes can only take place during major release and they must be preannounced.
Please follow our guide on the detailed steps.
Required: Please fill in the task below to facilitate our contact,you will receive notifications related to breaking changes.

Copilot

Pull request overview

Copilot reviewed 80 out of 83 changed files in this pull request and generated no new comments.

isra-fel · 2026-01-29T01:09:55Z

/azp run

azure-pipelines · 2026-01-29T01:10:10Z

Azure Pipelines successfully started running 3 pipeline(s).

NoriZC · 2026-03-31T06:39:29Z

/azp run

azure-pipelines · 2026-03-31T06:39:44Z

Azure Pipelines successfully started running 3 pipeline(s).

koderjoker · 2026-03-31T19:43:59Z

src/RedisEnterpriseCache/RedisEnterpriseCache.Autorest/custom/New-AzRedisEnterpriseCache.ps1

        [Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Category('Body')]
-        [Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.ManagedServiceIdentityType]
-        # Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
-        ${IdentityType},


Why is this a switch parameter now, instead of identityType having either "systemAssignedIdentity" or "userAssignedIdentity" as a value?

Is the presence (or abscence) of EnableSystemAssignedIdentity and UserAssignedIdentity supposed to represent the below combinations given in the managed identity common type?

Based on the new Autorest version, this is one of the breaking changes. For new-cmdlet and update-cmdlet will require different type of input. You could read the detail at https://github.com/Azure/autorest.powershell/blob/main/docs/migration-from-v3-to-v4.md

koderjoker · 2026-03-31T19:48:02Z

src/RedisEnterpriseCache/RedisEnterpriseCache.Autorest/custom/New-AzRedisEnterpriseCache.ps1


        [Parameter(ParameterSetName='CreateClusterWithDatabase')]
-        [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.AofFrequency])]
+        [Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.PSArgumentCompleterAttribute("1s", "always")]


always setting is deprecated, is there a way to mark it so and not include it in autocomplete?

koderjoker · 2026-03-31T19:52:52Z

...sEnterpriseCache/RedisEnterpriseCache.Autorest/custom/New-AzRedisEnterpriseCacheDatabase.ps1


        [Parameter()]
-        [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.AofFrequency])]
+        [Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.PSArgumentCompleterAttribute("1s", "always")]


always is deprecated, any way to mark it so?

koderjoker · 2026-03-31T19:55:14Z

...terpriseCache/RedisEnterpriseCache.Autorest/custom/Update-AzRedisEnterpriseCacheDatabase.ps1


        [Parameter()]
-        [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.AofFrequency])]
+        [Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.PSArgumentCompleterAttribute("1s", "always")]


always is deprecated, any way to mark it so and not include it in autocomplete?

koderjoker · 2026-03-31T19:56:45Z

src/RedisEnterpriseCache/RedisEnterpriseCache.Autorest/docs/Az.RedisEnterpriseCache.md

 ---
 Module Name: Az.RedisEnterpriseCache
-Module Guid: bd2e5e87-81f1-459f-9f55-4daaf5d3d27e
+Module Guid: cddc4755-5511-445a-a323-f449e436bf6e


What is the module guid, and why did it get updated?

autorest generation will update this guid too. Could ignore this change

koderjoker · 2026-03-31T21:19:50Z

...nterpriseCache/RedisEnterpriseCache/help/New-AzRedisEnterpriseCacheAccessPolicyAssignment.md


 ## SYNOPSIS
-Creates/Updates a particular access policy assignment for a database
+Create a particular access policy assignment for a database


Please revert change

koderjoker · 2026-03-31T21:20:11Z

...nterpriseCache/RedisEnterpriseCache/help/New-AzRedisEnterpriseCacheAccessPolicyAssignment.md


 ## DESCRIPTION
-Creates/Updates a particular access policy assignment for a database
+Create a particular access policy assignment for a database


Please revert change

koderjoker · 2026-03-31T21:21:50Z

src/RedisEnterpriseCache/RedisEnterpriseCache/help/Update-AzRedisEnterpriseCache.md


 ## SYNOPSIS
-Updates an existing Redis Enterprise cluster
+Update an existing (overwrite/reupdate  with potential downtime) cache cluster


Please revert change

koderjoker · 2026-03-31T21:22:02Z

src/RedisEnterpriseCache/RedisEnterpriseCache/help/Update-AzRedisEnterpriseCache.md


 ## DESCRIPTION
-Updates an existing Redis Enterprise cluster
+Update an existing (overwrite/reupdate  with potential downtime) cache cluster


Please revert change

koderjoker · 2026-03-31T21:22:44Z

src/RedisEnterpriseCache/RedisEnterpriseCache/help/Update-AzRedisEnterpriseCache.md


 ```yaml
-Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.HighAvailability
+Type: System.Nullable`1[System.Boolean]


Is this the expected type for switch parameters?

Copilot

Pull request overview

Copilot reviewed 80 out of 83 changed files in this pull request and generated 15 comments.

Copilot · 2026-04-07T04:02:54Z

src/RedisEnterpriseCache/RedisEnterpriseCache/help/Update-AzRedisEnterpriseCache.md

 ## SYNOPSIS
-Updates an existing Redis Enterprise cluster
+Update an existing (overwrite/reupdate  with potential downtime) cache cluster



The synopsis/description text is user-facing but contains awkward phrasing and a double space ("reupdate with"). Please reword to a clear, grammatically correct sentence (and keep spacing consistent).

Copilot · 2026-04-07T04:02:54Z

...nterpriseCache/RedisEnterpriseCache/help/New-AzRedisEnterpriseCacheAccessPolicyAssignment.md

 ## SYNOPSIS
-Creates/Updates a particular access policy assignment for a database
+Create create a particular access policy assignment for a database



The synopsis/description contains a duplicated word ("Create create"). Please correct the grammar (e.g., "Creates a particular access policy assignment for a database").

Copilot · 2026-04-07T04:02:55Z

src/RedisEnterpriseCache/RedisEnterpriseCache/help/Az.RedisEnterpriseCache.md

 ### [New-AzRedisEnterpriseCacheAccessPolicyAssignment](New-AzRedisEnterpriseCacheAccessPolicyAssignment.md)
-Creates/Updates a particular access policy assignment for a database
+Create create a particular access policy assignment for a database



This module index entry includes a duplicated word ("Create create"), which will show up in rendered help. Please fix the grammar to match the cmdlet help synopsis.

Copilot · 2026-04-07T04:02:55Z

src/RedisEnterpriseCache/RedisEnterpriseCache/help/Az.RedisEnterpriseCache.md

 ### [Update-AzRedisEnterpriseCache](Update-AzRedisEnterpriseCache.md)
-Updates an existing Redis Enterprise cluster
+Update an existing (overwrite/reupdate  with potential downtime) cache cluster



This module index entry includes awkward phrasing and a double space ("reupdate with"). Since this text is displayed in aggregated help, please reword/format it to be grammatically correct and avoid extra spaces.

Copilot · 2026-04-07T04:02:55Z

src/RedisEnterpriseCache/RedisEnterpriseCache/ChangeLog.md

 ## Upcoming Release
+* Introduced various new features by upgrading code generator. Please see details [here](https://github.com/Azure/azure-powershell/blob/main/documentation/Autorest-powershell-v4-new-features.md).
 * Preannounced breaking changes. Please refer to https://go.microsoft.com/fwlink/?linkid=2333229


The new "Upcoming Release" entry is vague and developer-centric ("various new features by upgrading code generator"). ChangeLog entries should be specific from the user's perspective (e.g., mention the RedisEnterpriseCache AutoRest v4 migration and key user-visible impacts) and include an issue/PR reference when applicable.

Copilot · 2026-04-07T04:02:57Z

...Cache/RedisEnterpriseCache.Autorest/docs/New-AzRedisEnterpriseCacheAccessPolicyAssignment.md


 ## SYNOPSIS
-Creates/Updates a particular access policy assignment for a database
+Create create a particular access policy assignment for a database


The synopsis/description contains a duplicated word ("Create create"). Please correct the grammar (e.g., "Creates a particular access policy assignment for a database").

Suggested change

Create create a particular access policy assignment for a database

Creates a particular access policy assignment for a database

Copilot · 2026-04-07T04:02:57Z

src/RedisEnterpriseCache/RedisEnterpriseCache.Autorest/docs/Az.RedisEnterpriseCache.md


 ### [New-AzRedisEnterpriseCacheAccessPolicyAssignment](New-AzRedisEnterpriseCacheAccessPolicyAssignment.md)
-Creates/Updates a particular access policy assignment for a database
+Create create a particular access policy assignment for a database


This module index entry includes a duplicated word ("Create create"), which will show up in rendered help. Please fix the grammar to match the cmdlet help synopsis.

Suggested change

Create create a particular access policy assignment for a database

Creates a particular access policy assignment for a database.

Copilot · 2026-04-07T04:02:57Z

src/RedisEnterpriseCache/RedisEnterpriseCache.Autorest/docs/Az.RedisEnterpriseCache.md


 ### [Update-AzRedisEnterpriseCache](Update-AzRedisEnterpriseCache.md)
-Updates an existing Redis Enterprise cluster
+Update an existing (overwrite/reupdate  with potential downtime) cache cluster


This module index entry includes awkward phrasing and a double space ("reupdate with"). Since this text is displayed in aggregated help, please reword/format it to be grammatically correct and avoid extra spaces.

Suggested change

Update an existing (overwrite/reupdate with potential downtime) cache cluster

Updates an existing cache cluster (overwrite or update with potential downtime).

Copilot · 2026-04-07T04:02:58Z

...rpriseCache/RedisEnterpriseCache.Autorest/test/AzRedisEnterpriseCacheScenario.Recording.json

The scenario recording contains environment-specific identifiers (subscription/tenant IDs, principalId, etc.) and very large opaque values (e.g., long Azure-AsyncOperation query strings). Please sanitize recordings to stable placeholders to avoid committing identifiable/test-environment details and to keep diffs/repo size manageable.

Copilot · 2026-04-07T04:02:58Z

src/RedisEnterpriseCache/RedisEnterpriseCache.Autorest/docs/Update-AzRedisEnterpriseCache.md


 ```yaml
-Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.HighAvailability
+Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]


The parameter type rendering for -EnableSystemAssignedIdentity includes full assembly qualification (System.Private.CoreLib, Version=10.0.0.0), which is noisy and confusing in user-facing docs. Please adjust the doc generation/templates so this renders as a simple boolean/nullable boolean type.

Suggested change

Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Type: Boolean?

Migrate RedisEnterpriseCache module to autorest v4

6f896e2

Create BreakingChangeIssues.csv

205530f

JoyerJin marked this pull request as ready for review September 28, 2025 06:07

Copilot AI review requested due to automatic review settings September 28, 2025 06:07

Copilot AI reviewed Sep 28, 2025

View reviewed changes

update description

2fe2924

github-actions bot mentioned this pull request Oct 1, 2025

Monthly issue metrics report #28630

Closed

isra-fel added the autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 label Oct 2, 2025

JoyerJin added 3 commits October 15, 2025 14:24

Update ChangeLog.md

5dbd34f

Merge branch 'main' into joyer/RedisEnterpriseCache-migrate-v4

78b5045

record new api version with migration

c9b5d15

Pan-Qi marked this pull request as draft January 8, 2026 06:46

Pan-Qi added the Contains Breaking Change This PR contains breaking change label Jan 9, 2026

Pan-Qi marked this pull request as ready for review January 9, 2026 04:54

Copilot AI review requested due to automatic review settings January 9, 2026 04:54

Copilot started reviewing on behalf of Pan-Qi January 9, 2026 04:57 View session

Copilot AI reviewed Jan 9, 2026

View reviewed changes

koderjoker self-assigned this Jan 9, 2026

isra-fel added this to the Az 16.0.0 (TBD) milestone Jan 28, 2026

rebuild with latest autorest

1dc745b

fix merge conflict and rebuild

d1fc952

koderjoker reviewed Mar 31, 2026

View reviewed changes

adjustments based on comment

808c81f

Copilot AI review requested due to automatic review settings April 7, 2026 03:56

Copilot started reviewing on behalf of JiaSeng-v April 7, 2026 03:58 View session

Copilot AI reviewed Apr 7, 2026

View reviewed changes

	Create create a particular access policy assignment for a database
	Creates a particular access policy assignment for a database

	Update an existing (overwrite/reupdate with potential downtime) cache cluster
	Updates an existing cache cluster (overwrite or update with potential downtime).

	Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
	Type: Boolean?

Conversation

JoyerJin commented Sep 26, 2025 • edited by JiaSeng-v Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd bot commented Sep 26, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

isra-fel commented Jan 29, 2026

Uh oh!

azure-pipelines bot commented Jan 29, 2026

Uh oh!

NoriZC commented Mar 31, 2026

Uh oh!

azure-pipelines bot commented Mar 31, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

JoyerJin commented Sep 26, 2025 •

edited by JiaSeng-v

Loading