Add new cmdlets for AzureDataTransfer #27926

fzkhan · 2025-06-11T07:50:16Z

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-pipelines · 2025-06-12T05:21:24Z

Azure Pipelines successfully started running 3 pipeline(s).

vidai-msft · 2025-06-12T06:06:04Z

@fzkhan Please upload the generate-info.json file to fix the build issue.

github-actions · 2025-06-12T06:06:36Z

This PR was labeled "needs-revision" because it has unresolved review comments or CI failures.
Please resolve all open review comments and make sure all CI checks are green. Refer to our guide to troubleshoot common CI failures.

fzkhan · 2025-06-12T06:55:05Z

@vidai-msft I was following this wiki to generate the cmdlets and it did not output a generate-info.json for me. Is that something I have to add manually?

On the same note, I see a comment in the wiki that says:

Note: If the entire module (src/ServiceName) is new, regardless new onboard or rebrand, add tools/CreateMappings_rules.json in commit.

Is that also a file we have to add manually? So far, the only file I have added on my own is the ChangeLog.md

vidai-msft · 2025-06-12T07:39:24Z

@vidai-msft I was following this wiki to generate the cmdlets and it did not output a generate-info.json for me. Is that something I have to add manually?

On the same note, I see a comment in the wiki that says:

Note: If the entire module (src/ServiceName) is new, regardless new onboard or rebrand, add tools/CreateMappings_rules.json in commit.

Is that also a file we have to add manually? So far, the only file I have added on my own is the ChangeLog.md

The generate-info.json is generated by running build-module.ps1. If you do not see the file, please upgrade your autorest.powershell version to get the new feature.

fzkhan · 2025-06-12T09:44:09Z

@vidai-msft

root@fdf770018985:/src/AzureDataTransfer/AzureDataTransfer.Autorest# npm list -g @autorest/powershell
/root/.nvm/versions/node/v18.20.4/lib
└── @autorest/[email protected]

I updated to the latest version. But still not getting any additional files. Here is the autorest README.md output (I ran autorest --reset before this to clear the cache):

AutoRest code generation utility [cli version: 3.7.1; node: v18.20.4]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest

There is a new version of AutoRest available (3.7.2).
 > You can install the newer version with with npm install -g autorest@latest

installing core... [========================================] 100% | 2/2
info    |    Loading AutoRest core      '/root/.autorest/@[email protected]/nodemodules/@autorest/core/dist' (3.10.7)
info    | 
The default version of @autorest/powershell has been bumped from 3.0+ to 4.0+.
 > If you still want to use 3.0+ version, please specify it with --use:@autorest/[email protected].{x}, e.g 3.0.512.

info    |    Installing AutoRest extension '@autorest/powershell' (4.x -> 4.0.741)
installing... [========================================] 100% | 122/122
info    |    Installed AutoRest extension '@autorest/powershell' (4.x->4.0.741)
info    |    Installing AutoRest extension '@autorest/modelerfour' (~4.26.0 -> 4.26.2)
installing... [========================================] 100% | 2/2
info    |    Installed AutoRest extension '@autorest/modelerfour' (~4.26.0->4.26.2)
warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
warning | UsingTemporaryFlag | modelerfour.treat-type-object-as-anything options is a temporary flag. It WILL be removed in the future.
warning | Modeler/MissingType | The schema 'components·ehmgd1·schemas·readpipelineconnection·additionalproperties' has no type or format information whatsoever. Location:
   https://github.com/Azure/azure-rest-api-specs/blob/c424d91129a85194f3a0800a6bb5dcd28f8eb6eb/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2025-05-21/azuredatatransfer.json#/components/schemas/components·ehmgd1·schemas·readpipelineconnection·additionalproperties
warning | Modeler/MissingType | The schema 'components·zh5y8p·schemas·readreadpipelineconnectionproperties·additionalproperties' has no type or format information whatsoever. Location:
   https://github.com/Azure/azure-rest-api-specs/blob/c424d91129a85194f3a0800a6bb5dcd28f8eb6eb/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2025-05-21/azuredatatransfer.json#/components/schemas/components·zh5y8p·schemas·readreadpipelineconnectionproperties·additionalproperties
warning | Modeler/MissingType | The schema 'components·11tlp8x·schemas·readreadinternalmetadataproperties·additionalproperties' has no type or format information whatsoever. Location:
   https://github.com/Azure/azure-rest-api-specs/blob/c424d91129a85194f3a0800a6bb5dcd28f8eb6eb/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2025-05-21/azuredatatransfer.json#/components/schemas/components·11tlp8x·schemas·readreadinternalmetadataproperties·additionalproperties
info    | Autorest completed in 38.8s. 576 files generated.

Ran pwsh ./build-module.ps1 afterwards, but no luck.

vidai-msft · 2025-06-13T09:48:10Z

Can you share the detailed steps?

vidai-msft · 2025-06-14T03:22:43Z

@fzkhan Per our naming convention, the module should be DataTransfer instead of AzureDataTransfer. Could you please help update the module name and the corresponding folder name? cc @Alex-wdy

fzkhan · 2025-06-15T14:40:10Z

@vidai-msft I have renamed it to DataTransfer. But:

I still don't see the file you mentioned. Here is the exact list of steps I went through:

docker run -it -v Z:\Repos\azure-powershell\src:/src autorest
cd DataTransfer/DataTransfer.Autorest
autorest --reset
autorest README.md
pwsh ./build-module.ps1
pwsh ./run-module.ps1

I cannot run tests now as I am facing the same error as mentioned in these two threads (thread 1, thread 2). I am not using a local swagger, and I am running this command after running all of the commands I mentioned above: pwsh ./test-module.ps1 -Live
Error for reference:

PS /src/DataTransfer/DataTransfer.Autorest [Az.DataTransfer]> pwsh ./test-module.ps1 -Live
Creating isolated process...
Installing local Pester module into '/src/DataTransfer/DataTransfer.Autorest/generated/modules'...
Get-Item: /src/DataTransfer/DataTransfer.Autorest/test-module.ps1:44
Line |
  44 |  … ModulePSD = Get-Item -Path (Join-Path $HOME '.PSSharedModules\Resourc …
     |                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     | Cannot find path '/root/.PSSharedModules/Resources/Az.Resources.TestSupport.psd1' because it does not exist.

fzkhan · 2025-06-16T14:48:03Z

@vidai-msft Able to get around the testing failure now. Please let me know how to generate the file as I still am not able to get the commands to output it.

vidai-msft · 2025-06-17T02:40:43Z

/azp run

azure-pipelines · 2025-06-17T02:40:59Z

Azure Pipelines successfully started running 3 pipeline(s).

github-actions · 2025-06-17T03:02:02Z

‼️ DO NOT MERGE THIS PR ‼️
This PR was labeled "Do Not Merge" because it contains code change that cannot be merged. Please contact the reviewer for more information.

fzkhan · 2025-06-17T09:17:09Z

Formatting of examples is not correct and output is missing:

vidai-msft · 2025-06-17T09:55:18Z

Formatting of examples is not correct and output is missing:

@fzkhan Where did you see the output? From PowerShell console or markdown file?

fzkhan · 2025-06-17T09:57:04Z

@vidai-msft This is from the PS window after running ./run-module.ps1 :

vidai-msft · 2025-06-18T02:00:29Z

/azp run

azure-pipelines · 2025-06-18T02:00:46Z

Azure Pipelines successfully started running 3 pipeline(s).

vidai-msft · 2025-06-18T05:22:15Z

/azp run

azure-pipelines · 2025-06-18T05:22:30Z

Azure Pipelines successfully started running 3 pipeline(s).

Faizan Uddin Fahad Khan added 30 commits March 26, 2025 06:08

Add readme for AzureDataTransfer

9ca89d2

add all changes

dec5cc8

regen docs

785c4af

remove policy param

189a985

rename pendingConnectionId

5a1075e

hide params from create flow

b5e8e2c

remove from update as well

f13cf34

rename for PendingFlowId

b14a27b

hide params from update flow

6f6a967

remove redundant tests

ff70a8d

Add all get tests

64256f1

add delete tests

3d63a8b

add enable / disable tests

b75e34d

add approve/deny tests

a7f0b5c

add tests for linking

e72c872

add tests for create cmdlets

485ed8e

add update tests

4eceb26

add tests to CTS folder

34824de

more changes for private testing

cac9d1d

Fix approve/deny tests

98aeb4b

Fix more tests

f431856

fix rest of Get tests

4f06d45

fix create tests

28da3d1

fix remove tests

8f5a8e7

fix updates

682446c

fix links

04546b8

Add tests for AsJob

fe85eef

add tests to ADT folder

c45a6c1

nit changes

26e49d7

run codegen on new spec

d8de35f

vidai-msft added the needs-revision label Jun 12, 2025

nit: minor doc changes

d2111b7

Faizan Uddin Fahad Khan added 2 commits June 15, 2025 19:57

AzureDataTransfer -> DataTransfer

f1978ce

rename in README

330ef4e

Update test recordings

4e8105f

vidai-msft added the Do Not Merge 🚫 label Jun 17, 2025

examples not rendering correctly in terminal

966aca1

Faizan Uddin Fahad Khan and others added 2 commits June 17, 2025 22:38

Add generate-info and CreateMappings_rules files

927b44e

Merge branch 'main' into azure-data-transfer

387b17e

Add help documentation for Az.DataTransfer cmdlets

36152cb

Add new cmdlets for AzureDataTransfer #27926

Are you sure you want to change the base?

Add new cmdlets for AzureDataTransfer #27926

Conversation

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

Uh oh!

Description

Mandatory Checklist

Uh oh!

azure-pipelines bot commented Jun 12, 2025

Uh oh!

vidai-msft commented Jun 12, 2025

Uh oh!

github-actions bot commented Jun 12, 2025

Uh oh!

fzkhan commented Jun 12, 2025

Uh oh!

vidai-msft commented Jun 12, 2025

Uh oh!

fzkhan commented Jun 12, 2025

Uh oh!

vidai-msft commented Jun 13, 2025

Uh oh!

vidai-msft commented Jun 14, 2025

Uh oh!

fzkhan commented Jun 15, 2025

Uh oh!

fzkhan commented Jun 16, 2025

Uh oh!

vidai-msft commented Jun 17, 2025

Uh oh!

azure-pipelines bot commented Jun 17, 2025

Uh oh!

github-actions bot commented Jun 17, 2025

Uh oh!

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

Uh oh!

Uh oh!

vidai-msft commented Jun 17, 2025

Uh oh!

fzkhan commented Jun 17, 2025

Uh oh!

vidai-msft commented Jun 18, 2025

Uh oh!

azure-pipelines bot commented Jun 18, 2025

Uh oh!

vidai-msft commented Jun 18, 2025

Uh oh!

azure-pipelines bot commented Jun 18, 2025

Uh oh!

Uh oh!

fzkhan commented Jun 11, 2025 •

edited

Loading

fzkhan commented Jun 17, 2025 •

edited

Loading