-
Notifications
You must be signed in to change notification settings - Fork 1.5k
[azure-data-transfer] Adding new extension for azure-data-transfer and commands within the extension. #8854
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
Conversation
|
Validation for Breaking Change Starting...
Thanks for your contribution! |
|
Hi @lasuredd-msft, |
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
CodeGen Tools Feedback CollectionThank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Adds the new azure-data-transfer Azure CLI extension with commands for managing data transfer pipelines, connections, and flows.
- Introduces the extension loader and command registration for
azure-data-transfer. - Implements AAZ-based commands for connection operations (create, list, show, delete, link, wait, list-pending).
- Implements AAZ-based commands for flow operations under each connection (create, list, show, link, enable, disable, update).
- Provides parameter definitions, help text, README, and initial release history.
Reviewed Changes
Copilot reviewed 54 out of 54 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/azure-data-transfer/azext_azure_data_transfer/_params.py | Defines CLI parameters for pipeline and flow commands |
| src/azure-data-transfer/azext_azure_data_transfer/_help.py | Adds help strings and examples for new commands |
| src/azure-data-transfer/azext_azure_data_transfer/init.py | Registers the extension’s command loader |
| src/azure-data-transfer/README.md | Documents installation and usage examples |
| src/azure-data-transfer/HISTORY.rst | Adds initial release history for the extension |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/init.py | Initializes AAZ support package |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/init.py | Initializes latest AAZ commands package |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/__cmd_group.py | Registers top-level azure-data-transfer command group |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/init.py | Imports top-level command group |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/__cmd_group.py | Registers connection command group |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/init.py | Imports connection command modules |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/_list.py | Implements connection list command |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/_show.py | Implements connection show command |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/_delete.py | Implements connection delete command |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/_link.py | Implements connection link command |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/_wait.py | Implements connection wait command |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/_list_pending_connection.py | Implements connection list-pending-connection command |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/_list_pending_flow.py | Implements connection list-pending-flow command |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/flow/__cmd_group.py | Registers connection flow command group |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/flow/init.py | Imports flow command modules |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/flow/_link.py | Implements connection flow link command |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/flow/_create.py | Implements connection flow create command |
| src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/flow/_list.py | Implements connection flow list command |
| src/azure-data-transfer/azext_azure_data_transfer/azext_azure_data_transfer/init.py | Defines the CLI commands loader |
Comments suppressed due to low confidence (3)
src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/_list_pending_flow.py:49
- The
--connection-nameargument is missing the short alias (-n/--name). Consider adding-nand--nameto match other commands and improve discoverability.
_args_schema.connection_name = AAZStrArg(options=["--connection-name"],
src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/connection/flow/_link.py:69
- In the flow link command, the argument is named
pending_connection_id. To avoid confusion with the connection-level link, rename this topending_flow_id(and--pending-flow-id) so it clearly refers to a flow.
_args_schema.pending_connection_id = AAZStrArg(
src/azure-data-transfer/README.md:105
- The example for listing connections uses
connection link. It should beaz azure-data-transfer connection listto match the command being demonstrated.
az azure-data-transfer connection link \
|
| Release History | ||
| =============== | ||
|
|
||
| 1.0.0b1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we starting with 1.x here? I thought we would need to keep sem-ver below 1 for private preview: e.g. - 0.1.0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The minimum product for release is 1.x, extensions in preview have 1.xbx, once we move out of preview then the version number starts from 1.x.
...fer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/pipeline/_approve_connection.py
Outdated
Show resolved
Hide resolved
src/azure-data-transfer/azext_azure_data_transfer/tests/latest/test_azure_data_transfer.py
Outdated
Show resolved
Hide resolved
src/azure-data-transfer/azext_azure_data_transfer/tests/latest/test_azure_data_transfer.py
Outdated
Show resolved
Hide resolved
66f2457 to
6ac3c34
Compare
6ac3c34 to
e693dec
Compare
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
@lasuredd-msft is it ready for release? |
Yes @necusjz PR is ready for review. |
src/azure-data-transfer/README.md
Outdated
| ##### Get a pipeline | ||
|
|
||
| ``` | ||
| az azure-data-transfer pipeline show \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do you think az azure-data-transfer xx is a good name? cauz, az and azure-* have the duplicate meaning here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moved away from the duplicate azure naming , renamed to data-transfer
|
Commenter does not have sufficient privileges for PR 8854 in repo Azure/azure-cli-extensions |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
plz provide the link of your pull request in Azure/aaz, thank you. |
AAZ repo PR link : Azure/aaz#785 |
40ac60e to
a47dd2e
Compare
a47dd2e to
b198671
Compare
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
[Release] Update index.json for extension [ data-transfer-1.0.0b1 ] : https://dev.azure.com/msazure/One/_build/results?buildId=128087626&view=results |
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
Adding new extension azure-data-transfer and commands to support connection and flow operations.
General Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)python scripts/ci/test_index.py -qlocally? (pip install wheel==0.30.0required)For new extensions:
About Extension Publish
There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update
src/index.jsonautomatically.You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify
src/index.json.