[PS] Migrate Relay module to autorest v4 #27894
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR migrates the Relay PowerShell module to AutoRest v4 by updating documentation, cmdlet scripts, and generated metadata to use the new model namespaces and unified parameter handling.
- Switched model references from the old
Api20211101namespace to the top-level model namespaces. - Updated all cmdlet docs to include expanded, JSON file, and JSON string parameter sets; changed enum-backed parameters to
System.String. - Regenerated assembly metadata and added PSArgumentCompleter attributes in cmdlet scripts.
Reviewed Changes
Copilot reviewed 66 out of 66 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/Relay/Relay.Autorest/docs/New-AzRelayNetworkRuleSetIPRuleObject.md | Updated online link, changed -Action type to String. |
| src/Relay/Relay.Autorest/docs/New-AzRelayNamespace.md | Introduced multiple create variants, changed -SkuTier to String. |
| src/Relay/Relay.Autorest/docs/New-AzRelayKey.md | Added JSON file/string syntaxes, changed -RegenerateKey to String. |
| src/Relay/Relay.Autorest/docs/New-AzRelayHybridConnection.md | Added CreateViaIdentityNamespace and JSON syntaxes, updated synopsis. |
| src/Relay/Relay.Autorest/docs/New-AzRelayAuthorizationRule.md | Added JSON file/string syntaxes, changed -Rights to String[]. |
| src/Relay/Relay.Autorest/docs/Get-AzWcfRelay.md | Added GetViaIdentityNamespace variant, updated output model reference. |
| src/Relay/Relay.Autorest/docs/Get-AzRelayNamespaceNetworkRuleSet.md | Updated output model reference. |
| src/Relay/Relay.Autorest/docs/Get-AzRelayNamespace.md | Updated output model reference. |
| src/Relay/Relay.Autorest/docs/Get-AzRelayKey.md | Updated output model reference. |
| src/Relay/Relay.Autorest/docs/Get-AzRelayHybridConnection.md | Added GetViaIdentityNamespace variant, updated model references. |
| src/Relay/Relay.Autorest/docs/Get-AzRelayAuthorizationRule.md | Updated output model reference. |
| src/Relay/Relay.Autorest/docs/Az.Relay.md | Updated Module GUID and cmdlet synopses to use “Create”/“Update” phrasing. |
| src/Relay/Relay.Autorest/custom/autogen-model-cmdlets/New-AzRelayNetworkRuleSetIPRuleObject.ps1 | Switched output type, added PSArgumentCompleter attribute for -Action. |
| src/Relay/Relay.Autorest/custom/Set-AzWcfRelay.ps1 | Updated input/output model refs, added string parameter & completer for WcfRelayType. |
| src/Relay/Relay.Autorest/custom/Set-AzRelayNamespaceNetworkRuleSet.ps1 | Updated model refs, added string parameter & completers for DefaultAction & PublicNetworkAccess. |
| src/Relay/Relay.Autorest/custom/Set-AzRelayHybridConnection.ps1 | Updated model references. |
| src/Relay/Relay.Autorest/custom/Set-AzRelayAuthorizationRule.ps1 | Updated model references, added PSArgumentCompleter for -Rights. |
| src/Relay/Relay.Autorest/custom/Get-AzRelayAuthorizationRule.ps1 | Updated output model reference. |
| src/Relay/Relay.Autorest/README.md | Removed outdated AutoRest 3.x directives and revised model-cmdlet mapping. |
| src/Relay/Relay.Autorest/Properties/AssemblyInfo.cs | Added generated assembly metadata for version 2.1.0. |
Contributor
|
@Pan-Qi Please help review the README.md |
vidai-msft
reviewed
Jun 13, 2025
| "Az.Relay","Get-AzRelayAuthorizationRule","Get-AzRelayAuthorizationRule","0","3000","The type of property 'SystemDataLastModifiedByType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IAuthorizationRule' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.CreatedByType]' to 'System.String'.","Change the type of property 'SystemDataLastModifiedByType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.CreatedByType]'." | ||
| "Az.Relay","Get-AzRelayHybridConnection","Get-AzRelayHybridConnection","0","3000","The type of property 'SystemDataCreatedByType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IHybridConnection' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.CreatedByType]' to 'System.String'.","Change the type of property 'SystemDataCreatedByType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.CreatedByType]'." | ||
| "Az.Relay","Get-AzRelayHybridConnection","Get-AzRelayHybridConnection","0","3000","The type of property 'SystemDataLastModifiedByType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IHybridConnection' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.CreatedByType]' to 'System.String'.","Change the type of property 'SystemDataLastModifiedByType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.CreatedByType]'." | ||
| "Az.Relay","Get-AzRelayNamespace","Get-AzRelayNamespace","0","3000","The type of property 'PrivateEndpointConnection' of type 'Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IRelayNamespace' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IPrivateEndpointConnection' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IPrivateEndpointConnection]'.","Change the type of property 'PrivateEndpointConnection' back to 'Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IPrivateEndpointConnection'." |
Contributor
There was a problem hiding this comment.
Is this scenario a breaking change? The type are changed from a normal object to List.
Contributor
Author
There was a problem hiding this comment.
Thank you, I miss this. And below two are the same.
|
To the author of the pull request, |
6 tasks
isra-fel
added
the
autorest v4 migration
Pan-Qi
approved these changes
Nov 6, 2025
Pan-Qi
added
Breaking change PR reviewed
dolauli
approved these changes
Nov 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
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.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.