Skip to content

Conversation

@lasuredd-msft
Copy link
Contributor

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

  • Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
  • Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)
  • My extension version conforms to the Extension version schema

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.json automatically.
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.

Copilot AI review requested due to automatic review settings July 6, 2025 18:58
@azure-client-tools-bot-prd
Copy link

azure-client-tools-bot-prd bot commented Jul 6, 2025

️✔️Azure CLI Extensions Breaking Change Test
️✔️Non Breaking Changes

@azure-client-tools-bot-prd
Copy link

Hi @lasuredd-msft,
Please write the description of changes which can be perceived by customers into HISTORY.rst.
If you want to release a new extension version, please update the version in setup.py as well.

@yonzhan
Copy link
Collaborator

yonzhan commented Jul 6, 2025

Thank you for your contribution! We will review the pull request and get back to you soon.

@github-actions
Copy link

github-actions bot commented Jul 6, 2025

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).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

Copy link
Contributor

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 new ID-based usage examples for data transfer commands, updates the Azure Data Transfer service naming, and adjusts versioning and CLI dependency requirements.

  • Added --ids examples 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 --ids flags 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"

@github-actions
Copy link

github-actions bot commented Jul 6, 2025

CodeGen Tools Feedback Collection

Thank 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

@github-actions
Copy link

github-actions bot commented Jul 6, 2025

Hi @lasuredd-msft

Release Suggestions

Module: data-transfer

  • Please log updates into to src/data-transfer/HISTORY.rst

Notes

@yonzhan yonzhan requested review from jsntcy and kairu-ms July 6, 2025 22:35
@lasuredd-msft lasuredd-msft requested a review from fzkhan July 7, 2025 10:00
Copy link
Member

@fzkhan fzkhan left a 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

@pkuma-microsoft
Copy link

Thank you for your contribution! We will review the pull request and get back to you soon.

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 :-)

@jsntcy jsntcy merged commit a66b42f into Azure:main Jul 10, 2025
24 checks passed
@azclibot
Copy link
Collaborator

[Release] Update index.json for extension [ data-transfer-1.0.0b2 ] : https://dev.azure.com/msazure/One/_build/results?buildId=129907557&view=results

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants