Skip to content

[Az.ContainerInstance] Update generation tool version: autorest.powershell v3->v4#28376

Open
lijinpei2008 wants to merge 15 commits intomainfrom
jinpei/main/ContainerInstance-v4
Open

[Az.ContainerInstance] Update generation tool version: autorest.powershell v3->v4#28376
lijinpei2008 wants to merge 15 commits intomainfrom
jinpei/main/ContainerInstance-v4

Conversation

@lijinpei2008
Copy link
Copy Markdown
Contributor

@lijinpei2008 lijinpei2008 commented Aug 11, 2025

Description

Preannouncement PR:

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

@azure-client-tools-bot-prd
Copy link
Copy Markdown

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

@lijinpei2008 lijinpei2008 marked this pull request as ready for review August 14, 2025 12:01
Copilot AI review requested due to automatic review settings August 14, 2025 12:01
Copy link
Copy Markdown
Contributor

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 updates the autorest.powershell generation tool from version 3 to version 4 for the Az.ContainerInstance module. The update modernizes the SDK generation process and updates parameter handling patterns.

  • Updates generation tool to leverage autorest.powershell v4 features
  • Consolidates parameter sets and introduces new Json input patterns for update operations
  • Modernizes identity management patterns with new EnableSystemAssignedIdentity parameter

Reviewed Changes

Copilot reviewed 89 out of 89 changed files in this pull request and generated 8 comments.

