[Az.ContainerInstance] Update generation tool version: autorest.powershell v3->v4#28376
[Az.ContainerInstance] Update generation tool version: autorest.powershell v3->v4#28376lijinpei2008 wants to merge 15 commits intomainfrom
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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.
| If container image has restart new image will be downloaded. | |
| If container image has updates, new image will be downloaded. |
| ## 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. |
There was a problem hiding this comment.
Same issue as above - 'restart' should be 'updates' for consistency and correctness.
| If container image has restart new image will be downloaded. | |
| If the container image has updates, the new image will be downloaded. |
| ``` | ||
|
|
||
| This command updates a container group profile using piping. | ||
| This command updates a container group profile using pipeing. |
There was a problem hiding this comment.
The word 'pipeing' is misspelled. It should be 'piping'.
| This command updates a container group profile using pipeing. | |
| This command updates a container group profile using piping. |
| ``` | ||
|
|
||
| This command updates a container group using piping. | ||
| This command updates a container group using pipeing. |
There was a problem hiding this comment.
The word 'pipeing' is misspelled. It should be 'piping'.
| This command updates a container group using pipeing. | |
| This command updates a container group using piping. |
| ``` | ||
|
|
||
| This command updates a container group profile using piping. | ||
| This command updates a container group profile using pipeing. |
There was a problem hiding this comment.
The word 'pipeing' is misspelled. It should be 'piping'.
| This command updates a container group profile using pipeing. | |
| This command updates a container group profile using piping. |
| ``` | ||
|
|
||
| This command updates a container group using piping. | ||
| This command updates a container group using pipeing. |
There was a problem hiding this comment.
The word 'pipeing' is misspelled. It should be 'piping'.
| This command updates a container group using pipeing. | |
| This command updates a container group using piping. |
| ## 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. |
There was a problem hiding this comment.
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.
| If container image has restart new image will be downloaded. | |
| If container image has updates, new image will be downloaded. |
| ## 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. |
There was a problem hiding this comment.
Same issue as above - 'restart' should be 'updates' for consistency and correctness.
| If container image has restart new image will be downloaded. | |
| If the container image has updates, a new image will be downloaded. |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
To the author of the pull request, |
|
To the author of the pull request, |
… jinpei/main/ContainerInstance-v4
| ## 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. |
There was a problem hiding this comment.
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".
| --> | ||
|
|
||
| ## Upcoming Release | ||
| * Improved user experience and consistency. This may introduce breaking changes. Please refer to [here](https://go.microsoft.com/fwlink/?linkid=2340249). |
There was a problem hiding this comment.
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.
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
| 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. | ||
|
|
There was a problem hiding this comment.
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.
| ## OUTPUTS | ||
|
|
||
| ### System.String | ||
| ### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.ILogs | ||
|
|
There was a problem hiding this comment.
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).
|
|
||
| ## OUTPUTS | ||
|
|
||
| ### System.String | ||
| ### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.ILogs | ||
|
|
There was a problem hiding this comment.
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).
| --- | ||
| Module Name: Az.ContainerInstance | ||
| Module Guid: 28e34b68-2d28-4aec-8797-6db484c2f903 | ||
| Module Guid: 393cc40d-8cda-42fb-8517-e52ebc003c3f |
There was a problem hiding this comment.
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).
| Module Guid: 393cc40d-8cda-42fb-8517-e52ebc003c3f | |
| Module Guid: ddf74844-4a25-4263-8a5c-f27979292e4e |
| ## 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. | ||
|
|
There was a problem hiding this comment.
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.
| "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 |
There was a problem hiding this comment.
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).
| ### [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. | ||
|
|
There was a problem hiding this comment.
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.
| ## Upcoming Release | ||
| * Improved user experience and consistency. This may introduce breaking changes. Please refer to [here](https://go.microsoft.com/fwlink/?linkid=2340249). | ||
|
|
There was a problem hiding this comment.
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.
| ${Extension}, | ||
|
|
||
| [Parameter(ParameterSetName='CreateExpanded')] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.PSArgumentCompleterAttribute("Unsecure", "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", "Noreuse")] |
There was a problem hiding this comment.
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.
| [Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.PSArgumentCompleterAttribute("Unsecure", "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", "Noreuse")] | |
| [Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.PSArgumentCompleterAttribute("Unsecure", "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", "NoReuse")] |
| "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": { |
There was a problem hiding this comment.
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.
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
Description
Preannouncement PR:
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.