DataMigration Autorest v3 to v4#29580
Open
JiaSeng-v wants to merge 4 commits into
Open
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
JiaSeng-v
added
Contains Breaking Change
|
To the author of the pull request, |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Az.DataMigration AutoRest configuration and regenerated module artifacts as part of migrating the DataMigration AutoRest pipeline from v3 to v4. The changes primarily surface as updated cmdlet reference help/docs (new JSON parameter-set variants, updated model type names) and module metadata updates.
Changes:
- Regenerated cmdlet help and module docs to include additional parameter sets (e.g., JsonString/JsonFilePath) and updated output model type names.
- Updated DataMigration AutoRest configuration (directives, subject renames, variant removals) to align with v4 generation behavior.
- Updated module packaging metadata (manifest dependency version, assembly version, solution project GUID).
Reviewed changes
Copilot reviewed 56 out of 56 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| src/DataMigration/DataMigration/help/Update-AzDataMigrationSqlService.md | Help updated with JsonString/JsonFilePath parameter sets and type name adjustments. |
| src/DataMigration/DataMigration/help/Stop-AzDataMigrationToSqlVM.md | Help updated with additional cancel parameter sets (JSON/identity variants). |
| src/DataMigration/DataMigration/help/Stop-AzDataMigrationToSqlManagedInstance.md | Help updated with additional cancel parameter sets (JSON/identity variants). |
| src/DataMigration/DataMigration/help/Stop-AzDataMigrationToSqlDb.md | Help updated with additional cancel parameter sets (JSON/identity variants). |
| src/DataMigration/DataMigration/help/Remove-AzDataMigrationToSqlVM.md | Help updated with additional identity-based delete parameter set and type name adjustments. |
| src/DataMigration/DataMigration/help/Remove-AzDataMigrationToSqlManagedInstance.md | Help updated with additional identity-based delete parameter set and type name adjustments. |
| src/DataMigration/DataMigration/help/Remove-AzDataMigrationToSqlDb.md | Help updated with additional identity-based delete parameter set. |
| src/DataMigration/DataMigration/help/Remove-AzDataMigrationSqlServiceNode.md | Help updated with JsonString/JsonFilePath delete variants and type name adjustments. |
| src/DataMigration/DataMigration/help/Remove-AzDataMigrationSqlService.md | Help updated (identity construction note removed). |
| src/DataMigration/DataMigration/help/New-AzDataMigrationToSqlVM.md | Help updated with JSON/identity variants and parameter metadata changes. |
| src/DataMigration/DataMigration/help/New-AzDataMigrationToSqlManagedInstance.md | Help updated with parameter metadata changes (notably Kind type). |
| src/DataMigration/DataMigration/help/New-AzDataMigrationToSqlDb.md | Help updated with JSON/identity variants and parameter metadata changes. |
| src/DataMigration/DataMigration/help/New-AzDataMigrationSqlServiceAuthKey.md | Help updated with JsonString/JsonFilePath variants and parameter-set scoping. |
| src/DataMigration/DataMigration/help/New-AzDataMigrationSqlService.md | Help updated with JSON variants and revised synopsis/description. |
| src/DataMigration/DataMigration/help/Invoke-AzDataMigrationRetryToSqlDb.md | Help updated with JSON/identity variants and updated model type references. |
| src/DataMigration/DataMigration/help/Invoke-AzDataMigrationCutoverToSqlVM.md | Help updated with JSON/identity variants and parameter-set scoping. |
| src/DataMigration/DataMigration/help/Invoke-AzDataMigrationCutoverToSqlManagedInstance.md | Help updated with JSON/identity variants and parameter-set scoping. |
| src/DataMigration/DataMigration/help/Get-AzDataMigrationToSqlVM.md | Help updated with additional identity-based parameter set and type name adjustments. |
| src/DataMigration/DataMigration/help/Get-AzDataMigrationToSqlManagedInstance.md | Help updated with additional identity-based parameter set and type name adjustments. |
| src/DataMigration/DataMigration/help/Get-AzDataMigrationToSqlDb.md | Help updated with additional identity-based parameter set and type name adjustments. |
| src/DataMigration/DataMigration/help/Get-AzDataMigrationSqlServiceMigration.md | Help output type name updated. |
| src/DataMigration/DataMigration/help/Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric.md | Help output type name updated. |
| src/DataMigration/DataMigration/help/Get-AzDataMigrationSqlServiceAuthKey.md | Help output type name updated. |
| src/DataMigration/DataMigration/help/Get-AzDataMigrationSqlService.md | Help updated (identity construction note removed) and output type name updated. |
| src/DataMigration/DataMigration/help/Az.DataMigration.md | Module help index updated (cmdlet one-line descriptions). |
| src/DataMigration/DataMigration/Az.DataMigration.psd1 | Manifest updated (Az.Accounts minimum version, formatting, generated date). |
| src/DataMigration/DataMigration.sln | Solution updated to new project GUID mapping for Az.DataMigration generated project. |
| src/DataMigration/DataMigration.Autorest/README.md | AutoRest config updated (removed explicit v3 extension pin; directive tweaks; added variant removals). |
| src/DataMigration/DataMigration.Autorest/Properties/AssemblyInfo.cs | Assembly version bumped to 1.0.0. |
| src/DataMigration/DataMigration.Autorest/generate-info.json | Regeneration identifier updated. |
| src/DataMigration/DataMigration.Autorest/docs/Update-AzDataMigrationSqlService.md | AutoRest docs updated with JSON variants and updated type names. |
| src/DataMigration/DataMigration.Autorest/docs/Stop-AzDataMigrationToSqlVM.md | AutoRest docs updated with JSON/identity cancel variants. |
| src/DataMigration/DataMigration.Autorest/docs/Stop-AzDataMigrationToSqlManagedInstance.md | AutoRest docs updated with JSON/identity cancel variants. |
| src/DataMigration/DataMigration.Autorest/docs/Stop-AzDataMigrationToSqlDb.md | AutoRest docs updated with JSON/identity cancel variants. |
| src/DataMigration/DataMigration.Autorest/docs/Remove-AzDataMigrationToSqlVM.md | AutoRest docs updated with identity-based delete variant and type names. |
| src/DataMigration/DataMigration.Autorest/docs/Remove-AzDataMigrationToSqlManagedInstance.md | AutoRest docs updated with identity-based delete variant and type names. |
| src/DataMigration/DataMigration.Autorest/docs/Remove-AzDataMigrationToSqlDb.md | AutoRest docs updated with identity-based delete variant. |
| src/DataMigration/DataMigration.Autorest/docs/Remove-AzDataMigrationSqlServiceNode.md | AutoRest docs updated with JSON delete variants and updated type names. |
| src/DataMigration/DataMigration.Autorest/docs/Remove-AzDataMigrationSqlService.md | AutoRest docs updated (identity construction note removed). |
| src/DataMigration/DataMigration.Autorest/docs/New-AzDataMigrationToSqlVM.md | AutoRest docs updated with JSON/identity variants and parameter metadata changes. |
| src/DataMigration/DataMigration.Autorest/docs/New-AzDataMigrationToSqlManagedInstance.md | AutoRest docs updated with parameter metadata changes (notably Kind type). |
| src/DataMigration/DataMigration.Autorest/docs/New-AzDataMigrationToSqlDb.md | AutoRest docs updated with JSON/identity variants and parameter metadata changes. |
| src/DataMigration/DataMigration.Autorest/docs/New-AzDataMigrationSqlServiceAuthKey.md | AutoRest docs updated with JSON variants and parameter-set scoping. |
| src/DataMigration/DataMigration.Autorest/docs/New-AzDataMigrationSqlService.md | AutoRest docs updated with JSON variants and revised synopsis/description. |
| src/DataMigration/DataMigration.Autorest/docs/Invoke-AzDataMigrationRetryToSqlDb.md | AutoRest docs updated with JSON/identity variants and updated model type references. |
| src/DataMigration/DataMigration.Autorest/docs/Invoke-AzDataMigrationCutoverToSqlVM.md | AutoRest docs updated with JSON/identity variants. |
| src/DataMigration/DataMigration.Autorest/docs/Invoke-AzDataMigrationCutoverToSqlManagedInstance.md | AutoRest docs updated with JSON/identity variants. |
| src/DataMigration/DataMigration.Autorest/docs/Get-AzDataMigrationToSqlVM.md | AutoRest docs updated with identity-based parameter set and type names. |
| src/DataMigration/DataMigration.Autorest/docs/Get-AzDataMigrationToSqlManagedInstance.md | AutoRest docs updated with identity-based parameter set and type names. |
| src/DataMigration/DataMigration.Autorest/docs/Get-AzDataMigrationToSqlDb.md | AutoRest docs updated with identity-based parameter set and type names. |
| src/DataMigration/DataMigration.Autorest/docs/Get-AzDataMigrationSqlServiceMigration.md | AutoRest docs output type name updated. |
| src/DataMigration/DataMigration.Autorest/docs/Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric.md | AutoRest docs output type name updated. |
| src/DataMigration/DataMigration.Autorest/docs/Get-AzDataMigrationSqlServiceAuthKey.md | AutoRest docs output type name updated. |
| src/DataMigration/DataMigration.Autorest/docs/Get-AzDataMigrationSqlService.md | AutoRest docs updated (identity construction note removed) and output type name updated. |
| src/DataMigration/DataMigration.Autorest/docs/Az.DataMigration.md | AutoRest module docs index updated (including Module Guid). |
| src/DataMigration/DataMigration.Autorest/custom/Cmdlets/New-AzDataMigrationToSqlManagedInstance.ps1 | Custom cmdlet signature updated (notably Kind parameter type). |
Comment on lines
396
to
+399
|
|
||
| - where: | ||
| variant: ^CreateViaIdentity$|^CreateViaIdentityExpanded$ | ||
| remove: true |
Comment on lines
10
to
12
| ## SYNOPSIS | ||
| Create or Update Database Migration Service. | ||
| Create Database Migration Service. | ||
|
|
Comment on lines
98
to
100
| ### [New-AzDataMigrationSqlService](New-AzDataMigrationSqlService.md) | ||
| Create or Update Database Migration Service. | ||
| Create Database Migration Service. | ||
|
|
Comment on lines
160
to
166
| ### -Kind | ||
| . | ||
|
|
||
| ```yaml | ||
| Type: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Support.ResourceType | ||
| Parameter Sets: (All) | ||
| Type: System.String | ||
| Parameter Sets: CreateExpanded, CreateViaIdentityServerExpanded | ||
| Aliases: |
Comment on lines
239
to
245
| ### -Kind | ||
| . | ||
|
|
||
| ```yaml | ||
| Type: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Support.ResourceType | ||
| Parameter Sets: (All) | ||
| Type: System.String | ||
| Parameter Sets: CreateExpanded, CreateViaIdentitySqlVirtualMachineExpanded | ||
| Aliases: |
Comment on lines
265
to
270
| ### -Kind | ||
| Resource type. | ||
|
|
||
| ```yaml | ||
| Type: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Support.ResourceType | ||
| Type: System.String | ||
| Parameter Sets: (All) |
|
|
||
| [Parameter(HelpMessage = "Resource type.")] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Support.ResourceType]${Kind}, | ||
| [string]${Kind}, |
Comment on lines
10
to
12
| ## SYNOPSIS | ||
| Create or Update Database Migration Service. | ||
| Create Database Migration Service. | ||
|
|
Comment on lines
+1
to
+5
| "Module","ClassName","Target","Severity","ProblemId","Description","Remediation" | ||
| "Az.DataMigration","Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric","Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric","0","3000","The type of property 'Node' of type 'Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20250630.IIntegrationRuntimeMonitoringData' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.INodeMonitoringData' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.INodeMonitoringData]'.","Change the type of property 'Node' back to 'Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.INodeMonitoringData'." | ||
| "Az.DataMigration","Get-AzDataMigrationSqlServiceMigration","Get-AzDataMigrationSqlServiceMigration","0","3000","The type of property 'ProvisioningState' of type 'Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20250630.IDatabaseMigration' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Support.ProvisioningState]' to 'System.String'.","Change the type of property 'ProvisioningState' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Support.ProvisioningState]'." | ||
| "Az.DataMigration","Get-AzDataMigrationSqlServiceMigration","Get-AzDataMigrationSqlServiceMigration","0","3000","The type of property 'Kind' of type 'Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20250630.IDatabaseMigration' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Support.ResourceType]' to 'System.String'.","Change the type of property 'Kind' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Support.ResourceType]'." | ||
| "Az.DataMigration","Get-AzDataMigrationToSqlDb","Get-AzDataMigrationToSqlDb","0","3000","The type of property 'MigrationStatusDetailListOfCopyProgressDetail' of type 'Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20250630.IDatabaseMigrationSqlDb' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.ICopyProgressDetails' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.ICopyProgressDetails]'.","Change the type of property 'MigrationStatusDetailListOfCopyProgressDetail' back to 'Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.ICopyProgressDetails'." |
Comment on lines
20
to
22
| ## Upcoming Release | ||
| * Improved user experience and consistency. This may introduce breaking changes. Please refer to [here](https://go.microsoft.com/fwlink/?linkid=2340249). | ||
|
|
Comment on lines
396
to
+399
|
|
||
| - where: | ||
| variant: ^CreateViaIdentity$|^CreateViaIdentityExpanded$ | ||
| remove: true |
Comment on lines
10
to
12
| ## SYNOPSIS | ||
| Create or Update Database Migration Service. | ||
| Create Database Migration Service. | ||
|
|
Comment on lines
259
to
262
| ## OUTPUTS | ||
|
|
||
| ### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20250630.ISqlMigrationService | ||
| ### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.ISqlMigrationService | ||
|
|
Comment on lines
282
to
285
| ## OUTPUTS | ||
|
|
||
| ### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20250630.ISqlMigrationService | ||
| ### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.ISqlMigrationService | ||
|
|
|
|
||
| [Parameter(HelpMessage = "Resource type.")] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Support.ResourceType]${Kind}, | ||
| [string]${Kind}, |
|
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.