-
Notifications
You must be signed in to change notification settings - Fork 1.5k
[Azure-data-transfer]Adding more examples to the azure data transfer #8943
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
️✔️Azure CLI Extensions Breaking Change Test
|
|
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>
|
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
This PR adds new ID-based usage examples for data transfer commands, updates the Azure Data Transfer service naming, and adjusts versioning and CLI dependency requirements.
- Added
--idsexamples to connection and flow commands for improved user guidance - Updated service name to include “(ADT)”, bumped extension version, and lowered minimum Azure CLI core version
- Refined command docstrings for clarity
Reviewed Changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/service_name.json | Append “(ADT)” to service name |
| src/data-transfer/setup.py | Bump extension version from 1.0.0b1 to 1.0.0b2 |
| src/data-transfer/azext_data_transfer/azext_metadata.json | Lower minimum Azure CLI core dependency from 2.70.0 to 2.0.24 |
| src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/pipeline/_list.py | Simplify pipeline list docstring |
| src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/flow/_show.py | Add --ids usage example |
| src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/flow/_list.py | Clarify flow listing docstring |
| src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/flow/_link.py | Add multiple --ids examples |
| src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/flow/_enable.py | Add --ids usage example |
| src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/flow/_disable.py | Add --ids usage example |
| src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/flow/_delete.py | Change delete docstring and add --ids example |
| src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/flow/_create.py | Update create docstring |
| src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/_show.py | Add --ids usage example |
| src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/_list.py | Clarify connection listing docstring |
| src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/_link.py | Add --ids usage example (typo present) |
| src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/_delete.py | Add multi-ID delete example |
| src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/_create.py | Extend create examples with list syntax and quoting variations |
| src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/__cmd_group.py | Expand cmd group description |
Comments suppressed due to low confidence (4)
src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/flow/_link.py:23
- Typo in the example: change 'recieveConnection' to 'receiveConnection' for correct spelling.
az data-transfer connection flow link --ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/receiveConnection/testConnection/flows/receiveFlow --pending-flow-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/sendConnection/flows/sendFlow
src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/_create.py:27
- [nitpick] Examples use both 'eastus' and 'East US' formats for the --location parameter; for consistency, standardize on the recommended short region name format (e.g.,
--location eastus).
az data-transfer connection create --resource-group testRG --connection-name testConnection --location 'East US' --pipeline testdc --pin 12345 --flow-types Api Mission --direction Send
src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/_delete.py:24
- The example concatenates two resource IDs without clear separation; consider using comma-separated IDs or separate
--idsflags to illustrate correct syntax.
az data-transfer connection delete --ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2
src/data-transfer/azext_data_transfer/azext_metadata.json:3
- Lowering the minimum CLI core version to 2.0.24 may introduce compatibility issues with unsupported older CLI versions; please confirm this change aligns with supported releases or adjust to a valid minimum version.
"azext.minCliCoreVersion": "2.0.24"
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 |
Release SuggestionsModule: data-transfer
Notes
|
fzkhan
left a comment
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.
LGTM! Just a minor comment as per the internal chat
src/data-transfer/azext_data_transfer/aaz/latest/data_transfer/connection/_delete.py
Show resolved
Hide resolved
Hi @yonzhan, gentle reminder on this; we are waiting for this PR to be merged so we can share the private preview comms with our LT. Appreciate your help on this :-) |
|
[Release] Update index.json for extension [ data-transfer-1.0.0b2 ] : https://dev.azure.com/msazure/One/_build/results?buildId=129907557&view=results |
Change includes addition of examples for the azure data transfer.
Changed the dependancy of the azure cli to lower version.
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
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.