AzurePowerShell@2 - Azure PowerShell v2 task

Use this task to run a PowerShell script within an Azure environment. The Azure context is authenticated with the provided Azure Resource Manager service connection.

This version of the task is deprecated; use AzurePowerShell@5.

Syntax

# Azure PowerShell v2
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@2
  inputs:
    #azureConnectionType: 'ConnectedServiceNameARM' # 'ConnectedServiceName' | 'ConnectedServiceNameARM'. Alias: ConnectedServiceNameSelector. Azure Connection Type. Default: ConnectedServiceNameARM.
    #azureClassicSubscription: # string. Alias: ConnectedServiceName. Required when ConnectedServiceNameSelector = ConnectedServiceName. Azure Classic Subscription. 
    azureSubscription: # string. Alias: ConnectedServiceNameARM. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM. Azure Subscription. 
    ScriptType: 'FilePath' # 'FilePath' | 'InlineScript'. Required. Script Type. Default: FilePath.
    #ScriptPath: # string. Optional. Use when ScriptType = FilePath. Script Path. 
    #Inline: # string. Optional. Use when ScriptType = InlineScript. Inline Script. 
    #ScriptArguments: # string. Script Arguments. 
    #azurePowerShellVersion: 'OtherVersion' # 'LatestVersion' | 'OtherVersion'. Alias: TargetAzurePs. Azure PowerShell Version. Default: OtherVersion.
    preferredAzurePowerShellVersion: # string. Alias: CustomTargetAzurePs. Required when TargetAzurePs = OtherVersion. Preferred Azure PowerShell Version.

Inputs

azureConnectionType - Azure Connection Type
Input alias: ConnectedServiceNameSelector. string. Allowed values: ConnectedServiceName (Azure Classic), ConnectedServiceNameARM (Azure Resource Manager). Default value: ConnectedServiceNameARM.

azureClassicSubscription - Azure Classic Subscription
Input alias: ConnectedServiceName. string. Required when ConnectedServiceNameSelector = ConnectedServiceName.

The Azure Classic subscription to configure before running PowerShell.

azureSubscription - Azure Subscription
Input alias: ConnectedServiceNameARM. string. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM.

The Azure Resource Manager subscription to configure before running PowerShell.

ScriptType - Script Type
string. Required. Allowed values: FilePath (Script File Path), InlineScript (Inline Script). Default value: FilePath.

The type of script: file path or inline.

ScriptPath - Script Path
string. Optional. Use when ScriptType = FilePath.

The path of the script. This should be a fully qualified path or one relative to the default working directory.

Inline - Inline Script
string. Optional. Use when ScriptType = InlineScript. Default value: # You can write your azure powershell scripts inline here. \n# You can also pass predefined and custom variables to this script using arguments.

Specifes the script to execute. The maximum supported inline script length is 5000 characters. Use a script from a file if you want to use a longer script.

ScriptArguments - Script Arguments
string.

The additional parameters to pass to PowerShell. These can be either ordinal or named parameters.

azurePowerShellVersion - Azure PowerShell Version
Input alias: TargetAzurePs. string. Allowed values: LatestVersion (Latest installed version), OtherVersion (Specify other version). Default value: OtherVersion.

In case of hosted agents, the supported Azure PowerShell Versions are 2.1.0, 3.8.0, 4.2.1, 5.1.1 and 6.7.0. To pick the latest version available on the agent, select LatestVersion (Latest installed version).

For private agents you can specify a preferred version of Azure PowerShell using OtherVersion (Specify other version).

preferredAzurePowerShellVersion - Preferred Azure PowerShell Version
Input alias: CustomTargetAzurePs. string. Required when TargetAzurePs = OtherVersion.

The preferred Azure PowerShell Version needs to be a proper semantic version eg. 1.2.3.. Regex like 2.\*,2.3.\* is not supported. Hosted agents currently supports Azure module versions 2.1.0, 3.8.0, 4.2.1, 5.1.1 and AzureRM module versions 2.1.0, 3.8.0, 4.2.1, 5.1.1, 6.7.0.

Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

None.

Requirements

Requirement	Description
Pipeline types	YAML, Classic build, Classic release
Runs on	Agent, DeploymentGroup
Demands	Self-hosted agents must have capabilities that match the following demands to run jobs that use this task: azureps
Capabilities	This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions	Any
Settable variables	Any
Agent version	1.95.0 or greater
Task category	Deploy