{Doc} Track 2 Migration Guidance #16330
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@jsntcy for awareness. |
yungezz
reviewed
Dec 21, 2020
|
|
||
| **Long running operation function name change** | ||
|
|
||
| Long running operations have changed their function names in Track 2 SDK. A `begin_` prefix is added. E.g. `create_or_update` becomes `begin_create_or_update`. `delete` becomes `begin_delete`. It is a naming convention in Track 2 SDK to indicate that an operation is a long running operation. |
There was a problem hiding this comment.
how about add a PR link with code change to show detail for each item?
|
|
||
| Some of property names change in Track 2 SDK. | ||
|
|
||
| Examples: |
There was a problem hiding this comment.
sample as above, sample PR is very helpful
jiasli
reviewed
Dec 24, 2020
jiasli
reviewed
Dec 24, 2020
jiasli
reviewed
Dec 24, 2020
Co-authored-by: Jiashuo Li <[email protected]>
jiasli
reviewed
Dec 25, 2020
jiasli
reviewed
Dec 25, 2020
doc/track_2_migration_guidance.md
Outdated
|
|
||
| In DiskAccess `begin_create_or_update`, location and tags are moved to a nested structure `DiskAccess`, `disk_access = DiskAccess(location=location, tags=tags)` | ||
|
|
||
| ### Obtaining Subscription |
There was a problem hiding this comment.
Better to use base form of verbs.
There was a problem hiding this comment.
http://www.davidnicholson.it/language/on-ing-forms-in-titles.html
I prefer gerund.
3 tasks
jiasli
approved these changes
Dec 29, 2020
jiasli
reviewed
Dec 29, 2020
jiasli
reviewed
Dec 29, 2020
Co-authored-by: Jiashuo Li <[email protected]>
qwordy
commented
Dec 29, 2020
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
{Doc} Track 2 Migration Guidance
Azure CLI is built upon Azure Python SDK. Recently Azure Python SDK announced next generation product. It is named Track 2 SDK. The old version of SDK is named Track 1. It claims that it has great advantages than Track 1 SDK. It is not compatible with Track 1 SDK. Azure CLI developers need to spend considerable time and do some work to migrate from Track 1 SDK to Track 2 SDK.
This documentation summarizes typical issues and solutions when adopting Track 2 SDK in Azure CLI.
You are welcome to contribute to this documentation if you have experience of Track 2 SDK.
Testing Guide
History Notes
[Component Name 1] BREAKING CHANGE: az command a: Make some customer-facing breaking change.
[Component Name 2] az command b: Add some customer-facing feature.
This checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.