Skip to content

[PS] Migrate ManagedServices module to autorest v4 #27929

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 2 commits into
base: main
Choose a base branch
from

Conversation

JoyerJin
Copy link
Contributor

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 11, 2025 08:46
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 ManagedServices module to autorest v4 and updates associated cmdlets and documentation. The changes standardize model type references from the preview namespace to the general namespace, update sample examples and URLs, and adjust documentation to reflect new cmdlet variants.

  • Updated generate-info.json GUID
  • Revised documentation and sample examples to align with autorest v4 changes (e.g., model types and cmdlet syntax)
  • Adjusted custom cmdlet scripts with updated attributes and output types

Reviewed Changes

Copilot reviewed 37 out of 37 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/ManagedServices/ManagedServices.Autorest/generate-info.json Updated the generate_Id value
src/ManagedServices/ManagedServices.Autorest/examples/Update-AzManagedServicesDefinition.md Updated sample example for updating a registration definition
src/ManagedServices/ManagedServices.Autorest/docs/Update-AzManagedServicesDefinition.md Added new documentation for the Update cmdlet
src/ManagedServices/ManagedServices.Autorest/docs/Remove-AzManagedServicesDefinition.md Minor documentation fixes
src/ManagedServices/ManagedServices.Autorest/docs/Remove-AzManagedServicesAssignment.md Minor documentation fixes
src/ManagedServices/ManagedServices.Autorest/docs/New-AzManagedServicesEligibleAuthorizationObject.md Documentation updates and parameter type change for multi-factor auth provider
src/ManagedServices/ManagedServices.Autorest/docs/New-AzManagedServicesEligibleApproverObject.md Updated URL and model type reference
src/ManagedServices/ManagedServices.Autorest/docs/New-AzManagedServicesDefinition.md Updated documentation with new cmdlet variants and updated output types
src/ManagedServices/ManagedServices.Autorest/docs/New-AzManagedServicesAuthorizationObject.md Adjusted model type references
src/ManagedServices/ManagedServices.Autorest/docs/New-AzManagedServicesAssignment.md Added new documentation for assignment cmdlet with Json variants
src/ManagedServices/ManagedServices.Autorest/docs/Get-AzManagedServicesMarketplaceDefinition.md Updated output type reference
src/ManagedServices/ManagedServices.Autorest/docs/Get-AzManagedServicesDefinition.md Updated output type reference
src/ManagedServices/ManagedServices.Autorest/docs/Get-AzManagedServicesAssignment.md Updated output type reference
src/ManagedServices/ManagedServices.Autorest/docs/Az.ManagedServices.md Updated module metadata and cmdlet descriptions
src/ManagedServices/ManagedServices.Autorest/custom/autogen-model-cmdlets/New-AzManagedServicesEligibleApproverObject.ps1 Updated model type and documentation link
src/ManagedServices/ManagedServices.Autorest/custom/autogen-model-cmdlets/New-AzManagedServicesAuthorizationObject.ps1 Updated model type and documentation link
src/ManagedServices/ManagedServices.Autorest/custom/New-AzManagedServicesEligibleAuthorizationObject.ps1 Updated header, model reference, and parameter attribute for multi-factor auth provider
src/ManagedServices/ManagedServices.Autorest/custom/Get-AzManagedServicesMarketplaceDefinition.ps1 Updated output type reference
src/ManagedServices/ManagedServices.Autorest/README.md Updated directives, regex, and model-cmdlet mapping
src/ManagedServices/ManagedServices.Autorest/Properties/AssemblyInfo.cs Updated assembly GUID and version information
Comments suppressed due to low confidence (1)

src/ManagedServices/ManagedServices.Autorest/docs/New-AzManagedServicesEligibleAuthorizationObject.md:97

  • Ensure that changing the parameter type for 'JustInTimeAccessPolicyMultiFactorAuthProvider' from a dedicated enum ('MultiFactorAuthProvider') to 'System.String' is intentional and that appropriate validation is implemented where this parameter is used.
Type: System.String

Comment on lines +3 to +5
$permantAuth = New-AzManagedServicesAuthorizationObject -PrincipalId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -RoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -PrincipalIdDisplayName "Test user" -DelegatedRoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

Update-AzManagedServicesDefinition -Name xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -RegistrationDefinitionName "Test definition" -ManagedByTenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -Authorization $permantAuth -Description "Test definition desc" -Scope "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Copy link
Preview

Copilot AI Jun 11, 2025

Choose a reason for hiding this comment

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

Typo detected in the variable name '$permantAuth'. Consider renaming it to '$permanentAuth' to improve clarity.

Suggested change
$permantAuth = New-AzManagedServicesAuthorizationObject -PrincipalId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -RoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -PrincipalIdDisplayName "Test user" -DelegatedRoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Update-AzManagedServicesDefinition -Name xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -RegistrationDefinitionName "Test definition" -ManagedByTenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -Authorization $permantAuth -Description "Test definition desc" -Scope "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
$permanentAuth = New-AzManagedServicesAuthorizationObject -PrincipalId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -RoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -PrincipalIdDisplayName "Test user" -DelegatedRoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Update-AzManagedServicesDefinition -Name xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -RegistrationDefinitionName "Test definition" -ManagedByTenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -Authorization $permanentAuth -Description "Test definition desc" -Scope "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

Copilot uses AI. Check for mistakes.

@JoyerJin
Copy link
Contributor Author

breaking change from 'System.String[]' to 'System.Collections.Generic.List`1[System.String]'

Copy link

‼️ DO NOT MERGE THIS PR ‼️
This PR was labeled "Do Not Merge" because it contains code change that cannot be merged. Please contact the reviewer for more information.

@JoyerJin JoyerJin added Breaking Change Release This PR contains breaking change and removed Do Not Merge 🚫 labels Jun 13, 2025
Copy link

To the author of the pull request,
This PR was labeled "Breaking Change Release" because it contains breaking changes.

  • 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking Change Release This PR contains breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant