Skip to content

Add new cmdlets for AzureDataTransfer #27926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 59 commits into
base: main
Choose a base branch
from

Conversation

fzkhan
Copy link
Member

@fzkhan fzkhan commented Jun 11, 2025

Description

Mandatory Checklist

  • 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

Copy link

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

@fzkhan
Copy link
Member Author

fzkhan commented Jun 11, 2025

@fzkhan fzkhan marked this pull request as ready for review June 11, 2025 09:58
@Copilot Copilot AI review requested due to automatic review settings June 11, 2025 09:58
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds full documentation and UX definitions for new AzureDataTransfer cmdlets, along with module scaffolding and assembly info.

  • Generated markdown help for all new cmdlets (Approve, Deny, Invoke-Link, Get, Enable/Disable flows, etc.).
  • Added UX JSON definitions for pipelines and connections commands.
  • Updated custom module loader script and AssemblyInfo.

Reviewed Changes

Copilot reviewed 89 out of 89 changed files in this pull request and generated 1 comment.

File Description
src/AzureDataTransfer/AzureDataTransfer.Autorest/docs/Invoke-AzDataTransferLinkPendingConnection.md Documentation for Invoke-AzDataTransferLinkPendingConnection.
src/AzureDataTransfer/AzureDataTransfer.Autorest/docs/Approve-AzDataTransferConnection.md Documentation for Approve-AzDataTransferConnection.
src/AzureDataTransfer/AzureDataTransfer.Autorest/docs/Deny-AzDataTransferConnection.md Documentation for Deny-AzDataTransferConnection.
Comments suppressed due to low confidence (2)

src/AzureDataTransfer/AzureDataTransfer.Autorest/docs/Deny-AzDataTransferConnection.md:64

  • [nitpick] The example uses pipelineName 'corptest', which doesn't match the preceding variable or typical naming; consider using 'Pipeline01' for consistency.
Deny-AzDataTransferConnection -PipelineName corptest -ResourceGroupName ResourceGroup01 -ConnectionId $connectionToDeny.Id -StatusReason "Not Authorized for processing" -Confirm:$false

src/AzureDataTransfer/AzureDataTransfer.Autorest/docs/Invoke-AzDataTransferLinkPendingConnection.md:18

  • [nitpick] Consider updating -SubscriptionId to accept an array (String[]) to match other cmdlets and support multiple subscriptions.
-PendingConnectionId <String> [-SubscriptionId <String>] [-StatusReason <String>]

@fzkhan fzkhan requested a review from lasuredd-msft June 11, 2025 10:33
@isra-fel
Copy link
Member

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@vidai-msft
Copy link
Contributor

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

Copy link

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
Copy link
Member Author

fzkhan commented Jun 12, 2025

@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
Copy link
Contributor

@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
Copy link
Member Author

fzkhan commented Jun 12, 2025

@vidai-msft

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

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/@autorestcore@3.10.7/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/powershell@3.0.{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
Copy link
Contributor

Can you share the detailed steps?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants