Microsoft Azure CLI Telemetry Package

1.1.0 · active · verified Thu Apr 09

The `azure-cli-telemetry` package is an internal component of the Microsoft Azure CLI. Its primary function is to collect anonymous usage data and diagnostic information to help improve the CLI's reliability and performance. [2, 4] It is not typically intended for direct consumption or installation by end-users or for standalone application development. [6, 7, 8, 9] The package maintains a stable, though infrequent, release cadence, with its functionality primarily managed through the broader `azure-cli` releases. [6]

Warnings

gotcha This library is an internal component of the Azure CLI and is not intended for direct installation or programmatic use by end-users. Its internal APIs are not stable and may change without notice, potentially breaking user applications if directly depended upon. [6, 7, 8, 9]
Fix: Do not install or use `azure-cli-telemetry` as a standalone dependency in end-user applications. Rely on the `azure-cli` package and its official public interfaces for Azure interactions.
gotcha Telemetry collection by the Azure CLI (which this package enables) is opt-out and enabled by default. To disable telemetry, you must use the `az config set core.collect_telemetry=False` command within the Azure CLI itself, rather than trying to configure this Python package directly. [4, 14]
Fix: Use the Azure CLI configuration command: `az config set core.collect_telemetry=False`. You can verify the setting with `az config get core.collect_telemetry`.
gotcha The version of the `azure-cli-telemetry` package (e.g., 1.1.0) is independent of the main `azure-cli` version (e.g., 2.85.0). Users might encounter issues where the telemetry component appears 'stuck' at an older version even after upgrading the main CLI. [18]
Fix: While `azure-cli` versions 2.40.0 and later addressed some update issues for telemetry, generally avoid manually updating this component. If issues persist, a full reinstallation of the Azure CLI is recommended. [18, 22]

Install

pip install azure-cli-telemetry Install via pip (Discouraged for direct use)

Quickstart

This library is an internal dependency of the Azure CLI and is not designed for direct interaction by end-users. Direct programmatic use is not recommended, and there is no public API or quickstart for standalone usage. Telemetry collection, which this package facilitates, is controlled via the Azure CLI's configuration settings.

# This library is an internal dependency of the Azure CLI and is not designed for direct interaction by end-users.
# Telemetry collection, which this package facilitates, can be configured or disabled
# via the Azure CLI's configuration settings.
# To disable telemetry for the Azure CLI:
# az config set core.collect_telemetry=False
# For more information on Azure CLI configuration, refer to the official Microsoft documentation.

view raw JSON →