diff --git a/README.md b/README.md index 3f390f79ffa8..7be0ecafcbce 100644 --- a/README.md +++ b/README.md @@ -35,13 +35,15 @@ You can find the [most up to date list of all of the new packages on our page](h Last stable versions of packages that have been provided for usage with Azure and are production-ready. These libraries provide you with similar functionalities to the Preview ones as they allow you to use and consume existing resources and interact with them, for example: upload a blob. They might not implement the [guidelines](https://azure.github.io/azure-sdk/python_introduction.html) or have the same feature set as the Novemeber releases. They do however offer wider coverage of services. ### Management: New Releases -A new set of management libraries that follow the [Azure SDK Design Guidelines for Python](https://azure.github.io/azure-sdk/python/guidelines/) are now in Public Preview. These new libraries provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. -You can find the list of new packages [on this page](https://azure.github.io/azure-sdk/releases/latest/mgmt/python.html). Documentation and for these new libraries can be found [here](https://aka.ms/azure-sdk-python-mgmt). Code samples can also be viewed [here](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing). In addition, a migration guide that shows how to transition from older versions of libraries is located [here](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/sphinx/python_mgmt_migration_guide.rst). +A new set of management libraries that follow the [Azure SDK Design Guidelines for Python](https://azure.github.io/azure-sdk/python/guidelines/) are now available. These new libraries provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. +Documentation and code samples for these new libraries can be found [here](http://aka.ms/azsdk/python/mgmt). In addition, a migration guide that shows how to transition from older versions of libraries is located [here](https://azure.github.io/azure-sdk-for-python/mgmt_preview_quickstart.html#migration-guide). -> NOTE: If you need to ensure your code is ready for production use one of the stable, non-preview libraries. +You can find the [most up to date list of all of the new packages on our page](https://azure.github.io/azure-sdk/releases/latest/mgmt/python.html) + +> NOTE: If you need to ensure your code is ready for production use one of the stable, non-preview libraries. Also, if you are experiencing authentication issues with the management libraries after upgrading certain packages, it's possible that you upgraded to the new versions of SDK without changing the authentication code, please refer to the migration guide mentioned above for proper instructions. ### Management: Previous Versions -For a complete list of management libraries which enable you to provision and manage Azure resources, please check [here](https://azure.github.io/azure-sdk/releases/latest/all/python.html). They might not have the same feature set as the new releases but they do offer wider coverage of services. +For a complete list of management libraries which enable you to provision and manage Azure resources, please [check here](https://azure.github.io/azure-sdk/releases/latest/all/python.html). They might not have the same feature set as the new releases but they do offer wider coverage of services. Management libraries can be identified by namespaces that start with `azure-mgmt-`, e.g. `azure-mgmt-compute` ## Need help? diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index a0c7e4f3a67a..e426a8fcc2d3 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -65,7 +65,7 @@ section of the project. installation quickstart_authentication - mgmt_preview_quickstart + mgmt_quickstart python_mgmt_migration_guide multicloud exceptions diff --git a/doc/sphinx/mgmt_preview_quickstart.rst b/doc/sphinx/mgmt_quickstart.rst similarity index 94% rename from doc/sphinx/mgmt_preview_quickstart.rst rename to doc/sphinx/mgmt_quickstart.rst index 45d6c9617073..98002433ec09 100644 --- a/doc/sphinx/mgmt_preview_quickstart.rst +++ b/doc/sphinx/mgmt_quickstart.rst @@ -1,21 +1,21 @@ -Quickstart Tutorial - Resource Management (Preview Libraries) +Quickstart Tutorial - Resource Management =============================================================== -We are excited to announce that a new set of management libraries are now in Public Preview. +We are excited to announce that a new set of management libraries are now generally available. Those packages share a number of new features such as Azure Identity support, HTTP pipeline, error-handling.,etc, and they also follow the new Azure SDK guidelines which create easy-to-use APIs that are idiomatic, compatible, and dependable. -You can find the details of those new libraries `here `__ +You can find the details of those new libraries `here `__ In this basic quickstart guide, we will walk you through how to -authenticate to Azure using the preview libraries and start interacting with +authenticate to Azure using the new libraries and start interacting with Azure resources. There are several possible approaches to authentication. This document illustrates the most common scenario Migration Guide --------------- -If you are an existing user of the older version of Azure management library for Python and you are looking for a migration guide to the new beta version of the SDK, please refer to `this migration guide here `__ +If you are an existing user of the older version of Azure management library for Python and you are looking for a migration guide to the new version of the SDK, please refer to `this migration guide here `__ Prerequisites ------------- @@ -253,11 +253,11 @@ Note that asyncio in Windows is underpowered and please take caution when using Code Samples ------------------------- -For more code samples that demonstrate how to use our SDK to interact with Azure services, please visit `here `__ +For more code samples that demonstrate how to use our SDK to interact with Azure services, please visit `here `__. You can also view the Github repo that contains the code samples `here `__ Need help? ---------- -- File an issue via `Github Issues `__ and make sure you add the "Preview" label to the issue +- File an issue via `Github Issues `__ - Check `previous questions `__ or ask new ones on StackOverflow using azure and python tags. Contributing diff --git a/doc/sphinx/python_mgmt_migration_guide.rst b/doc/sphinx/python_mgmt_migration_guide.rst index 695d227d8208..fbfd254ecffe 100644 --- a/doc/sphinx/python_mgmt_migration_guide.rst +++ b/doc/sphinx/python_mgmt_migration_guide.rst @@ -11,7 +11,7 @@ libraries For users new to the Python SDK for resource management libraries, please see the `quickstart -guide `__ +guide `__ Table of contents ----------------- @@ -32,21 +32,23 @@ Prerequisites Updated Python Packages ----------------------- -Currently, all next-generation Python SDK management client libraries -are in Public Preview. The preview version SDK will be contain a ``b`` -in its version to number to indicate that it's a beta release (e.g. -``17.0.0b1``). The versioning information can be found on the release -history page of each Azure service on pypi.org. Take Azure Compute -service for example, the release history can be found at -`https://pypi.org/project/azure-mgmt-compute/17.0.0b1/history `__ - -You can also refer to the `this +You can refer to the `this site `__ -to see all the latest Python packages. +to see all the new Python packages. + +For packages that are already generally available (GA), you can directly install the package using pip. Take Azure Compute +service for example, simply do: +``pip install azure-mgmt-compute`` + +The release history for azure-mgmt-compute can be found at `https://pypi.org/project/azure-mgmt-compute/#history `__ + +You will notice that there was a beta release in release history, and the changelog for this version mentioned that "this version uses a next-generation code generator that introduces important breaking changes". This indicates the package is based on the new generator. + +In addition, some next-generation Python SDK management client libraries might still in Public Preview. The preview version SDK will be contain a ``b`` in its version to number to indicate that it's a beta release (e.g.``10.0.0b1``). -Please install the package based on the beta version number, for -example, to install the latest preview package for Compute, please use: -``pip install azure-mgmt-compute==17.0.0b1`` +For those beta releases, please install the package based on the beta version number, for +example, to install the latest preview package for BetaServiceExample, please use: +``pip install azure-mgmt-beta-service-example==10.0.0b1`` General Changes --------------- @@ -107,7 +109,7 @@ To the show the code snippets for the change: compute_client = azure.mgmt.compute.ComputeManagementClient(credential=credential, subscription_id=self.subscription_id) For detailed information on the benefits of using the new authentication -classes, please refer to `this +classes as well as all available authentication options, please refer to `this page `__ Client API Changes @@ -154,7 +156,7 @@ Additional Samples More samples can be found at : -- `Quickstart for new version of SDK `__ +- `Quickstart for new version of SDK `__ - `Code Samples for Resource Management Libraries `__ - `Authentication Documentation `__