azure-cli/doc/extensions

Extension Documentation

What is an Extension?

An extension adds/modifies/removes commands that are part of az and can be optionally installed by the user.

• Extensions are supported through all installation methods.
• Extensions are the way to go to release private/public previews of your Azure CLI commands.
• Currently, we support one extension type, a Python Wheel.
• All extension documentation here refers to this type of extension.

What an Extension is not

• An extension is not an external executable or product outside of az.

• If you're looking to create a command module which is installed by default for az, see authoring command modules.

• If you're looking to build your own CLI using az patterns, see knack.

Doc Sections

• Authoring - How to author and develop an extension

• Command Guidelines - Command Guidelines

• Publishing - How to publish an extension

• Extension Metadata - How to add additional extension metadata

• FAQ - Commonly asked questions