az extension
Manage extension packages and discovery-backed extension state.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az extension add |
Install an extension package from a feed or local file. |
Core | Preview |
| az extension list |
List discovered installed extensions. |
Core | Preview |
| az extension pin |
Pin an installed extension so it won't be updated automatically. |
Core | Preview |
| az extension remove |
Remove an installed extension package. |
Core | Preview |
| az extension show |
Show discovery-backed details of an installed extension. |
Core | Preview |
| az extension unpin |
Remove the pin from an extension so it can be updated again. |
Core | Preview |
| az extension update |
Update an installed extension to a newer version. |
Core | Preview |
az extension add
Install an extension package from a feed or local file.
Install an extension package into the user extension directory from a NuGet feed or a local .nupkg file. Use --name for package-based installs or --path for local artifacts. After installation, the package is discoverable by subsequent az commands without any manual registry edits.
az extension add [--feed-url]
[--force]
[--name]
[--path]
[--pin]
[--version]
Examples
Install from official feed
az extension add --name MyExtension --version 1.0.0 --feed-url https://api.nuget.org/v3/index.json
Install from custom feed
az extension add --name MyExtension --version 1.0.0 --feed-url https://packages.example.com/nuget
Install from local file
az extension add --path ./MyExtension.1.0.0.nupkg
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
NuGet feed URL to install from when using --name.
Allow add to overwrite an existing pinned installation of the same package.
Package id (full or short suffix) of the extension to add from a feed. Verb and namespace tokens are not accepted. Omit when using --path.
Path to a local extension .nupkg file to install.
Pin the installed version so future 'update' commands skip it without --force.
Optional version to install when using --name. Omit to use the latest available package version.
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.
az extension list
List discovered installed extensions.
Display every extension the CLI can currently load off disk, overlaid with user preferences from the registry. Includes both packages bundled with the az install (under <install>/Extensions/) and packages installed by the user via az extension add (under ~/.azclips/extensions/). By default, output is grouped by package; use --by-verb to regroup by each contributed CLI verb. Each row includes a Location field with the absolute path to the primary DLL that would be loaded for that extension, a selectedVersion field naming the version dispatch will route to, and a candidates array listing every discovered candidate for the package with its tier (Bundled or Installed) and location.
az extension list [--by-verb]
Examples
List installed extensions
az extension list
Group by verb
az extension list --by-verb
Emit structured JSON
az extension list --output json
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Regroup output verb-headed: one section per verb, listing every package that contributes to it.
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.
az extension pin
Pin an installed extension so it won't be updated automatically.
Mark an extension as pinned. Pinned extensions are skipped by az extension update unless --force is specified. Use this to hold a known-good version while other extensions update. The extension is identified by its package id (full or short suffix); verb and namespace tokens are not accepted as selectors.
az extension pin --name
Examples
Pin by short name
az extension pin --name Compute
Required Parameters
Package id (full or short suffix) of the extension to pin. Verb and namespace tokens are not accepted.
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.
az extension remove
Remove an installed extension package.
Uninstall an extension package by deleting its installed payload and removing any persisted preference entry. The extension is identified by its package id (full or short suffix). Verb and namespace tokens are not accepted; a missed lookup includes a Did you mean '--name <Package>'? hint when the token unambiguously maps to an installed package. Built-in extensions cannot be removed.
az extension remove --name
Examples
Remove by short name
az extension remove --name Compute
Remove by package id
az extension remove --name Microsoft.Azure.Azclips.Extensions.Compute
Required Parameters
Package id (full or short suffix) of the extension to remove. Verb and namespace tokens are not accepted.
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.
az extension show
Show discovery-backed details of an installed extension.
Display metadata for a single installed extension package as discovered on disk, including its package id, installed version, pin state, contributed CLI verbs, and the on-disk Location of the primary DLL that would be loaded. The extension is identified by its package id (full or short suffix); verb and namespace tokens are not accepted as selectors.
az extension show --name
Examples
Show by short name
az extension show --name Compute
Show by package id
az extension show --name Microsoft.Azure.Azclips.Extensions.Compute
Required Parameters
Package id (full or short suffix) of the extension to show. Verb and namespace tokens are not accepted.
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.
az extension unpin
Remove the pin from an extension so it can be updated again.
Clear the pin flag on a previously-pinned extension. After unpinning, az extension update will once again consider the extension for automatic upgrades. The extension is identified by its package id (full or short suffix); verb and namespace tokens are not accepted as selectors.
az extension unpin --name
Examples
Unpin by short name
az extension unpin --name Compute
Required Parameters
Package id (full or short suffix) of the extension to unpin. Verb and namespace tokens are not accepted.
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.
az extension update
Update an installed extension to a newer version.
Replace the installed version of an extension with a newer one from the configured feed. Pinned extensions are skipped unless --force is supplied. The extension is identified by its package id (full or short suffix); verb and namespace tokens are not accepted as selectors.
az extension update --name
[--feed-url]
[--force]
[--version]
Examples
Update to the latest version
az extension update --name Compute
Update to a specific version
az extension update --name Compute --version 2.1.0
Force update over a pin
az extension update --name Compute --force
Required Parameters
Package id (full or short suffix) of the extension to update. Verb and namespace tokens are not accepted.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Feed URL to install the new version from.
Update even if the extension is pinned.
Target version. Defaults to the latest available from the configured feed.
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.