az command-change

  • Reference

Note

This reference is part of the command-change extension for the Azure CLI (version 2.19.0 or higher). The extension will automatically install the first time you run an az command-change command. Learn more about extensions.

Commands for CLI modules metadata management.

Commands

Name Description Type Status
az command-change meta-diff

Diff command meta between provided meta files.

 Extension GA
az command-change version-diff

Diff command meta data between different cli versions.

 Extension GA

az command-change meta-diff

Diff command meta between provided meta files.

az command-change meta-diff --base-meta-file
                            --diff-meta-file
                            [--only-break]
                            [--output-file]
                            [--output-type {dict, text, tree}]

Examples

Diff command meta change from fileA to fileB

az command-change meta-diff --base-meta-file fileA --diff-meta-file fileB --only-break

Required Parameters

--base-meta-file

Command meta json file.

--diff-meta-file

Command meta json file to diff.

Optional Parameters

--only-break

Whether include non breaking changes.

default value: False
--output-file

Command meta diff json file path to store.

--output-type

Format to print diff and suggest message.

accepted values: dict, text, tree
default value: dict
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az command-change version-diff

Diff command meta data between different cli versions.

az command-change version-diff --base-version
                               --diff-version
                               [--only-break]
                               [--output-type]
                               [--target-module]
                               [--use-cache]
                               [--version-diff-file]

Examples

Diff command meta data of monitor module between cli version 2.49.0 and 2.47.0

az command-change version-diff --base-version 2.47.0 --diff-version 2.49.0 --target-module monitor

Required Parameters

--base-version

Azure cli version as base.

--diff-version

Azure cli version to diff.

Optional Parameters

--only-break

Whether include non breaking changes.

default value: False
--output-type

Command meta diff format to store.

default value: dict
--target-module

Module chosen to diff between different cli versions.

--use-cache

Whether use cached metadata files.

default value: False
--version-diff-file

Command meta version diff file path to store.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.