Configuración de la CLI de Azure
La CLI de Azure permite que el usuario configure opciones tales como el registro, la recopilación de datos y los valores de argumento predeterminados. La CLI ofrece un práctico comando para administrar algunos valores predeterminados, az config. Otros valores se pueden establecer en un archivo de configuración o con variables de entorno. En este artículo se proporciona más información sobre estos valores de la configuración del usuario y sobre cómo configurar la CLI de Azure.
Los valores de configuración usados por la CLI se evalúan según la siguiente prioridad, con mayor prioridad en los elementos superiores de la lista.
- Parámetros de línea de comandos
- Valores de parámetros persistentes establecidos con
az config param-persist - Variables de entorno
- Valores del archivo de configuración establecidos con
az config
Configuración de la CLI con az config
Los valores predeterminados de la CLI se establecen con el comando az configure set.
Este comando toma como argumento una lista de pares key=value separada por espacios. La CLI utiliza los valores proporcionados en lugar de los argumentos necesarios.
La tabla siguiente contiene una lista de las claves de configuración disponibles.
| Nombre | Descripción |
|---|---|
| defaults.group | El grupo de recursos predeterminado que se utilizará para todos los comandos. |
| defaults.location | La ubicación predeterminada que se utilizará para todos los comandos. |
| defaults.web | El nombre de la aplicación predeterminada que se usará para los comandos az webapp. |
| defaults.vm | El nombre de la máquina virtual predeterminada que se usará para los comandos az vm. |
| defaults.vmss | Nombre del conjunto de escalado de máquinas virtuales (VMSS) predeterminado que se usará para los comandos az vmss. |
| defaults.acr | El nombre del registro de contenedor predeterminado que se usará para los comandos az acr. |
Por ejemplo, aquí se muestra cómo se establecería el grupo de recursos y la ubicación de forma predeterminada para todos los comandos.
az config set defaults.location=westus2 defaults.group=MyResourceGroup
Archivo de configuración de la CLI
El archivo de configuración de la CLI contiene otros valores que se usan para administrar el comportamiento de la CLI. El archivo de configuración se encuentra en $AZURE_CONFIG_DIR/config. El valor predeterminado de AZURE_CONFIG_DIR es $HOME/.azure en Linux y macOS y %USERPROFILE%\.azure en Windows.
Los archivos de configuración se escriben en el formato de archivos INI. Este formato de archivo se define mediante encabezados de sección, seguidos de una lista de pares clave-valor.
- Los encabezados de sección se escriben como
[section-name]. Los nombres de sección distinguen entre mayúsculas y minúsculas. - Las entradas se escriben como
key=value. Los nombres de clave no distinguen mayúsculas de minúsculas. - Los comentarios son cualquier línea que comience por un
#o;. No se permiten comentarios en línea.
Los valores booleanos no distinguen mayúsculas de minúsculas y se representan por los valores siguientes.
- True:
1,yes,true,on - False:
0,no,false,off
Este es un ejemplo de un archivo de configuración de la CLI que deshabilita los avisos de confirmación y establece el registro en el directorio /var/log/azure.
[core]
disable_confirm_prompt=Yes
[logging]
enable_log_file=yes
log_dir=/var/log/azure
Consulte la siguiente sección para obtener los detalles de todos los valores de configuración disponibles y su significado. Para obtener los detalles completos sobre el formato de archivos INI, consulte la documentación de Python sobre INI.
Valores de configuración de la CLI y variables de entorno
La tabla siguiente contiene todos los nombres de las secciones y de las opciones que se pueden utilizar en un archivo de configuración. Las variables de entorno correspondientes se establecen como AZURE_{section}_{name}, todo en mayúsculas. Por ejemplo, el valor predeterminado output de core se establece en la variable AZURE_CORE_OUTPUT, el valor predeterminado storage_account de batchai se establece en la variable AZURE_BATCHAI_STORAGE_ACCOUNT, y el valor predeterminado location se establece en la variable AZURE_DEFAULTS_LOCATION.
Al proporcionar un valor predeterminado, ningún comando necesita ya ese argumento. En su lugar, se usa el valor predeterminado.
| Sección | Nombre | Tipo | Descripción |
|---|---|---|---|
| core | output | string | El formato de salida predeterminado. Puede ser json, jsonc, tsv o table. |
| disable_confirm_prompt | boolean | Activa o desactiva los mensajes de confirmación. | |
| collect_telemetry | boolean | Permite que Microsoft recopile datos anónimos sobre el uso de la CLI. Para más información sobre privacidad, consulte la licencia MIT de la CLI de Azure. | |
| only_show_errors | boolean | Solo muestra los errores durante la invocación del comando. En otras palabras, solo se escribirán los errores en stderr. Suprime las advertencias de los comandos en versión preliminar, en desuso y experimentales. También está disponible para comandos individuales con el parámetro --only-show-errors. |
|
| no_color | boolean | Deshabilita el color. Los mensajes que originalmente tenían color tendrán como prefijo DEBUG, INFO, WARNING y ERROR. Esto omite el problema de una biblioteca de terceros en la que el color del terminal no se puede revertir después de un redireccionamiento de stdout. |
|
| logging | enable_log_file | boolean | Activar o desactivar el registro. |
| log_dir | string | El directorio en el que se escribe el registro. De manera predeterminada, este valor es ${AZURE_CONFIG_DIR}/logs*. |
|
| defaults | group | string | El grupo de recursos predeterminado que se utilizará para todos los comandos. |
| ubicación | string | La ubicación predeterminada que se utilizará para todos los comandos. | |
| web | string | El nombre de la aplicación predeterminada que se usará para los comandos az webapp. |
|
| vm | string | El nombre de la máquina virtual predeterminada que se usará para los comandos az vm. |
|
| vmss | string | Nombre del conjunto de escalado de máquinas virtuales (VMSS) predeterminado que se usará para los comandos az vmss. |
|
| acr | string | El nombre del registro de contenedor predeterminado que se usará para los comandos az acr. |
|
| storage | account | string | Nombre de la cuenta de almacenamiento predeterminada (por ejemplo, mystorageaccount en https://mystorageaccount.blob.core.windows.net) para usar con los comandos del plano de datos az storage (por ejemplo, az storage container list ). |
| key | string | Clave de acceso predeterminada que se va a utilizar para los comandos del plano de datos az storage. |
|
| sas_token | string | Token SAS predeterminado que se va a utilizar para los comandos del plano de datos az storage. |
|
| connection_string | string | Cadena de conexión predeterminada que se va a utilizar para los comandos del plano de datos az storage. |
|
| batchai | storage_account | string | La cuenta de almacenamiento predeterminada que se usará para los comandos az batchai. |
| storage_key | string | La clave de almacenamiento predeterminada que se usará para los comandos az batchai. |
|
| batch | account | string | El nombre de la cuenta de Azure Batch predeterminada que se usará para los comandos az batch. |
| access_key | string | La clave de acceso predeterminada que se usará para los comandos az batch. Solo se usa con autorización aad. |
|
| endpoint | string | El punto de conexión predeterminado para los comandos az batch. |
|
| auth_mode | string | El modo de autorización que se usará para los comandos az batch. Puede ser shared_key o aad. |
|
| cloud | name | string | La nube predeterminada para todos los comandos az. Los valores posibles son AzureCloud (predeterminado), AzureChinaCloud, AzureUSGovernment y AzureGermanCloud. Para cambiar de nube, puede usar el comando az cloud set –name. Para obtener un ejemplo, consulte Administración de nubes con la CLI de Azure. |
| extension | use_dynamic_install | string | Instale una extensión si aún no se ha agregado al ejecutar un comando de la misma. Los valores posibles son no (predeterminado), yes_prompt y yes_without_prompt. |
| run_after_dynamic_install | boolean | Continúe con la ejecución del comando cuando se instala dinámicamente una extensión. El valor predeterminado es False. |
Nota
Puede ver otros valores en el archivo de configuración, pero estos se administran directamente mediante comandos de la CLI, incluido az config. Los que aparecen en la tabla anterior son los únicos valores que debe cambiar usted mismo.