Skip to content

Latest commit

 

History

History
156 lines (93 loc) · 4.9 KB

azure-sdk-install.md

File metadata and controls

156 lines (93 loc) · 4.9 KB
title description ms.date ms.topic ms.custom adobe-target
How to install Azure SDK library packages for Python
How to install, uninstall, and verify Azure SDK or Python libraries using pip and conda. Includes details on installing specific versions and preview packages.
05/24/2021
conceptual
devx-track-python
true

How to install Azure library packages for Python

The Azure SDK for Python is composed solely of many individual libraries that can be installed in standard Python or Conda environments.

Libraries for standard Python environments are listed in the package index.

Packages for Conda environments are listed in the Microsoft channel on anaconda.org. Azure packages have names that begin with azure-.

With these Azure libraries you can provision and manage resources on Azure services (using the management libraries, whose names begin with azure-mgmt) and connect with those resources from app code (using the client libraries, whose names begin with just azure-).

Install the latest version of a library

pip install <library>

pip install retrieves the latest version of a library in your current Python environment.

On Linux systems, you must install a library for each user separately. Installing libraries for all users with sudo pip install isn't supported.

You can use any package name listed in the package index.

Be sure you've added the Microsoft channel to your Conda configuration (you need to do this only once):

conda config --add channels "Microsoft"

Then install the desired package:

conda install <package>

conda install retrieves the latest version of a package in your current Python environment.

You can use any package name listed in the Microsoft channel on anaconda.org. Azure packages have named that begin with azure-.

Packages for Conda are grouped by services. For example, azure-storage includes libraries for working with blobs, file shares, queues, and any other Azure Storage service. The single azure-mgmt package contains the management libraries for all services.


Install specific library versions

Be sure you've added the Microsoft channel to your Conda configuration (you need to do this only once):

conda config --add channels "Microsoft"
pip install <library>==<version>

Specify the desired version on the command line with pip install.

You can use any package name listed in the package index.

conda install <package>==<version>

Specify the desired version on the command line with conda install --revision.

You can use any package name listed in the Microsoft channel on anaconda.org. Azure packages have named that begin with azure-.


Install preview packages

pip install --pre <library>

To install the latest preview of a library, include the --pre flag on the command line.

Microsoft periodically releases preview library packages that support upcoming features, with the caveat that the library is subject to change and must not be used in production projects.

You can use any package name listed in the package index.

Preview packages for Conda are not available at this time.


Verify a library installation

pip show <library>

If the library is installed, pip show displays version and other summary information, otherwise the command displays nothing.

You can also use pip freeze or pip list to see all the libraries that are installed in your current Python environment.

You can use any package name listed in the package index.

conda list <package>

If the package is installed, conda list displays version and other summary information, otherwise the command displays nothing.

You can also use conda list to see all the packages that are installed in your current conda environment.

You can use any package name listed in the Microsoft channel on anaconda.org. Azure packages have named that begin with azure-.


Uninstall a library

pip uninstall library.

To uninstall a library, use pip uninstall.

You can use any package name listed in the package index.

conda remove <package>

To uninstall a package, use conda remove <package>.

You can use any package name listed in the Microsoft channel on anaconda.org. Azure packages have named that begin with azure-.