Procedimiento para trabajar con parámetros globales en la CLI de Azure
Cuando se trabaja con los comandos de referencia de la CLI de Azure, hay argumentos que están disponibles para la mayoría de los comandos. Estos argumentos se denominan "parámetros globales", ya que son comunes a casi todos los comandos de referencia de la CLI de Azure.
--help
parámetro global
Para obtener información sobre un grupo de referencia o un comando, use el --help
parámetro global. El --help
parámetro muestra la información de referencia de la CLI de Azure en la consola, incluidas las listas de subgrupos y parámetros disponibles.
az group create --name myResourceGroup --location eastus --help
La siguiente salida de la consola que se muestra aquí tiene campos omitidos para mayor brevedad:
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
parámetro global
Obtenga más información detallada sobre el registro agregando el --verbose
parámetro global al comando de referencia. La salida detallada es útil al intentar comprender por qué determinados comandos tardan más tiempo que otros en ejecutarse.
az group create --name myResourceGroup --location eastus --verbose
La siguiente salida de la consola que se muestra aquí tiene campos omitidos para mayor brevedad, pero tenga en cuenta la información adicional sobre el tiempo de ejecución.
{...}
Command ran in 1.413 seconds (init: 0.487, invoke: 0.926)
--debug
parámetro global
Si los detalles adicionales del --verbose
parámetro no son suficientes y desea ver todo el registro, use el --debug
parámetro global. Proporcione también la salida generada al --debug
enviar un informe de errores.
az group create --name myrResourceGroup --location eastus --debug
La siguiente salida de la consola que se muestra aquí tiene campos omitidos para mayor brevedad:
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
parámetro global
Durante el proceso de depuración, quite las advertencias devueltas por un comando de referencia mediante el --only-show-errors
parámetro global.
az interactive
Consola de salida:
**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
parámetro global
Puede usar el --subscription
parámetro global para establecer una suscripción específica para un comando. En el ejemplo siguiente se cambia la suscripción activa mediante el identificador de suscripción:
az account set --subscription "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--output
parámetro global
Para mostrar la salida de un comando en un formato específico, especifique el --output
parámetro global. En este ejemplo, la salida se muestra como una tabla:
Nota:
Los valores aceptados para la salida son: json, jsonc, none, table, tsv, yaml y yamlc. El valor de salida predeterminado es json.
az vm list --resource-group myResourceGroup --output table
Consola de salida:
Name ResourceGroup Location
------ --------------- ----------
myVm myResourceGroup eastus
Para más información sobre los diferentes formatos de salida, consulte Formatos de salida para comandos de la CLI de Azure.
--query
parámetro global
Hay veces que la consola de salida puede mostrar grandes cantidades de información que necesita filtrar. Para ello, use el --query
parámetro global para ejecutar una consulta JMESPath en los resultados de los comandos. JMESPath es un lenguaje de consulta para JSON, que permite seleccionar y modificar datos de la salida de la CLI de Azure.
En este ejemplo se devuelven las claves públicas SSH autorizadas para conectarse a la máquina virtual agregando --query
:
az vm show --resource-group myResourceGroup --name myVm --query "osProfile.linuxConfigurat
ion.ssh.publicKeys"
Consola de salida:
[
{
"keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC7WbiMEsB0iwdGPjeGXs3UWFtzbCkUwtIxzkIOpEtlqkLGa0XQdvwhzok6szq6Ycx/f4cfid/yrmBPtzmxdQnGeCy2FOcVIzp+SkjIUg/Ez2YyDcMb60u66QUmHPRyhipJ/PDZROt6O0092qfTkTjB+7hLRiZzV2raLjiQ95eV0AXUP+Gsvdo/7ytqWNIm3iQTWbQ/GwSg+p0v+kmZELIbrxo845dambSpgBL8g0wCUZaptru3ZHo9m0UWbFPASVJKauhfPCSVPQCaOCaAdB01Ih8QDVRCazT+jyV6GgTwUIXVQthVBbt56ibhuSUdf0cWF8IVncjH+WXexVAhQw0j",
"path": "/home/yourName/.ssh/authorized_keys"
}
]
Para más información sobre cómo consultar la salida del comando, consulte Consulta de la salida de comandos de la CLI de Azure mediante una consulta JMESPath.