Skip to content

[PS] Migrate Relay module to autorest v4 #27894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

JoyerJin
Copy link
Contributor

@JoyerJin JoyerJin commented Jun 5, 2025

Description

Mandatory Checklist

  • 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

@Copilot Copilot AI review requested due to automatic review settings June 5, 2025 02:41
Copy link

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

Copy link
Contributor

@Copilot 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

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 Api20211101 namespace 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.

@vidai-msft
Copy link
Contributor

@Pan-Qi Please help review the README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants