Compartir vía

AzureCLI@1: tarea de la CLI de Azure v1

  • Artículo

Ejecute comandos de la CLI de Azure en una suscripción de Azure en un script de shell cuando se ejecute en un agente de Linux o un script por lotes cuando se ejecute en el agente de Windows.

Ejecute un script de shell o por lotes con comandos de la CLI de Azure en una suscripción de Azure.

Syntax

# Azure CLI v1
# Run Azure CLI commands against an Azure subscription in a Shell script when running on Linux agent or Batch script when running on Windows agent.
- task: AzureCLI@1
  inputs:
    azureSubscription: # string. Alias: connectedServiceNameARM. Required. Azure subscription. 
    scriptLocation: 'scriptPath' # 'inlineScript' | 'scriptPath'. Required. Script Location. Default: scriptPath.
    scriptPath: # string. Required when scriptLocation = scriptPath. Script Path. 
    #inlineScript: # string. Required when scriptLocation = inlineScript. Inline Script. 
    #arguments: # string. Alias: args. Arguments. 
  # Advanced
    #addSpnToEnvironment: false # boolean. Access service principal details in script. Default: false.
    #useGlobalConfig: false # boolean. Use global Azure CLI configuration. Default: false.
    #workingDirectory: # string. Alias: cwd. Working Directory. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

# Azure CLI v1
# Run a Shell or Batch script with Azure CLI commands against an azure subscription.
- task: AzureCLI@1
  inputs:
    azureSubscription: # string. Alias: connectedServiceNameARM. Required. Azure subscription. 
    scriptLocation: 'scriptPath' # 'inlineScript' | 'scriptPath'. Required. Script Location. Default: scriptPath.
    scriptPath: # string. Required when scriptLocation = scriptPath. Script Path. 
    #inlineScript: # string. Required when scriptLocation = inlineScript. Inline Script. 
    #arguments: # string. Alias: args. Arguments. 
  # Advanced
    #workingDirectory: # string. Alias: cwd. Working Directory. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

Entradas

azureSubscription - Suscripción de Azure
Alias de entrada: connectedServiceNameARM. string. Obligatorio.

Selecciona una suscripción de Azure Resource Manager para la implementación.


scriptLocation - Ubicación del script
string. Obligatorio. Valores permitidos: inlineScript (script insertado), scriptPath (ruta de acceso del script). Valor predeterminado: scriptPath.

Selecciona la ubicación del script.


scriptPath - Ruta de acceso del script
string. Necesario cuando scriptLocation = scriptPath.

Ruta de acceso completa del script o una ruta de acceso relativa al directorio de trabajo predeterminado.


inlineScript - Script insertado
string. Necesario cuando scriptLocation = inlineScript.

Puede escribir los scripts en línea aquí. Al usar el agente de Windows, use el scripting por lotes. Use scripts de shell al usar agentes basados en Linux. En el caso de los archivos por lotes, use el prefijo call antes de cada comando de Azure. También puede pasar variables predefinidas y personalizadas a este script mediante argumentos.

Vea los ejemplos siguientes: El primero es un ejemplo de shell y el segundo es un ejemplo por lotes:

azure --version || azure account show 

call  azure --version || call azure account show

arguments - Argumentos
Alias de entrada: args. string.

Argumentos pasados al script.


addSpnToEnvironment - Acceso a los detalles de la entidad de servicio en el script
boolean. Valor predeterminado: false.

Agrega el identificador y la clave de la entidad de servicio del punto de conexión de Azure que eligió en el entorno de ejecución del script. Puede usar las variables y $servicePrincipalKey en el $servicePrincipalId script.

Esto solo se respeta cuando el punto de conexión de Azure tiene un esquema de autenticación de entidad de servicio.


useGlobalConfig - Uso de la configuración global de la CLI de Azure
boolean. Valor predeterminado: false.

Si es false, esta tarea usará su propio directorio de configuración de la CLI de Azure independiente. Esto se puede usar para ejecutar tareas de la CLI de Azure en versiones paralelas .


workingDirectory - Directorio de trabajo
Alias de entrada: cwd. string.

Directorio de trabajo actual donde se ejecuta el script. Si se deja en blanco, esta entrada es la raíz del repositorio (compilación) o artefactos (versión), que es $(System.DefaultWorkingDirectory).


failOnStandardError - Error en el error estándar
boolean. Valor predeterminado: false.

Si esta entrada es true, se producirá un error en esta tarea cuando se escriban errores en la secuencia StandardError. Desactive la casilla para omitir los errores estándar y, en su lugar, confíe en los códigos de salida para determinar el estado.


Opciones de control de tareas

Todas las tareas tienen opciones de control además de las entradas de tareas. Para obtener más información, vea Opciones de control y propiedades de tareas comunes.

Variables de salida

Ninguno.

Comentarios

Novedades de la versión 1.0:

  • Admite la nueva CLI de Azure 2.0 basada en Python.
  • Funciona con agentes multiplataforma (Linux, macOS o Windows)
  • Para trabajar con la CLI de Azure 1.0 (basada en node.js), cambie a la versión 0.0 de la tarea.
  • Limitaciones: no se admiten suscripciones clásicas de Azure. La CLI de Azure 2.0 solo admite suscripciones de Azure Resource Manager (ARM).

Requisitos

Requisito Descripción
Tipos de canalización YAML, compilación clásica, versión clásica
Se ejecuta en Agente, DeploymentGroup
Peticiones None
Capabilities Esta tarea no satisface ninguna demanda de tareas posteriores en el trabajo.
Restricciones de comandos Any
Variables que se pueden establecer Any
Versión del agente 2.0.0 o superior
Categoría de la tarea: Implementación