Azure Common

1.1.28 · deprecated · verified Sat Mar 28

The `azure-common` library served as a foundational package providing shared code, common exceptions, and configuration mechanisms across various older Azure SDK for Python libraries. While its latest release is 1.1.28 (February 2022), much of its functionality has been superseded by `azure-core` and `azure-identity` in the newer generation of Azure SDKs. It generally had a slow release cadence due to its foundational nature.

Warnings

breaking The `azure-common` library is officially deprecated, and its support ended on March 31, 2023. It is strongly recommended to migrate to the newer Azure SDK client libraries which utilize `azure-core` and `azure-identity` for common functionalities, as older libraries will no longer receive official support and updates from Microsoft.
Fix: Transition to modern Azure SDK packages. For common exceptions, use `azure.core.exceptions`. For authentication, use `azure-identity`. Consult Azure SDK migration guides for specific service clients.
gotcha `azure-common` has implicit, undeclared dependencies on `msrest`, `msrestazure`, and `adal` for certain (now mostly deprecated) functionalities, such as `azure.common.client_factory`. Without these packages explicitly installed, attempting to use such features will result in `ImportError`s. Both `msrestazure` and `adal` are themselves deprecated.
Fix: Avoid using functionalities that rely on these implicit dependencies. If absolutely necessary for legacy code, explicitly install `pip install msrest msrestazure adal` (but be aware these packages are also deprecated).
deprecated Specific methods within `azure-common`, such as `azure.common.cloud.get_cli_active_cloud` and `azure.common.credentials.get_azure_cli_credentials`, are deprecated (explicitly in version 1.1.28) and are incompatible with `azure-cli-core` versions 2.21.0 and higher due to API changes in the CLI.
Fix: For credential management, use `AzureCliCredential` from the `azure-identity` library (e.g., `from azure.identity import AzureCliCredential`).

Install

pip install azure-common Install latest version

Imports

AzureMissingResourceOrPropertyError
```
from azure.common import AzureMissingResourceOrPropertyError
```
An example of a common exception. For new development, exceptions from `azure-core` should be preferred (e.g., `azure.core.exceptions.ResourceNotFoundError`).
get_azure_cli_credentials
```
from azure.common.credentials import get_azure_cli_credentials
```
This method is deprecated and does not work with modern Azure CLI versions (>=2.21.0). Use `azure-identity.AzureCliCredential` instead for authentication.

Quickstart

A minimal demonstration of importing and using an exception from `azure-common`. Given its deprecated status, this library is generally not recommended for new development.

from azure.common import AzureMissingResourceOrPropertyError

try:
    raise AzureMissingResourceOrPropertyError('Resource not found in legacy system.')
except AzureMissingResourceOrPropertyError as e:
    print(f"Caught expected legacy error: {e}")

# For new code, consider using azure-core exceptions, e.g.:
# from azure.core.exceptions import ResourceNotFoundError
# try:
#     raise ResourceNotFoundError('Resource not found in modern system.')
# except ResourceNotFoundError as e:
#     print(f"Caught modern error: {e}")

view raw JSON →