You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This task supports running [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/overview) commands on Cross platform agents running Windows, Linux or Mac.
5
+
6
+
### What's new in Version 1.0
7
+
- Supports the new [AZ CLI 2.0](https://docs.microsoft.com/en-us/cli/azure/overview) which is Python based
8
+
- Works with Xplat agents (Windows, Linux or OSX)
9
+
- For working with [Azure CLI 1.0](https://docs.microsoft.com/en-us/azure/cli-install-nodejs) which is node based, switch to task version 0.0
10
+
- Both versions of Azure-CLI can coexist in the same system but task V1.0 logs-in using user’s subscription 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.
11
+
- Limitations:
12
+
- No support for Classic subscriptions. AZ CLI 2.0 supports only Azure Resource Manager (ARM) subscriptions
13
+
14
+
## Contact Information
15
+
Please report a problem at [Developer Community Forum](https://developercommunity.visualstudio.com/spaces/21/index.html) 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.
16
+
17
+
## Pre-requisites for the task
18
+
The following pre-requisites need to be setup in the target machine(s) for the task to work properly.
19
+
20
+
#### **Azure Subscription**
21
+
To deploy to Azure, an Azure subscription has to be linked to Team Foundation Server or to Azure Pipelines using the Services tab in the settings 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.
22
+
- 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**](https://azure.microsoft.com/en-in/pricing/member-offers/msdn-benefits-details/work-accounts-faq/) because Microsoft accounts like [**[email protected]**](https://github.com/Microsoft/azure-pipelines-tasks/blob/master/Tasks/DeployAzureResourceGroup) or [**[email protected]**](https://github.com/Microsoft/azure-pipelines-tasks/blob/master/Tasks/DeployAzureResourceGroup) are not supported.
23
+
- For [ARM](https://azure.microsoft.com/en-in/documentation/articles/resource-group-overview/), use 'Azure Resource Manager' endpoint type, for more details follow the steps listed in the link [here](https://go.microsoft.com/fwlink/?LinkID=623000&clcid=0x409).
24
+
25
+
#### **Azure CLI**
26
+
The task needs the Azure CLI version to be installed on the automation agent, and the details are available [here](https://azure.microsoft.com/en-us/documentation/articles/xplat-cli-install/).
27
+
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 relevant environment variables are updated.
28
+
29
+
## Parameters of the task
30
+
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 *.
31
+
32
+
***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
33
+
34
+
***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.
35
+
36
+
***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"
37
+
38
+
***Script Path**\*: When using Windows based agent, specify the path to the .bat , .cmd script whereas when using Linux based agent, specify the path to the .sh script you want to run. The path must be a fully qualified path or a valid path relative to the default working directory.
39
+
40
+
***Inline Script**\*: Specify the script inline here. When using Windows based agent use batch scripting whereas use shell scripting when using Linux based agents.
41
+
42
+
***Arguments**: Specify arguments to pass to the script.
43
+
44
+
***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.
45
+
46
+
***Fail on standard error**: Select this check box if you want the build to fail if errors are written to the StandardError stream.
"loc.helpMarkDown": "[Weitere Informationen zu dieser Aufgabe](http://go.microsoft.com/fwlink/?LinkID=827160) oder [Azure CLI-Dokumentation anzeigen](https://docs.microsoft.com/cli/azure/)",
4
+
"loc.description": "Hiermit werden Azure CLI-Befehle für ein Azure-Abonnement in einem Shell-Skript (bei Ausführung für einen Linux-Agent) oder einem Batchskript (bei Ausführung für einen Windows-Agent) ausgeführt.",
"loc.releaseNotes": "Neuigkeiten in Version 1.0:\n– Unterstützung der neuen Python-basierten Azure CLI 2.0\n– Funktioniert mit plattformübergreifenden Agents (Linux, macOS oder Windows)\n– Die Verwendung mit Azure CLI 1.0 (node.js-basiert) erfordert einen Wechsel zu Aufgabenversion 0.0\n– Einschränkungen:\n– Keine Unterstützung für klassische Azure-Abonnements. Azure CLI 2.0 unterstützt nur Azure Resource Manager-Abonnements (ARM).",
"loc.input.help.scriptLocation": "Skripttyp: Dateipfad oder Inlineskript",
12
+
"loc.input.label.scriptPath": "Skriptpfad",
13
+
"loc.input.help.scriptPath": "Vollqualifizierter Pfad des Skripts (BAT oder CMD bei Verwendung des Windows-basierten Agents, SH bei Verwendung eines Linux-basierten Agents) oder ein Pfad relativ zum Standardarbeitsverzeichnis",
14
+
"loc.input.label.inlineScript": "Inlineskript",
15
+
"loc.input.help.inlineScript": "Sie können Ihre Skripts hier inline einfügen. Bei Verwendung eines Windows-Agents verwenden Sie ein Batchskript, bei Verwendung eines Linux-basierten Agents ein Shellskript. Verwenden Sie für Batchskripts das Präfix \"call\" vor jedem Azure-Befehl. Sie können außerdem mithilfe von Argumenten vordefinierte und benutzerdefinierte Variablen an das Skript übergeben. \n\n Beispiel für Shell: \naz --version \naz account show \n\n Beispiel für Batch:\ncall az --version \ncall az account show",
16
+
"loc.input.label.args": "Argumente",
17
+
"loc.input.help.args": "An das Skript übergebenen Argumente",
18
+
"loc.input.label.addSpnToEnvironment": "Auf Dienstprinzipaldetails im Skript zugreifen",
19
+
"loc.input.help.addSpnToEnvironment": "Hiermit werden ID und Schlüssel des Dienstprinzipals für den ausgewählten Azure-Endpunkt zur Ausführungsumgebung des Skripts hinzugefügt. Sie können in Ihrem Skript diese Variablen verwenden: \"$servicePrincipalId\", \"$servicePrincipalKey\" und \"`$tenantId\".\n\nEine Berücksichtigung erfolgt nur, wenn der Azure-Endpunkt das Dienstprinzipal-Authentifizierungsschema aufweist.",
"loc.input.help.useGlobalConfig": "Bei Festlegung auf FALSE verwendet diese Aufgabe ein eigenes, separates [Azure CLI-Konfigurationsverzeichnis](https://docs.microsoft.com/de-de/cli/azure/azure-cli-configuration?view=azure-cli-latest#cli-configuration-file). Dieses Verzeichnis kann zum Ausführen von Azure CLI-Aufgaben in *parallelen* Releases verwendet werden.",
22
+
"loc.input.label.cwd": "Arbeitsverzeichnis",
23
+
"loc.input.help.cwd": "Das aktuelle Arbeitsverzeichnis, in dem das Skript ausgeführt wird. Wenn keine Angabe erfolgt, wird der Stamm des Repositorys (Build) oder der Artefakte (Release) verwendet, das \"$(System.DefaultWorkingDirectory)\" lautet.",
24
+
"loc.input.label.failOnStandardError": "Fehler bei Standardfehler.",
25
+
"loc.input.help.failOnStandardError": "Bei aktivierter Option kann diese Aufgabe nicht erfolgreich ausgeführt werden, wenn Fehler in den StandardError-Stream geschrieben werden. Deaktivieren Sie das Kontrollkästchen, um Standardfehler zu ignorieren, und bestimmen Sie den Status mithilfe von Exitcodes.",
26
+
"loc.messages.ScriptReturnCode": "Skript wurde mit Rückgabecode beendet: %d",
27
+
"loc.messages.ScriptFailed": "Skriptfehler: %s",
28
+
"loc.messages.UnsupportedEndpointScheme": "Nicht unterstütztes Authentifizierungsschema für Dienstverbindung: Dienstprinzipal für AzureRM",
29
+
"loc.messages.AzureSDKNotFound": "Azure CLI 2.x ist nicht auf diesem Computer installiert.",
30
+
"loc.messages.FailedToLogout": "Beim Abmelden ist der folgende Fehler aufgetreten: %s",
31
+
"loc.messages.LoginFailed": "Fehler bei der Azure-Anmeldung.",
32
+
"loc.messages.MSILoginFailed": "Fehler bei der Azure-Anmeldung mit einer verwalteten Dienstidentität.",
33
+
"loc.messages.AuthSchemeNotSupported": "Das Authentifizierungsschema \"%s\" wird nicht unterstützt.",
34
+
"loc.messages.ErrorInSettingUpSubscription": "Fehler beim Festlegen des Abonnements.",
35
+
"loc.messages.SettingAzureConfigDir": "AZURE_CONFIG_DIR-Umgebungsvariable wird festgelegt auf: %s",
36
+
"loc.messages.SettingAzureCloud": "Aktive Cloud wird festgelegt auf: %s",
37
+
"loc.messages.GlobalCliConfigAgentVersionWarning": "Für Agent-Versionen vor 2.115.0 kann nur die globale Azure CLI-Konfiguration verwendet werden."
"loc.helpMarkDown": "[Learn more about this task](http://go.microsoft.com/fwlink/?LinkID=827160) or [see the Azure CLI documentation](https://docs.microsoft.com/cli/azure/)",
4
+
"loc.description": "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.",
"loc.releaseNotes": "What's new in Version 1.0:\n- Supports the new Azure CLI 2.0 which is Python based\n- Works with cross-platform agents (Linux, macOS, or Windows)\n- For working with Azure CLI 1.0 (node.js-based), switch to task version 0.0\n- Limitations:\n - No support for Azure Classic subscriptions. Azure CLI 2.0 supports only Azure Resource Manager (ARM) subscriptions.",
"loc.input.help.scriptLocation": "Type of script: File path or Inline script",
12
+
"loc.input.label.scriptPath": "Script Path",
13
+
"loc.input.help.scriptPath": "Fully qualified path of the script(.bat or .cmd when using Windows based agent and .sh when using linux based agent) or a path relative to the the default working directory",
14
+
"loc.input.label.inlineScript": "Inline Script",
15
+
"loc.input.help.inlineScript": "You can write your scripts inline here. When using Windows agent, use batch scripting whereas use shell scripting when using Linux based agents. For batch script use the prefix \"call\" before every azure command. You can also pass predefined and custom variables to this script using arguments \n\n example for shell: \naz --version \naz account show \n\n example for batch:\ncall az --version \ncall az account show",
16
+
"loc.input.label.args": "Arguments",
17
+
"loc.input.help.args": "Arguments passed to the script",
18
+
"loc.input.label.addSpnToEnvironment": "Access service principal details in script",
19
+
"loc.input.help.addSpnToEnvironment": "Adds service principal id and key of the Azure endpoint you chose to the script's execution environment. You can use these variables: `$servicePrincipalId`, `$servicePrincipalKey` and `$tenantId` in your script.\n\nThis is honored only when the Azure endpoint has Service Principal authentication scheme.",
20
+
"loc.input.label.useGlobalConfig": "Use global Azure CLI configuration",
21
+
"loc.input.help.useGlobalConfig": "If this is false, this task will use its own separate [Azure CLI configuration directory](https://docs.microsoft.com/en-us/cli/azure/azure-cli-configuration?view=azure-cli-latest#cli-configuration-file). This can be used to run Azure CLI tasks in *parallel* releases",
22
+
"loc.input.label.cwd": "Working Directory",
23
+
"loc.input.help.cwd": "Current working directory where the script is run. Empty is the root of the repo (build) or artifacts (release), which is $(System.DefaultWorkingDirectory)",
24
+
"loc.input.label.failOnStandardError": "Fail on Standard Error",
25
+
"loc.input.help.failOnStandardError": "If this is true, this task will fail when any errors are written to the StandardError stream. Unselect the checkbox to ignore standard errors and rely on exit codes to determine the status",
26
+
"loc.messages.ScriptReturnCode": "Script exited with return code: %d",
27
+
"loc.messages.ScriptFailed": "Script failed with error: %s",
28
+
"loc.messages.UnsupportedEndpointScheme": "Unsupported service connection authorization scheme: Service Principal for AzureRM",
29
+
"loc.messages.AzureSDKNotFound": "Azure CLI 2.x is not installed on this machine.",
30
+
"loc.messages.FailedToLogout": "The following error occurred while logging out: %s",
31
+
"loc.messages.LoginFailed": "Azure login failed",
32
+
"loc.messages.MSILoginFailed": "Azure login failed using Managed Service Identity",
33
+
"loc.messages.AuthSchemeNotSupported": "Auth Scheme %s is not supported",
34
+
"loc.messages.ErrorInSettingUpSubscription": "Error in setting up subscription",
35
+
"loc.messages.SettingAzureConfigDir": "Setting AZURE_CONFIG_DIR env variable to: %s",
36
+
"loc.messages.SettingAzureCloud": "Setting active cloud to: %s",
37
+
"loc.messages.GlobalCliConfigAgentVersionWarning": "For agent version < 2.115.0, only global Azure CLI configuration can be used"
0 commit comments