Az.CloudService update generation tool version: autorest.powershell v3->v4 #28572
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. |
6 tasks
|
To the author of the pull request, |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Az.CloudService module from AutoRest PowerShell v3 to v4, involving a complete regeneration of the code structure and significant changes to model types, cmdlet APIs, and documentation.
Key Changes:
- Migration from AutoRest.PowerShell v3 to v4 generation tool
- Type system changes from API-specific models to generic models (e.g.,
Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.*toMicrosoft.Azure.PowerShell.Cmdlets.CloudService.Models.*) - Addition of new cmdlet parameter sets and JSON-based input options
Reviewed Changes
Copilot reviewed 87 out of 87 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tools/StaticAnalysis/Exceptions/ | Static analysis exception files with duplicate entries for example and breaking change issues |
| src/CloudService/CloudService/help/ | Updated help documentation with corrected descriptions, parameter types, and new parameter sets |
| src/CloudService/CloudService.sln | Updated project GUID reference |
| src/CloudService/CloudService.Autorest/ | Complete regeneration with v4 tool including new autogen model cmdlets, updated custom files, and revised configuration |
Comment on lines
+6
to
+9
| "Az.CloudService","New-AzCloudService","3","6","Invalid_Cmdlet","5000","1","Get-AzKeyVault is not a valid command name.","Get-AzKeyVault -ResourceGroupName ContosOrg -VaultName ContosKeyVault","Check the spell of Get-AzKeyVault." | ||
| "Az.CloudService","New-AzCloudService","3","7","Invalid_Cmdlet","5000","1","Get-AzKeyVaultCertificate is not a valid command name.","Get-AzKeyVaultCertificate -VaultName ContosKeyVault -Name ContosCert","Check the spell of Get-AzKeyVaultCertificate." | ||
| "Az.CloudService","New-AzCloudServiceVaultSecretGroupObject","1","1","Invalid_Cmdlet","5000","1","Get-AzKeyVault is not a valid command name.","Get-AzKeyVault -VaultName 'ContosoKeyVault'","Check the spell of Get-AzKeyVault." | ||
| "Az.CloudService","New-AzCloudServiceVaultSecretGroupObject","1","2","Invalid_Cmdlet","5000","1","Get-AzKeyVaultCertificate is not a valid command name.","Get-AzKeyVaultCertificate -VaultName 'ContosoKeyVault' -Name 'ContosoCert'","Check the spell of Get-AzKeyVaultCertificate." |
There was a problem hiding this comment.
This file contains duplicate entries (lines 2-5 and 6-9 are identical). Remove the duplicate entries to avoid confusion and maintain a cleaner exception file.
Suggested change
| "Az.CloudService","New-AzCloudService","3","6","Invalid_Cmdlet","5000","1","Get-AzKeyVault is not a valid command name.","Get-AzKeyVault -ResourceGroupName ContosOrg -VaultName ContosKeyVault","Check the spell of Get-AzKeyVault." | |
| "Az.CloudService","New-AzCloudService","3","7","Invalid_Cmdlet","5000","1","Get-AzKeyVaultCertificate is not a valid command name.","Get-AzKeyVaultCertificate -VaultName ContosKeyVault -Name ContosCert","Check the spell of Get-AzKeyVaultCertificate." | |
| "Az.CloudService","New-AzCloudServiceVaultSecretGroupObject","1","1","Invalid_Cmdlet","5000","1","Get-AzKeyVault is not a valid command name.","Get-AzKeyVault -VaultName 'ContosoKeyVault'","Check the spell of Get-AzKeyVault." | |
| "Az.CloudService","New-AzCloudServiceVaultSecretGroupObject","1","2","Invalid_Cmdlet","5000","1","Get-AzKeyVaultCertificate is not a valid command name.","Get-AzKeyVaultCertificate -VaultName 'ContosoKeyVault' -Name 'ContosoCert'","Check the spell of Get-AzKeyVaultCertificate." |
Comment on lines
+118
to
+120
| "Az.CloudService","Update-AzCloudService","Update-AzCloudService","0","3000","The type of property 'Zone' of type 'Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudService' has changed from 'System.String[]' to 'System.Collections.Generic.List`1[System.String]'.","Change the type of property 'Zone' back to 'System.String[]'." | ||
| "Az.CloudService","Update-AzCloudService","Update-AzCloudService","0","3000","The type of property 'UpgradeMode' of type 'Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudService' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.CloudService.Support.CloudServiceUpgradeMode]' to 'System.String'.","Change the type of property 'UpgradeMode' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.CloudService.Support.CloudServiceUpgradeMode]'." | ||
| "Az.CloudService","Update-AzCloudService","Update-AzCloudService","0","3010","The property 'ResourceGroupName' of type 'Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudService' has been removed.","Add the property 'ResourceGroupName' back to type 'Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudService'." |
There was a problem hiding this comment.
Lines 119-121 are exact duplicates of lines 116-118. Remove the duplicate entries to maintain file integrity and prevent confusion.
Suggested change
| "Az.CloudService","Update-AzCloudService","Update-AzCloudService","0","3000","The type of property 'Zone' of type 'Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudService' has changed from 'System.String[]' to 'System.Collections.Generic.List`1[System.String]'.","Change the type of property 'Zone' back to 'System.String[]'." | |
| "Az.CloudService","Update-AzCloudService","Update-AzCloudService","0","3000","The type of property 'UpgradeMode' of type 'Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudService' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.CloudService.Support.CloudServiceUpgradeMode]' to 'System.String'.","Change the type of property 'UpgradeMode' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.CloudService.Support.CloudServiceUpgradeMode]'." | |
| "Az.CloudService","Update-AzCloudService","Update-AzCloudService","0","3010","The property 'ResourceGroupName' of type 'Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudService' has been removed.","Add the property 'ResourceGroupName' back to type 'Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudService'." |
isra-fel
added
the
autorest v4 migration
… jinpei/main/CloudService-updatev4
VeryEarly
reviewed
Nov 7, 2025
| Invoke-AzCloudServiceRebuild -CloudServiceName <String> -ResourceGroupName <String> -RoleInstance <String[]> | ||
| [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] | ||
| Invoke-AzCloudServiceRebuild -CloudServiceName <String> -ResourceGroupName <String> [-SubscriptionId <String>] | ||
| [-RoleInstance <String[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] |
Collaborator
There was a problem hiding this comment.
roleinstance is path parameter which should be mandatory: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/cloudService.json#L407
Collaborator
|
|
|
This PR was labeled "needs-revision" because it has unresolved review comments or CI failures. |
Pan-Qi
previously approved these changes
Jan 29, 2026
Member
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
Comment on lines
58
to
338
| @@ -71,8 +65,23 @@ directive: | |||
| set: | |||
| subject: CloudServiceOSVersion | |||
| - where: | |||
| variant: ^Restart$|^RestartViaIdentity$|^Reimage$|^ReimageViaIdentity$|^Rebuild$|^RebuildViaIdentity$ | |||
| subject: ^CloudService$|^RebuildCloudService$ | |||
| variant: ^Rebuild$|^RebuildViaIdentity$|^RebuildViaJsonFilePathViaJsonFilePath$|^RebuildViaJsonStringViaJsonString$ | |||
| subject: RebuildCloudService | |||
| remove: true | |||
| - where: | |||
| subject: ^RebuildCloudService$ | |||
| set: | |||
| subject: Rebuild | |||
| - where: | |||
| subject: Rebuild | |||
| hide: true | |||
| - where: | |||
| variant: ^Restart$|^RestartViaIdentity$|^Reimage$|^ReimageViaIdentity$ | |||
| subject: ^CloudService$ | |||
| remove: true | |||
| - where: | |||
| variant: ^RebuildViaIdentityRoleInstance$ | |||
| subject: ^RebuildCloudServiceRoleInstance$ | |||
| remove: true | |||
|
|
|||
| - where: | |||
| @@ -88,27 +97,22 @@ directive: | |||
| subject: CloudServiceRoleInstanceReimage | |||
| verb: Invoke | |||
|
|
|||
| - where: | |||
| subject: ^RebuildCloudService$ | |||
| variant: ^RebuildExpanded$|^RebuildViaIdentityExpanded$ | |||
| set: | |||
| subject: Rebuild | |||
| - where: | |||
| subject: ^RebuildCloudServiceRoleInstance$ | |||
| variant: ^Rebuild$|^RebuildViaIdentity$ | |||
| set: | |||
| subject: RoleInstanceRebuild | |||
|
|
|||
| - where: | |||
| subject: ^CloudServiceUpdateDomain$ | |||
| verb: Get | |||
| subject: ^CloudServicesUpdateDomain$ | |||
| verb: Get|Update | |||
| remove: true | |||
| - where: | |||
| subject: ^WalkCloudServiceUpdateDomain$ | |||
| variant: ^Walk$ | |||
| subject: ^WalkCloudServicesUpdateDomain$ | |||
| variant: ^Walk$|^WalkViaIdentity$|^WalkViaIdentityCloudService$|^WalkViaIdentityCloudServiceExpanded$|^WalkViaIdentityExpanded$|^WalkViaJsonFilePathViaJsonFilePath$|^WalkViaJsonStringViaJsonString$ | |||
| remove: true | |||
| - where: | |||
| subject: ^WalkCloudServiceUpdateDomain$ | |||
| subject: ^WalkCloudServicesUpdateDomain$ | |||
| set: | |||
| subject: UpdateDomain | |||
| verb: Set | |||
| @@ -119,7 +123,7 @@ directive: | |||
| remove: true | |||
| - where: | |||
| subject: ^CloudServiceRoleInstance$ | |||
| verb: Remove | |||
| verb: Remove|Update | |||
| remove: true | |||
| - where: | |||
| variant: ^Delete$|^DeleteViaIdentity$ | |||
| @@ -320,203 +324,15 @@ directive: | |||
| transform: >- | |||
| return "string" | |||
|
|
|||
| - where: | |||
| verb: Get|Update | |||
| subject: CloudService | |||
| set: | |||
| breaking-change: | |||
| deprecated-output-properties: | |||
| - Extension | |||
| - LoadBalancerConfiguration | |||
| - Secret | |||
| - Role | |||
| - Zone | |||
| new-output-properties: | |||
| - Extension | |||
| - LoadBalancerConfiguration | |||
| - Secret | |||
| - Role | |||
| - Zone | |||
| change-description: The types of the properties 'Extension', 'LoadBalancerConfiguration', 'Secret', 'Role', and 'Zone' will be changed from object to 'List'. | |||
| deprecated-by-version: 9.0.0 | |||
| deprecated-by-azversion: 15.0.0 | |||
| change-effective-date: 2025/11/03 | |||
|
|
|||
| - where: | |||
| verb: Get | |||
| subject: CloudServiceInstanceView | |||
| set: | |||
| breaking-change: | |||
| deprecated-output-properties: | |||
| - Statuses | |||
| - RoleInstanceStatusesSummary | |||
| - PrivateId | |||
| new-output-properties: | |||
| - Statuses | |||
| - RoleInstanceStatusesSummary | |||
| - PrivateId | |||
| change-description: The types of the properties 'Statuses', 'RoleInstanceStatusesSummary', and 'PrivateId' will be changed from object to 'List'. | |||
| deprecated-by-version: 9.0.0 | |||
| deprecated-by-azversion: 15.0.0 | |||
| change-effective-date: 2025/11/03 | |||
|
|
|||
| - where: | |||
| verb: Get | |||
| subject: NetworkInterface | |||
| set: | |||
| breaking-change: | |||
| deprecated-output-properties: | |||
| - ApplicationSecurityGroup | |||
| - CustomDnsConfig | |||
| - FlowLog | |||
| - LoadBalancerFrontendIPConfiguration | |||
| - NetworkSecurityGroupPropertiesNetworkInterface | |||
| - PrivateEndpointPropertiesNetworkInterface | |||
| - PrivateLinkServicePropertiesNetworkInterface | |||
| - IPConfiguration | |||
| - TapConfiguration | |||
| - PrivateEndpointConnection | |||
| - PrivateEndpointPropertiesIPConfiguration | |||
| - PrivateLinkServiceConnection | |||
| - ManualPrivateLinkServiceConnection | |||
| - PrivateLinkServicePropertiesIPConfiguration | |||
| - SecurityRule | |||
| - DefaultSecurityRule | |||
| - ApplicationGatewayIPConfiguration | |||
| - Delegation | |||
| - FlowLog | |||
| - IPConfiguration | |||
| - IPConfigurationProfile | |||
| - NetworkInterface | |||
| - PrivateEndpoint | |||
| - ResourceNavigationLink | |||
| - Route | |||
| - DefaultSecurityRule | |||
| - SecurityRule | |||
| - ServiceAssociationLink | |||
| - ServiceEndpointPolicy | |||
| - ServiceEndpoint | |||
| - NetworkSecurityGroupPropertiesSubnet | |||
| - RouteTablePropertiesSubnet | |||
| - IPAllocation | |||
| - PropertiesAddressPrefixes | |||
| - PropertiesNetworkSecurityGroupPropertiesSubnets | |||
| - HostedWorkload | |||
| - VisibilitySubscription | |||
| - DnsSettingDnsServer | |||
| - DnsSettingAppliedDnsServer | |||
| - AutoApprovalSubscription | |||
| - Fqdn | |||
| new-output-properties: | |||
| - ApplicationSecurityGroup | |||
| - CustomDnsConfig | |||
| - FlowLog | |||
| - LoadBalancerFrontendIPConfiguration | |||
| - NetworkSecurityGroupPropertiesNetworkInterface | |||
| - PrivateEndpointPropertiesNetworkInterface | |||
| - PrivateLinkServicePropertiesNetworkInterface | |||
| - IPConfiguration | |||
| - TapConfiguration | |||
| - PrivateEndpointConnection | |||
| - PrivateEndpointPropertiesIPConfiguration | |||
| - PrivateLinkServiceConnection | |||
| - ManualPrivateLinkServiceConnection | |||
| - PrivateLinkServicePropertiesIPConfiguration | |||
| - SecurityRule | |||
| - DefaultSecurityRule | |||
| - ApplicationGatewayIPConfiguration | |||
| - Delegation | |||
| - FlowLog | |||
| - IPConfiguration | |||
| - IPConfigurationProfile | |||
| - NetworkInterface | |||
| - PrivateEndpoint | |||
| - ResourceNavigationLink | |||
| - Route | |||
| - DefaultSecurityRule | |||
| - SecurityRule | |||
| - ServiceAssociationLink | |||
| - ServiceEndpointPolicy | |||
| - ServiceEndpoint | |||
| - NetworkSecurityGroupPropertiesSubnet | |||
| - RouteTablePropertiesSubnet | |||
| - IPAllocation | |||
| - PropertiesAddressPrefixes | |||
| - PropertiesNetworkSecurityGroupPropertiesSubnets | |||
| - HostedWorkload | |||
| - VisibilitySubscription | |||
| - DnsSettingDnsServer | |||
| - DnsSettingAppliedDnsServer | |||
| - AutoApprovalSubscription | |||
| - Fqdn | |||
| change-description: The types of the properties 'ApplicationSecurityGroup', 'CustomDnsConfig', 'FlowLog', 'LoadBalancerFrontendIPConfiguration', 'NetworkSecurityGroupPropertiesNetworkInterface', 'PrivateEndpointPropertiesNetworkInterface', 'PrivateLinkServicePropertiesNetworkInterface', 'IPConfiguration', 'TapConfiguration', 'PrivateEndpointConnection', 'PrivateEndpointPropertiesIPConfiguration', 'PrivateLinkServiceConnection', 'ManualPrivateLinkServiceConnection', 'PrivateLinkServicePropertiesIPConfiguration', 'SecurityRule', 'DefaultSecurityRule', 'ApplicationGatewayIPConfiguration', 'Delegation', 'FlowLog', 'IPConfiguration', 'IPConfigurationProfile', 'NetworkInterface', 'PrivateEndpoint', 'ResourceNavigationLink', 'Route', 'DefaultSecurityRule', 'SecurityRule', 'ServiceAssociationLink', 'ServiceEndpointPolicy', 'ServiceEndpoint', 'NetworkSecurityGroupPropertiesSubnet', 'RouteTablePropertiesSubnet', 'IPAllocation', 'PropertiesAddressPrefixes', 'PropertiesNetworkSecurityGroupPropertiesSubnets', 'HostedWorkload', 'VisibilitySubscription', 'DnsSettingDnsServer', 'DnsSettingAppliedDnsServer', 'AutoApprovalSubscription', 'Fqdn' will be changed from object to 'List'. | |||
| deprecated-by-version: 9.0.0 | |||
| deprecated-by-azversion: 15.0.0 | |||
| change-effective-date: 2025/11/03 | |||
|
|
|||
| - where: | |||
| verb: Get | |||
| subject: CloudServiceOSFamily | |||
| set: | |||
| breaking-change: | |||
| deprecated-output-properties: | |||
| - Version | |||
| new-output-properties: | |||
| - Version | |||
| change-description: The types of the properties 'Version' will be changed from object to 'List'. | |||
| deprecated-by-version: 9.0.0 | |||
| deprecated-by-azversion: 15.0.0 | |||
| change-effective-date: 2025/11/03 | |||
|
|
|||
| - where: | |||
| verb: Get | |||
| subject: PublicIPAddress | |||
| set: | |||
| breaking-change: | |||
| deprecated-output-properties: | |||
| - Zone | |||
| - IPTag | |||
| - PublicIPAddress | |||
| - PublicIPPrefix | |||
| - Subnet | |||
| new-output-properties: | |||
| - Zone | |||
| - IPTag | |||
| - PublicIPAddress | |||
| - PublicIPPrefix | |||
| - Subnet | |||
| change-description: The types of the properties 'Zone', 'IPTag', 'PublicIPAddress', 'PublicIPPrefix', and 'Subnet' will be changed from object to 'List'. | |||
| deprecated-by-version: 9.0.0 | |||
| deprecated-by-azversion: 15.0.0 | |||
| change-effective-date: 2025/11/03 | |||
|
|
|||
| - where: | |||
| verb: Get | |||
| subject: CloudServiceRoleInstance | |||
| set: | |||
| breaking-change: | |||
| deprecated-output-properties: | |||
| - NetworkProfileNetworkInterface | |||
| - InstanceViewStatuses | |||
| new-output-properties: | |||
| - NetworkProfileNetworkInterface | |||
| - InstanceViewStatuses | |||
| change-description: The types of the properties 'NetworkProfileNetworkInterface' and 'InstanceViewStatuses' will be changed from object to 'List'. | |||
| deprecated-by-version: 9.0.0 | |||
| deprecated-by-azversion: 15.0.0 | |||
| change-effective-date: 2025/11/03 | |||
|
|
|||
| - where: | |||
| verb: Get | |||
| subject: CloudServiceRoleInstanceView | |||
| set: | |||
| breaking-change: | |||
| deprecated-output-properties: | |||
| - Statuses | |||
| new-output-properties: | |||
| - Statuses | |||
| change-description: The types of the properties 'Statuses' will be changed from object to 'List'. | |||
| deprecated-by-version: 9.0.0 | |||
| deprecated-by-azversion: 15.0.0 | |||
| change-effective-date: 2025/11/03 | |||
| - model-cmdlet: | |||
| - model-name: Extension | |||
| cmdlet-name: New-AzCloudServiceExtensionObject | |||
| - model-name: LoadBalancerConfiguration | |||
| cmdlet-name: New-AzCloudServiceLoadBalancerConfigurationObject | |||
| # - model-name: LoadBalancerFrontendIPConfiguration | |||
| # cmdlet-name: New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject | |||
| - model-name: CloudServiceRoleProfileProperties | |||
| cmdlet-name: New-AzCloudServiceRoleProfilePropertiesObject | |||
| # - model-name: CloudServiceVaultSecretGroup | |||
| # cmdlet-name: New-AzCloudServiceVaultSecretGroupObject | |||
| ``` | |||
There was a problem hiding this comment.
The README.md file is missing comments explaining the purpose of the directives. According to the coding guidelines, every directive should have a comment explaining its purpose and the "why" behind customizations. This helps future maintainers understand the intention behind these changes.
Member
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
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
5 participants
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
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.