Практическое руководство по работе с глобальными параметрами в Azure CLI
При работе с справочными командами Azure CLI существуют аргументы, доступные для большинства команд. Эти аргументы называются "глобальными параметрами", так как они являются общими для почти всех ссылочных команд Azure CLI.
--help глобальный параметр
Чтобы получить сведения о эталонной группе или команде, используйте глобальный --help параметр. В параметре --help отображаются справочные сведения о Azure CLI в консоли, включая доступные подгруппы и списки параметров.
az group create --name myResourceGroup --location eastus --help
Следующие выходные данные консоли, показанные здесь, содержат поля, опустимые для краткости:
Command
az group create : Create a new resource group.
Arguments
--location -l [Required] : Location. Values from: `az account list-locations`.
You can configure the default location using `az
configure --defaults location=<location>`.
--name --resource-group -g -n [Required] : Name of the new resource group.
--managed-by : The ID of the resource that manages this resource
group.
--tags : Space-separated tags: key[=value] [key[=value] ...].
Use "" to clear existing tags.
Global Arguments
--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.
Examples
Create a new resource group in the West US region.
az group create -l westus -n MyResourceGroup
--verbose глобальный параметр
Дополнительные сведения о ведении журнала см. в статье о добавлении глобального --verbose параметра в команду ссылки. Подробные выходные данные полезны при попытке понять, почему некоторые команды занимают больше времени, чем другие для выполнения.
az group create --name myResourceGroup --location eastus --verbose
Приведенные ниже выходные данные консоли содержат поля, пропущенные для краткости, но обратите внимание на дополнительные сведения о времени выполнения.
{...}
Command ran in 1.413 seconds (init: 0.487, invoke: 0.926)
--debug глобальный параметр
Если дополнительные сведения из --verbose параметра недостаточно, и вы хотите просмотреть весь журнал, используйте глобальный --debug параметр. Также укажите выходные данные, созданные --debug при отправке отчета об ошибке.
az group create --name myrResourceGroup --location eastus --debug
Следующие выходные данные консоли, показанные здесь, содержат поля, опустимые для краткости:
cli.knack.cli: Command arguments: ['group', 'create', '--name', 'myResourceGroup', '--location', 'eastus', '--debug']
cli.knack.cli: __init__ debug log:
[...]
cli.knack.cli: Event: CommandInvoker.OnTransformResult [<function _resource_group_transform at 0x000001D9B72123B0>, <function _x509_from_base64_to_hex_transform at 0x000001D9B7212440>]
cli.knack.cli: Event: CommandInvoker.OnFilterResult []
{...}
[...]
telemetry.process: Return from creating process
telemetry.main: Finish creating telemetry upload process.
--only-show-errors глобальный параметр
Во время отладки удалите предупреждения, возвращаемые командой ссылки, с помощью глобального --only-show-errors параметра.
az interactive
Выходная консоль:
**This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus**
Any comments or concerns? You can use the 'feedback' command! We would greatly appreciate it.
A new Recommender is added which can make the completion ability more intelligent and provide the scenario completion!
If you want to disable this feature, you can use 'az config set interactive.enable_recommender=False' to disable it.
A command preload mechanism was added to prevent lagging and command run errors.
You can skip preloading in a single pass by CTRL+C or turn it off by setting 'az config set interactive.enable_preloading=False'
Loading command table... Expected time around 1 minute.
--subscription глобальный параметр
Глобальный --subscription параметр можно использовать для задания определенной подписки для команды. В следующем примере изменяется активная подписка с помощью идентификатора подписки:
az account set --subscription "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--output глобальный параметр
Чтобы отобразить выходные данные команды в определенном формате, укажите --output глобальный параметр. В этом примере выходные данные отображаются в виде таблицы:
Примечание.
Допустимые значения выходных данных: json, jsonc, none, table, tsv, yaml и yamlc. Значение выходных данных по умолчанию — json.
az vm list --resource-group myResourceGroup --output table
Выходная консоль:
Name ResourceGroup Location
------ --------------- ----------
myVm myResourceGroup eastus
Дополнительные сведения о различных форматах выходных данных см. в разделе "Выходные форматы" для команд Azure CLI.
--query глобальный параметр
Иногда в выходной консоли могут отображаться обширные объемы информации, которые необходимо отфильтровать. Для этого используйте глобальный --query параметр для выполнения запроса JMESPath в результатах команд. JMESPath — это язык запросов для JSON, который позволяет выбирать и изменять данные из выходных данных Azure CLI.
В этом примере возвращаются открытые ключи SSH, авторизованные для подключения к виртуальной машине, добавив --query:
az vm show --resource-group myResourceGroup --name myVm --query "osProfile.linuxConfigurat
ion.ssh.publicKeys"
Выходная консоль:
[
{
"keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC7WbiMEsB0iwdGPjeGXs3UWFtzbCkUwtIxzkIOpEtlqkLGa0XQdvwhzok6szq6Ycx/f4cfid/yrmBPtzmxdQnGeCy2FOcVIzp+SkjIUg/Ez2YyDcMb60u66QUmHPRyhipJ/PDZROt6O0092qfTkTjB+7hLRiZzV2raLjiQ95eV0AXUP+Gsvdo/7ytqWNIm3iQTWbQ/GwSg+p0v+kmZELIbrxo845dambSpgBL8g0wCUZaptru3ZHo9m0UWbFPASVJKauhfPCSVPQCaOCaAdB01Ih8QDVRCazT+jyV6GgTwUIXVQthVBbt56ibhuSUdf0cWF8IVncjH+WXexVAhQw0j",
"path": "/home/yourName/.ssh/authorized_keys"
}
]
Дополнительные сведения о выполнении запросов к выходным данным команды см. в статье "Как запросить выходные данные команды Azure CLI" с помощью запроса JMESPath.
