[Az.DataTransfer] Switch to newer preview version with FlowProfiles commands #28579

fzkhan · 2025-09-18T01:38:13Z

Description

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.)
- General release
- Public preview
- Private preview
- Engineering build
- No need for a release
Check this box to confirm: I have read the Submitting Changes section of CONTRIBUTING.md and reviewed the following information:

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 · 2025-09-18T01:38:16Z

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

Copilot

Pull Request Overview

This PR updates the Azure PowerShell DataTransfer module to use a newer preview API version (2025-05-30-preview) that introduces FlowProfile commands and deprecates several existing properties in favor of the new FlowProfile resource model.

Key changes include:

Addition of new FlowProfile cmdlets (Get, New, Remove, Update)
Updates to existing cmdlets with new parameters and deprecation notices
API version update from 2025-05-21 to 2025-05-30-preview

Reviewed Changes

Copilot reviewed 41 out of 41 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
src/DataTransfer/DataTransfer/help/*.md	Updated help documentation for new FlowProfile cmdlets and existing cmdlets with API changes
src/DataTransfer/DataTransfer/Az.DataTransfer.psd1	Added new FlowProfile functions to module exports and updated generation date
src/DataTransfer/DataTransfer.sln	Updated project GUID reference
src/DataTransfer/DataTransfer.Autorest/test/*.Tests.ps1	Added placeholder test files for new FlowProfile cmdlets
src/DataTransfer/DataTransfer.Autorest/generate-info.json	Updated generation ID
src/DataTransfer/DataTransfer.Autorest/examples/*.md	Added placeholder example files for new FlowProfile cmdlets
src/DataTransfer/DataTransfer.Autorest/docs/*.md	Updated documentation for new and existing cmdlets with API changes
src/DataTransfer/DataTransfer.Autorest/UX/*.json	Updated API version and added new FlowProfile resource definitions
src/DataTransfer/DataTransfer.Autorest/README.md	Updated commit reference for newer API version
src/DataTransfer/DataTransfer.Autorest/Properties/AssemblyInfo.cs	Updated assembly version from 0.1.0 to 1.0.0

Copilot · 2025-09-18T01:39:47Z

src/DataTransfer/DataTransfer/help/New-AzDataTransferFlowProfile.md

+
+### -ReplicationScenario
+The data replication scenario handled by this FlowProfile.
+Please not, that this value cannot be updated after creation.


There's a typo in the parameter description. 'Please not' should be 'Please note'.

Suggested change

Please not, that this value cannot be updated after creation.

Please note, that this value cannot be updated after creation.

Copilot · 2025-09-18T01:39:47Z

src/DataTransfer/DataTransfer.Autorest/docs/New-AzDataTransferFlowProfile.md

+
+### -ReplicationScenario
+The data replication scenario handled by this FlowProfile.
+Please not, that this value cannot be updated after creation.


There's a typo in the parameter description. 'Please not' should be 'Please note'.

Suggested change

Please not, that this value cannot be updated after creation.

Please note, that this value cannot be updated after creation.

Copilot · 2025-09-18T01:39:48Z

src/DataTransfer/DataTransfer/help/New-AzDataTransferFlowProfile.md

+
+### -MimeFilter
+Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered.
+For more detail, please refer to the MimeTypeFiler model.


There's a typo in the parameter description. 'MimeTypeFiler' should be 'MimeTypeFilter'.

Suggested change

For more detail, please refer to the MimeTypeFiler model.

For more detail, please refer to the MimeTypeFilter model.

Copilot · 2025-09-18T01:39:48Z

src/DataTransfer/DataTransfer.Autorest/docs/New-AzDataTransferFlowProfile.md

+
+### -MimeFilter
+Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered.
+For more detail, please refer to the MimeTypeFiler model.


There's a typo in the parameter description. 'MimeTypeFiler' should be 'MimeTypeFilter'.

Suggested change

For more detail, please refer to the MimeTypeFiler model.

For more detail, please refer to the MimeTypeFilter model.

Copilot · 2025-09-18T01:39:49Z

src/DataTransfer/DataTransfer/help/Update-AzDataTransferFlowProfile.md

+
+### -MimeFilter
+Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered.
+For more detail, please refer to the MimeTypeFiler model.


There's a typo in the parameter description. 'MimeTypeFiler' should be 'MimeTypeFilter'.

Suggested change

For more detail, please refer to the MimeTypeFiler model.

For more detail, please refer to the MimeTypeFilter model.

Copilot · 2025-09-18T01:39:49Z

src/DataTransfer/DataTransfer.Autorest/docs/Update-AzDataTransferFlowProfile.md

+
+### -MimeFilter
+Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered.
+For more detail, please refer to the MimeTypeFiler model.


There's a typo in the parameter description. 'MimeTypeFiler' should be 'MimeTypeFilter'.

Suggested change

For more detail, please refer to the MimeTypeFiler model.

For more detail, please refer to the MimeTypeFilter model.

fzkhan · 2025-09-18T02:27:18Z

/azp run

azure-pipelines · 2025-09-18T02:27:24Z

Commenter does not have sufficient privileges for PR 28579 in repo Azure/azure-powershell

VeryEarly · 2025-09-18T06:57:31Z

/azp run

azure-pipelines · 2025-09-18T06:57:47Z

Azure Pipelines successfully started running 3 pipeline(s).

fzkhan · 2025-09-22T13:18:30Z

@VeryEarly Seeing some weird behaviour from autorest here.

In the New-AzDataTransferFlow command, I am expecting new parameters including FlowProfile, as added in the API spec. However, the generated commands do not have them for New-AzDataTransferFlow, only for New-AzDataTransferConnection
I see two new commands Get-AzDataTransferAzureDataTransferFlowProfile and Get-AzDataTransferFlowProfile, when it should just be Get-AzDataTransferFlowProfile
Some parameters are getting renamed incorrectly: AntivirusSolutions is renamed as AntiviruAvSolution in New-AzDataTransferFlowProfile command.

I tried removing the directives I had added to see if they were the issue here, but it seems the output is still the same either way. Can you please take a look here?

VeryEarly · 2025-09-24T06:17:54Z

@VeryEarly Seeing some weird behaviour from autorest here.

In the New-AzDataTransferFlow command, I am expecting new parameters including FlowProfile, as added in the API spec. However, the generated commands do not have them for New-AzDataTransferFlow, only for New-AzDataTransferConnection

I see two new commands Get-AzDataTransferAzureDataTransferFlowProfile and Get-AzDataTransferFlowProfile, when it should just be Get-AzDataTransferFlowProfile

Some parameters are getting renamed incorrectly: AntivirusSolutions is renamed as AntiviruAvSolution in New-AzDataTransferFlowProfile command.

I tried removing the directives I had added to see if they were the issue here, but it seems the output is still the same either way. Can you please take a look here?

FlowProfile was defined as readonly: https://github.com/Azure/azure-rest-api-specs/blob/2348dc4ab22ee29f9a71aa54810056f5553fc164/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-05-30-preview/azuredatatransfer.json#L4147
Get-AzDataTransferAzureDataTransferFlowProfile has subject: AzureDataTransferFlowProfile. Comes from API: ListFlowProfiles=>POST:"/providers/Microsoft.AzureDataTransfer/listFlowProfiles"
Get-AzDataTransferFlowProfile has subject: FlowProfile. Comes from API: Get=>GET:"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/flowProfiles/{flowProfileName}"
PowerShell has naming convention of using singular noun as parameter name, AntiviruAvSolutions -> AntiviruAvSolution is expected

fzkhan · 2025-09-24T06:59:52Z

@VeryEarly Seeing some weird behaviour from autorest here.

In the New-AzDataTransferFlow command, I am expecting new parameters including FlowProfile, as added in the API spec. However, the generated commands do not have them for New-AzDataTransferFlow, only for New-AzDataTransferConnection

I see two new commands Get-AzDataTransferAzureDataTransferFlowProfile and Get-AzDataTransferFlowProfile, when it should just be Get-AzDataTransferFlowProfile

Some parameters are getting renamed incorrectly: AntivirusSolutions is renamed as AntiviruAvSolution in New-AzDataTransferFlowProfile command.

I tried removing the directives I had added to see if they were the issue here, but it seems the output is still the same either way. Can you please take a look here?

FlowProfile was defined as readonly: https://github.com/Azure/azure-rest-api-specs/blob/2348dc4ab22ee29f9a71aa54810056f5553fc164/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2025-05-30-preview/azuredatatransfer.json#L4147

Get-AzDataTransferAzureDataTransferFlowProfile has subject: AzureDataTransferFlowProfile. Comes from API: ListFlowProfiles=>POST:"/providers/Microsoft.AzureDataTransfer/listFlowProfiles"
Get-AzDataTransferFlowProfile has subject: FlowProfile. Comes from API: Get=>GET:"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/flowProfiles/{flowProfileName}"

PowerShell has naming convention of using singular noun as parameter name, AntiviruAvSolutions -> AntiviruAvSolution is expected

@VeryEarly

Makes sense, I did not notice it has been marked as read-only in the FlowProperties. Seems like a mistake, I will check with the backend team about this. Meanwhile, is there a way for autorest to consider these readOnly fields as params to our commands anyway? Maybe some config we can use here? It will take time to resolve this on the backend and deploy, so thinking if we can resolve this on the front end and take the backend in parallel.
This makes sense, I will see if I can rename the list one to include both in the same command
For this, I will rename it in the directives I think, should be okay.

isra-fel · 2025-09-24T10:31:38Z

/azp run

azure-pipelines · 2025-09-24T10:31:55Z

Azure Pipelines successfully started running 3 pipeline(s).

isra-fel · 2025-09-25T12:31:05Z

/azp run

azure-pipelines · 2025-09-25T12:31:25Z

Azure Pipelines successfully started running 3 pipeline(s).

isra-fel · 2025-09-26T03:31:06Z

/azp run

azure-pipelines · 2025-09-26T03:31:13Z

Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command.

VeryEarly · 2025-09-26T08:00:33Z

/azp run

azure-pipelines · 2025-09-26T08:00:49Z

Azure Pipelines successfully started running 3 pipeline(s).

isra-fel · 2025-09-28T16:31:07Z

/azp run

azure-pipelines · 2025-09-28T16:31:25Z

Azure Pipelines successfully started running 3 pipeline(s).

isra-fel · 2025-09-28T18:31:18Z

/azp run

azure-pipelines · 2025-09-28T18:31:36Z

Azure Pipelines successfully started running 3 pipeline(s).

fzkhan · 2025-09-29T00:52:18Z

...DataTransfer/DataTransfer.Autorest/test/Invoke-AzDataTransferExecutePipelineAction.Tests.ps1

This command is hidden and does not need any tests, we have custom cmdlets with tests that are exposing this command separately.

VeryEarly · 2025-09-29T07:18:31Z

/azp run

azure-pipelines · 2025-09-29T07:18:49Z

Azure Pipelines successfully started running 3 pipeline(s).

Document changes related to FlowProfile commands and updates.

VeryEarly · 2025-09-29T07:40:13Z

/azp run

azure-pipelines · 2025-09-29T07:40:31Z

Azure Pipelines successfully started running 3 pipeline(s).

Switch to newer preview version

c99c186

fzkhan marked this pull request as ready for review September 18, 2025 01:38

Copilot AI review requested due to automatic review settings September 18, 2025 01:38

Copilot AI reviewed Sep 18, 2025

View reviewed changes

VeryEarly self-assigned this Sep 18, 2025

Add tests and examples

ac0c114

Rename AV param and Get-FlowProfile command

fca1bbb

Faizan Uddin Fahad Khan added 3 commits September 24, 2025 17:30

Also rename in Update-FlowProfile, remove unneeded tests

b529e15

fix some tests

bfafad7

add tests for New-Flow with all params

bcb2769

Remove private RP code and update docs

34b12b3

VeryEarly changed the base branch from main to Az.DataTransfer-preview September 26, 2025 08:00

Faizan Uddin Fahad Khan added 2 commits September 28, 2025 07:41

Rename AV property as well

3d8e6bd

Record test for new commands

44a4f8d

Faizan Uddin Fahad Khan added 5 commits September 28, 2025 19:48

Record more tests

7913a3d

Record some moar tests

5b4230c

Record rest of test

5403d7c

regenerate docs and examples

deff74b

remove extra file

03d30ff

remove extra file

9a2da1d

fzkhan changed the title ~~[Az.DataTransfer] DoNotMerge: Switch to newer preview version with FlowProfiles commands~~ [Az.DataTransfer] Switch to newer preview version with FlowProfiles commands Sep 28, 2025

fzkhan commented Sep 29, 2025

View reviewed changes

Create \BreakingChangeIssues.csv

1beb813

fzkhan and others added 2 commits September 29, 2025 13:04

Update ChangeLog with FlowProfile commands

5766b7a

Document changes related to FlowProfile commands and updates.

Rename \BreakingChangeIssues.csv to BreakingChangeIssues.csv

2b0110d

VeryEarly approved these changes Sep 29, 2025

View reviewed changes

VeryEarly merged commit ae91343 into Azure:Az.DataTransfer-preview Sep 29, 2025
12 checks passed

github-actions bot mentioned this pull request Oct 1, 2025

Monthly issue metrics report #28630

Closed

fzkhan mentioned this pull request Oct 13, 2025

[DoNotMerge][Az.DataTransfer] Switch to API version 2025-10-10 #28676

Open

6 tasks

	Please not, that this value cannot be updated after creation.
	Please note, that this value cannot be updated after creation.

	For more detail, please refer to the MimeTypeFiler model.
	For more detail, please refer to the MimeTypeFilter model.

[Az.DataTransfer] Switch to newer preview version with FlowProfiles commands #28579

[Az.DataTransfer] Switch to newer preview version with FlowProfiles commands #28579

Uh oh!

Conversation

fzkhan commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd bot commented Sep 18, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

fzkhan commented Sep 18, 2025

Uh oh!

azure-pipelines bot commented Sep 18, 2025

Uh oh!

VeryEarly commented Sep 18, 2025

Uh oh!

azure-pipelines bot commented Sep 18, 2025

Uh oh!

fzkhan commented Sep 22, 2025

Uh oh!

VeryEarly commented Sep 24, 2025

Uh oh!

fzkhan commented Sep 24, 2025

Uh oh!

isra-fel commented Sep 24, 2025

Uh oh!

azure-pipelines bot commented Sep 24, 2025

Uh oh!

isra-fel commented Sep 25, 2025

Uh oh!

azure-pipelines bot commented Sep 25, 2025

Uh oh!

isra-fel commented Sep 26, 2025

Uh oh!

azure-pipelines bot commented Sep 26, 2025

Uh oh!

VeryEarly commented Sep 26, 2025

Uh oh!

azure-pipelines bot commented Sep 26, 2025

Uh oh!

isra-fel commented Sep 28, 2025

Uh oh!

azure-pipelines bot commented Sep 28, 2025

Uh oh!

isra-fel commented Sep 28, 2025

Uh oh!

azure-pipelines bot commented Sep 28, 2025

Uh oh!

fzkhan Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

VeryEarly commented Sep 29, 2025

Uh oh!

azure-pipelines bot commented Sep 29, 2025

Uh oh!

VeryEarly commented Sep 29, 2025

fzkhan commented Sep 18, 2025 •

edited

Loading