Skip to content

Azure/azure-iot-ops-cli-extension

Repository files navigation

Microsoft Azure IoT Operations extension for Azure CLI

Python Build

The Azure IoT Operations extension for Azure CLI aims to accelerate the development, management and automation of Azure IoT Operations solutions. It does this via addition of rich features and functionality to the official Azure CLI.

Pre-requisites

  • An Azure Arc-enabled CNCF K8s cluster.
  • Azure CLI 2.46.0 or higher. If you don't have az cli installed, follow these instructions.

Install az iot ops extension

🌟 Windows, macOS and common Linux environments are supported.

❗ Please uninstall the private preview az edge extension with az extension remove --name azure-edge if you have it installed.

The IoT Ops CLI is part of the Azure CLI extension index. Installation is as simple as:

az extension add --upgrade --name azure-iot-ops

After install, the root command group az iot ops should be available and ready for use.

  • List installed extensions with az extension list
  • Remove an installed extension with az extension remove --name <extension-name>

Connecting to a K8s cluster

👉 To maintain minimum friction between K8s tools, the az iot ops edge side commands are designed to make use of your existing kube config (typically located at ~/.kube/config).

All k8s interaction commands include an optional --context param. If none is provided current_context as defined in the kube config will be used.

Available Functionality

🚀 Always start with the --help flag to understand details about command groups, their containing commands & subgroups.

Comprehensive documentation is available in the Wiki.

Contributing

Please refer to the Contributing page for developer setup instructions and contribution guidelines.

Feedback

We are constantly improving and are always open to new functionality or enhancement ideas. Submit your feedback in the project issues.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.