How to install Azure library packages for Python

The Azure SDK for Python is composed of many individual libraries that you can install in standard Python or conda environments.

You can find libraries for standard Python environments in the package index.

You can find packages for conda environments in the Microsoft channel on anaconda.org. Azure packages have names that begin with azure-.

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

Install the latest version of a package

pip

pip install <package>

pip install gets the latest version of a package in your current Python environment.

On Linux systems, you must install a package separately for each user. Don't use sudo pip install to install packages for all users, as it's unsupported.

Use any package name listed in the package index. On the index page, look in the Name column for the functionality you need, and then find and select the PyPI link in the Package column.

conda

Make sure you add the Microsoft channel to your conda configuration (run this command only once):

conda config --add channels "Microsoft"

Then, install the package you want:

conda install <package>

conda install gets the latest version of a package for your current Python environment.

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

Conda packages are grouped by service. 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 package versions

pip

Specify the version you want on the command line by using pip install.

pip install <package>==<version>

You can find version numbers in the package index. On the index page, look in the Name column for the functionality you need, and then find and select the PyPI link in the Package column. For example, to install a version of the azure-storage-blob package, use: pip install azure-storage-blob==12.19.0.

conda

Make sure you add the Microsoft channel to your conda configuration (run this command only once):

conda config --add channels "Microsoft"

Then, install the package and version you want:

conda install <package>==<version>

You can find version numbers on the Microsoft channel on anaconda.org. Azure packages have names that start with azure-. Find the library or package you want, open it, and look for the version number in the "Files" tab. For example, to install a version of azure-storage, use: conda install azure-storage=2023.09.01. Or, specify the version you want on the command line by using conda install --revision.

Install preview packages

pip

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

pip install --pre <package>

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

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

conda

Preview packages for conda aren't available at this time.

Verify a package installation

pip

To verify a package installation, run the following command:

pip show <package>

If the package 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 packages that are installed in your current Python environment.

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

conda

To verify a package installation, run the following command:

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 names that start with azure-.

Uninstall a package

pip

To uninstall a package:

pip uninstall <package>

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

conda

To uninstall a package:

conda remove <package>

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