[devcenter] Update data plane API to v2024-10-01-preview #8379
Conversation
Update project env type parameters
Fix environment def example and update style
Fix show logs
Fix integration tests
Fix gallery test
Fix gallery test
Fix gallery compute
Update to 2024-05-01-preview
Update version
Update data plane to v2024-10-01-preview
Update data plane tests 2024-10-01-preview
|
| rule | cmd_name | rule_message | suggest_message |
|---|---|---|---|
| devcenter dev customization-task show | cmd devcenter dev customization-task show update parameter task_name: updated property options from ['--task-name'] to ['--name', '--task-name', '-n'] |
||
| devcenter dev customization-task validate | cmd devcenter dev customization-task validate added parameter no_wait |
||
| devcenter dev dev-box capture-snapshot | cmd devcenter dev dev-box capture-snapshot added |
||
| devcenter dev dev-box list-snapshot | cmd devcenter dev dev-box list-snapshot added |
||
| devcenter dev dev-box restore-snapshot | cmd devcenter dev dev-box restore-snapshot added |
||
| devcenter dev dev-box show-snapshot | cmd devcenter dev dev-box show-snapshot added |
||
| devcenter dev environment-type list-abilities | cmd devcenter dev environment-type list-abilities added |
||
| devcenter dev environment-type show | cmd devcenter dev environment-type show added |
||
| devcenter dev image-build | sub group devcenter dev image-build added |
||
| devcenter dev project list-abilities | cmd devcenter dev project list-abilities added |
||
| devcenter dev project show-operation | cmd devcenter dev project show-operation added |
|
Hi @am-lim, |
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
🚫All pull requests will be blocked to merge until Jan 6, 2025 due to CCOA |
microsoft-github-policy-service
bot
requested review from
kairu-ms and
jsntcy
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 |
|
| def get_dataplane_endpoint(cli_ctx, endpoint=None, dev_center=None, project_name=None): | ||
| validate_endpoint(endpoint, dev_center) | ||
| if endpoint is None and dev_center is not None: | ||
| project = get_project_data(cli_ctx, dev_center, project_name) | ||
| endpoint = project["devCenterUri"] | ||
| endpoint = endpoint.split('//', 1)[-1] |
There was a problem hiding this comment.
It seems the user can defined data-plane endpoints by three ways:
- directly provide the endpoint
- provide the
dev_centerand using the first devCenterUri of the project - provide both
dev_centerandproject_nameand using the devCenterUri
My question is why need the third way if providing the dev_center is enough to get the devCenterUri in response.
And for the second way actually you can config the data plane client like this which will retrieve the properties.devCenterUri as endpoint from devcenter resource from the control plane api.
There was a problem hiding this comment.
@kairu-ms For the question about why the third way is included, for commands that have a project name, we fail earlier and let the user know that the reason for the failure is that the project does not exist within the dev center. Otherwise, for example the user may receive a 401 not found for their get command or an empty list for their list command - but the user would be unaware that this is caused because the project does not exist within the chosen dev center.
I don't know if we can config the data plane client "By resource property" in the screenshot. This is because users using the data plane are only assumed to have read access to the project, not the dev center. Also, some commands do not have project name as a parameter (For example, in some list commands the user can list all the resources available in a dev center). This is why we need to use the azure resource graph query on all projects. Given this context, not sure if we can set up the devCenterUri this way?
|
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 |
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.