Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 4.68 KB

Readme.md

File metadata and controls

44 lines (31 loc) · 4.68 KB
Raw

Azure CLI

Overview

This task supports running Azure CLI commands on Cross platform agents running Windows, Linux or Mac.

What's new in Version 1.0

  • Supports the new AZ CLI 2.0 which is Python based
  • Works with Xplat agents (Windows, Linux or OSX)
  • For working with Azure CLI 1.0 which is node based, switch to task version 0.0
  • Both versions of Azure-CLI can coexist in the same system but task V1.0 logs-in using user’s subsscription into the Python based AZ CLI, where as task V0.0 logs-in to the node based Azure CLI. Hence script should ensure to include only corresponding commands.
  • Limitations:
    • No support for Classic subscriptions. AZ CLI 2.0 supports only Azure Resource Manager (ARM) subscriptions
    • Currently, Hosted agents do not have AZ CLI installed, you can either install using ‘npm install -g azure-cli’ or use private agents with AZ CLI pre-installed

Contact Information

Please report a problem at Developer Community Forum if you are facing problems in making this task work. You can also share feedback about the task like, what more functionality should be added to the task, what other tasks you would like to have, at the same place.

Pre-requisites for the task

The following pre-requisites need to be setup in the target machine(s) for the task to work properly.

Azure Subscription

To deploy to Azure, an Azure subscription has to be linked to Team Foundation Server or to Visual Studio Team Services using the Services tab in the Account Administration section. Add the Azure subscription to use in the Build or Release Management definition by opening the Account Administration screen (gear icon on the top-right of the screen) and then click on the Services Tab.

  • For Azure Classic resources use 'Azure' endpoint type with Certificate or Credentials based authentication. If you are using credentials based auth, ensure that the credentials are for a work account because Microsoft accounts like joe@live.com or joe@hotmail.com are not supported.
  • For ARM, use 'Azure Resource Manager' endpoint type, for more details follow the steps listed in the link here.

Azure CLI

The task needs the Azure CLI version to be installed on the automation agent, and the details are available here. If an agent is already running on the machine on which the Azure CLI is installed, ensure to restart the agent to ensure all the relavent environment variables are updated.

Parameters of the task

The task is used to run Azure CLI commands on Cross platform agents running Windows, Linux or Mac . The mandatory fields are highlighted with a *.

  • Azure Connection Type*: Specify Azure endpoint type, for Azure Classic resources use 'Azure' endpoint, for Azure ARM resources use 'Azure Resource Manager' endpoint. This parameter is shown only when the selected task version is 0.* as Azure CLI task v1.0 supports only Azure Resource Manager (ARM) subscriptions

  • Azure Subscription*: Select the Azure Subscription where the Azure CLI commands have to be executed. If none exists, then click on the Manage link, to navigate to the Services tab in the Administrators panel. In the tab click on New Service Endpoint and select Azure Resource Manager from the dropdown.

  • Script Location*: Select the mode of providing the script. Task supports two modes: one as a Script Path to a linked artifact and another as an inline script, default selection being the "Script Path"

  • Script Path*: Specify the path to the .bat , .cmd or .sh script you want to run. The path must be a fully qualified path or a valid path relative to the default working directory.

  • Arguments: Specify arguments to pass to the script.

  • Working folder: Specify the working directory in which you want to run the script. If you leave it empty, the working directory is the folder where the script is located.

  • Fail on standard error: Select this check box if you want the build to fail if errors are written to the StandardError stream.