File Description
tools/StaticAnalysis/Exceptions/Az.ContainerInstance/BreakingChangeIssues.csv Adds breaking change exceptions for property type changes and parameter patterns
src/ContainerInstance/ContainerInstance/help/*.md Updates help documentation with new parameter sets and type references
src/ContainerInstance/ContainerInstance.Autorest/test/New-AzContainerGroup.Tests.ps1 Updates test to use new identity parameter pattern
src/ContainerInstance/ContainerInstance.Autorest/examples/*.md Updates example usage to reflect new identity management approach

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

## SYNOPSIS
Restarts all containers in a container group in place.
If container image has updates, new image will be downloaded.
If container image has restart new image will be downloaded.
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

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

There appears to be a word missing in this line. It should read 'If container image has updates, new image will be downloaded.' The word 'updates' seems to have been replaced with 'restart' incorrectly.

Suggested change
If container image has restart new image will be downloaded.
If container image has updates, new image will be downloaded.

Copilot uses AI. Check for mistakes.
## DESCRIPTION
Restarts all containers in a container group in place.
If container image has updates, new image will be downloaded.
If container image has restart new image will be downloaded.
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

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

Same issue as above - 'restart' should be 'updates' for consistency and correctness.

Suggested change
If container image has restart new image will be downloaded.
If the container image has updates, the new image will be downloaded.

Copilot uses AI. Check for mistakes.
```

This command updates a container group profile using piping.
This command updates a container group profile using pipeing.
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

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

The word 'pipeing' is misspelled. It should be 'piping'.

Suggested change
This command updates a container group profile using pipeing.
This command updates a container group profile using piping.

Copilot uses AI. Check for mistakes.
```

This command updates a container group using piping.
This command updates a container group using pipeing.
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

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

The word 'pipeing' is misspelled. It should be 'piping'.

Suggested change
This command updates a container group using pipeing.
This command updates a container group using piping.

Copilot uses AI. Check for mistakes.
```

This command updates a container group profile using piping.
This command updates a container group profile using pipeing.
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

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

The word 'pipeing' is misspelled. It should be 'piping'.

Suggested change
This command updates a container group profile using pipeing.
This command updates a container group profile using piping.

Copilot uses AI. Check for mistakes.
```

This command updates a container group using piping.
This command updates a container group using pipeing.
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

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

The word 'pipeing' is misspelled. It should be 'piping'.

Suggested change
This command updates a container group using pipeing.
This command updates a container group using piping.

Copilot uses AI. Check for mistakes.
## SYNOPSIS
Restarts all containers in a container group in place.
If container image has updates, new image will be downloaded.
If container image has restart new image will be downloaded.
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

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

There appears to be a word missing or incorrect in this line. It should read 'If container image has updates, new image will be downloaded.' The word 'updates' seems to have been replaced with 'restart' incorrectly.

Suggested change
If container image has restart new image will be downloaded.
If container image has updates, new image will be downloaded.

Copilot uses AI. Check for mistakes.
## DESCRIPTION
Restarts all containers in a container group in place.
If container image has updates, new image will be downloaded.
If container image has restart new image will be downloaded.
Copy link

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

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

Same issue as above - 'restart' should be 'updates' for consistency and correctness.

Suggested change
If container image has restart new image will be downloaded.
If the container image has updates, a new image will be downloaded.

Copilot uses AI. Check for mistakes.
@lijinpei2008
Copy link
Copy Markdown
Contributor Author

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@lijinpei2008 lijinpei2008 added the Contains Breaking Change This PR contains breaking change label Aug 18, 2025
@github-actions
Copy link
Copy Markdown

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.

@lijinpei2008 lijinpei2008 marked this pull request as draft August 18, 2025 04:04
@lijinpei2008 lijinpei2008 added Contains Breaking Change This PR contains breaking change and removed Contains Breaking Change This PR contains breaking change labels Aug 18, 2025
@github-actions
Copy link
Copy Markdown

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.

@lijinpei2008 lijinpei2008 marked this pull request as ready for review August 22, 2025 10:34
@isra-fel isra-fel added the autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 label Oct 2, 2025
@isra-fel isra-fel added this to the Az 16.0.0 (TBD) milestone Jan 29, 2026
Copilot AI review requested due to automatic review settings February 6, 2026 01:55
Copy link
Copy Markdown
Contributor

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

Copilot reviewed 87 out of 87 changed files in this pull request and generated 2 comments.

## SYNOPSIS
Restarts all containers in a container group in place.
If container image has updates, new image will be downloaded.
If container image has restart new image will be downloaded.
Copy link

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

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

The text "If container image has restart" appears to be a corrupted sentence. The original text "If container image has updates" makes more sense. The word "updates" was incorrectly changed to "restart".

Copilot uses AI. Check for mistakes.
-->

## Upcoming Release
* Improved user experience and consistency. This may introduce breaking changes. Please refer to [here](https://go.microsoft.com/fwlink/?linkid=2340249).
Copy link

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

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

The ChangeLog entry lacks specific details about what changed for users. According to guideline 1000003, ChangeLog entries should be written from the user's perspective and explain what changed and how it affects their usage. The current entry just references a link without describing the actual improvements or breaking changes users will experience.

Copilot generated this review using guidance from repository custom instructions.
@isra-fel
Copy link
Copy Markdown
Member

isra-fel commented Feb 6, 2026

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@isra-fel
Copy link
Copy Markdown
Member

isra-fel commented Feb 6, 2026

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@JunKai-v
Copy link
Copy Markdown
Contributor

JunKai-v commented Feb 6, 2026

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@NoriZC
Copy link
Copy Markdown
Contributor

NoriZC commented Mar 27, 2026

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@JunKai-v
Copy link
Copy Markdown
Contributor

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

Copilot AI review requested due to automatic review settings March 27, 2026 07:39
@NoriZC
Copy link
Copy Markdown
Contributor

NoriZC commented Mar 27, 2026

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

Copy link
Copy Markdown
Contributor

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

Copilot reviewed 87 out of 87 changed files in this pull request and generated 12 comments.

Comment on lines 11 to 13
Restarts all containers in a container group in place.
If container image has updates, new image will be downloaded.
If container image has restart new image will be downloaded.

Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

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

The synopsis/description text is corrupted: "If container image has restart new image will be downloaded." should describe image updates (and remove the double space). Please correct the wording to match the intended behavior.

Copilot uses AI. Check for mistakes.
Comment on lines 174 to 177
## OUTPUTS

### System.String
### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.ILogs

Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

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

The output type in this help file was changed to Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.ILogs, but the exported cmdlet (generated/ContainerInstance/.../Get-AzContainerInstanceLog.ps1) still declares [OutputType([System.String])]. Please align the help OUTPUTS section with the actual cmdlet output (or update the cmdlet if the output type truly changed).

Copilot uses AI. Check for mistakes.
Comment on lines 172 to 176

## OUTPUTS

### System.String
### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.ILogs

Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

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

The output type in this reference doc was changed to Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.ILogs, but the cmdlet export still reports System.String as its OutputType. Please keep docs and cmdlet output consistent (either revert docs to System.String or update the cmdlet implementation/metadata).

Copilot uses AI. Check for mistakes.
---
Module Name: Az.ContainerInstance
Module Guid: 28e34b68-2d28-4aec-8797-6db484c2f903
Module Guid: 393cc40d-8cda-42fb-8517-e52ebc003c3f
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

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

Module Guid in this front-matter does not match the module manifest GUID (src/ContainerInstance/ContainerInstance/Az.ContainerInstance.psd1 has GUID ddf74844-4a25-4263-8a5c-f27979292e4e). Please update the docs front-matter to match the manifest (or update the manifest if the GUID intentionally changed).

Suggested change
Module Guid: 393cc40d-8cda-42fb-8517-e52ebc003c3f
Module Guid: ddf74844-4a25-4263-8a5c-f27979292e4e

Copilot uses AI. Check for mistakes.
Comment on lines 10 to 13
## SYNOPSIS
Restarts all containers in a container group in place.
If container image has updates, new image will be downloaded.
If container image has restart new image will be downloaded.

Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

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

The synopsis/description text is corrupted: "If container image has restart new image will be downloaded." should describe image updates (and remove the double space). Please correct the wording to match the intended behavior.

Copilot uses AI. Check for mistakes.
Comment on lines +2 to +5
"Az.ContainerInstance","New-AzContainerGroup","7","2","Invalid_Parameter_Name","5011","1","New-AzContainerGroup -EnableSystemAssignedIdentity is not a valid parameter name.","-EnableSystemAssignedIdentity","Check validity of the parameter -EnableSystemAssignedIdentity."
"Az.ContainerInstance","New-AzContainerGroup","7","2","Invalid_Parameter_Name","5011","1","New-AzContainerGroup -UserAssignedIdentity is not a valid parameter name.","-UserAssignedIdentity","Check validity of the parameter -UserAssignedIdentity."
"Az.ContainerInstance","New-AzContainerGroup","7","2","Invalid_Parameter_Name","5011","1","New-AzContainerGroup -EnableSystemAssignedIdentity is not a valid parameter name.","-EnableSystemAssignedIdentity","Check validity of the parameter -EnableSystemAssignedIdentity."
"Az.ContainerInstance","New-AzContainerGroup","7","2","Invalid_Parameter_Name","5011","1","New-AzContainerGroup -UserAssignedIdentity is not a valid parameter name.","-UserAssignedIdentity","Check validity of the parameter -UserAssignedIdentity." No newline at end of file
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

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

These exceptions suppress "Invalid_Parameter_Name" for -EnableSystemAssignedIdentity and -UserAssignedIdentity in New-AzContainerGroup examples. That indicates the published cmdlet metadata still doesn't recognize these parameters; rather than adding exceptions, please regenerate/update the cmdlet so the examples match the actual parameter names (and then remove the exceptions).

Copilot uses AI. Check for mistakes.
Comment on lines 96 to 99
### [Restart-AzContainerGroup](Restart-AzContainerGroup.md)
Restarts all containers in a container group in place.
If container image has updates, new image will be downloaded.
If container image has restart new image will be downloaded.

Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

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

This module index repeats the same corrupted Restart-AzContainerGroup description ("If container image has restart new image will be downloaded."). Please fix the wording here as well so the index matches the cmdlet help.

Copilot uses AI. Check for mistakes.
Comment on lines 21 to +23
## Upcoming Release
* Improved user experience and consistency. This may introduce breaking changes. Please refer to [here](https://go.microsoft.com/fwlink/?linkid=2340249).

Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

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

The changelog entry is very generic and lacks an issue reference. Since this PR updates the generation tool and introduces preannounced breaking changes, please describe the user-visible impact more concretely (e.g., identity parameter changes / JSON input support) and reference the related issues/PRs in the required [#[id]] format.

Copilot uses AI. Check for mistakes.
${Extension},

[Parameter(ParameterSetName='CreateExpanded')]
[Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.PSArgumentCompleterAttribute("Unsecure", "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", "Noreuse")]
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

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

Argument completer includes value "Noreuse" but the parameter description and REST enum use "NoReuse" (capital R). Please fix the completer value to avoid suggesting an invalid string to users.

Suggested change
[Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.PSArgumentCompleterAttribute("Unsecure", "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", "Noreuse")]
[Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.PSArgumentCompleterAttribute("Unsecure", "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", "NoReuse")]

Copilot uses AI. Check for mistakes.
Comment on lines 123 to 126
"name": "Restart-AzContainerGroup",
"description": "Restarts all containers in a container group in place.\nIf container image has updates, new image will be downloaded.",
"description": "Restarts all containers in a container group in place.\nIf container image has restart new image will be downloaded.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart",
"help": {
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

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

The UX metadata repeats the same corrupted Restart-AzContainerGroup description ("If container image has restart new image will be downloaded."). Please correct the wording here so generated help/UX stays accurate.

Copilot uses AI. Check for mistakes.
@JunKai-v
Copy link
Copy Markdown
Contributor

JunKai-v commented Apr 7, 2026

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 Contains Breaking Change This PR contains breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants