AzurePowerShell@3 - tâche Azure PowerShell v3
Utilisez cette tâche pour exécuter un script PowerShell dans un environnement Azure. Le contexte Azure est authentifié avec la connexion de service Azure Resource Manager fournie.
Syntax
# Azure PowerShell v3
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@3
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'. Script Type. Default: FilePath.
#ScriptPath: # string. Optional. Use when ScriptType = FilePath. Script Path.
#Inline: # string. Optional. Use when ScriptType = InlineScript. Inline Script.
#ScriptArguments: # string. Optional. Use when ScriptType = FilePath. Script Arguments.
#errorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. ErrorActionPreference. Default: stop.
#FailOnStandardError: false # boolean. Fail on Standard Error. Default: false.
# Azure PowerShell version options
#azurePowerShellVersion: 'OtherVersion' # 'LatestVersion' | 'OtherVersion'. Alias: TargetAzurePs. Azure PowerShell Version. Default: OtherVersion.
preferredAzurePowerShellVersion: # string. Alias: CustomTargetAzurePs. Required when TargetAzurePs = OtherVersion. Preferred Azure PowerShell Version.
# Advanced
#validateScriptSignature: false # boolean. Optional. Use when ScriptType = FilePath. Validate script signature. Default: false.
# Azure PowerShell v3
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@3
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'. Script Type. Default: FilePath.
#ScriptPath: # string. Optional. Use when ScriptType = FilePath. Script Path.
#Inline: # string. Optional. Use when ScriptType = InlineScript. Inline Script.
#ScriptArguments: # string. Optional. Use when ScriptType = FilePath. Script Arguments.
#errorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. ErrorActionPreference. Default: stop.
#FailOnStandardError: false # boolean. Fail on Standard Error. Default: false.
# Azure PowerShell version options
#azurePowerShellVersion: 'OtherVersion' # 'LatestVersion' | 'OtherVersion'. Alias: TargetAzurePs. Azure PowerShell Version. Default: OtherVersion.
preferredAzurePowerShellVersion: # string. Alias: CustomTargetAzurePs. Required when TargetAzurePs = OtherVersion. Preferred Azure PowerShell Version.
Entrées
azureConnectionType
- Type de connexion Azure
Alias d’entrée : ConnectedServiceNameSelector
. string
. Valeurs autorisées : ConnectedServiceName
(Azure Classic), ConnectedServiceNameARM
(Azure Resource Manager). Valeur par défaut : ConnectedServiceNameARM
.
azureClassicSubscription
- Abonnement Azure Classic
Alias d’entrée : ConnectedServiceName
. string
. Nécessaire lorsque ConnectedServiceNameSelector = ConnectedServiceName
.
Abonnement Azure Classic à configurer avant d’exécuter PowerShell.
azureSubscription
- Abonnement Azure
Alias d’entrée : ConnectedServiceNameARM
. string
. Nécessaire lorsque ConnectedServiceNameSelector = ConnectedServiceNameARM
.
L’abonnement Azure Resource Manager à configurer avant d’exécuter PowerShell.
ScriptType
- Script Type
string
. Valeurs autorisées : FilePath
(Chemin du fichier de script), InlineScript
(script inline). Valeur par défaut : FilePath
.
Type du script : chemin d’accès au fichier ou inline.
ScriptPath
- Chemin du script
string
. facultatif. Utilisez quand ScriptType = FilePath
.
Chemin d’accès du script. Il doit s’agir d’un chemin d’accès complet ou d’un chemin d’accès par rapport au répertoire de travail par défaut.
Inline
- Inline Script
string
. facultatif. Utilisez quand ScriptType = InlineScript
. Valeur par défaut : # You can write your azure powershell scripts inline here. \n# You can also pass predefined and custom variables to this script using arguments
.
Spécifie le script à exécuter. La longueur maximale du script inline prise en charge est de 5 000 caractères. Utilisez un script à partir d’un fichier si vous souhaitez utiliser un script plus long.
ScriptArguments
- Script Arguments
string
. facultatif. Utilisez quand ScriptType = FilePath
.
Paramètres supplémentaires à passer à PowerShell. Il peut s’agir de paramètres ordinaux ou nommés.
errorActionPreference
- ErrorActionPreference
string
. Valeurs autorisées : stop
, continue
, silentlyContinue
. Valeur par défaut : stop
.
Sélectionne la valeur de la ErrorActionPreference
variable pour l’exécution du script.
FailOnStandardError
- Échec en cas d’erreur standard
boolean
. Valeur par défaut : false
.
Lorsque cela est vrai, cette tâche échoue si des erreurs sont écrites dans le pipeline d’erreur ou si des données sont écrites dans le flux d’erreurs standard.
azurePowerShellVersion
- version Azure PowerShell
Alias d’entrée : TargetAzurePs
. string
. Valeurs autorisées : LatestVersion
(Dernière version installée), OtherVersion
(Spécifier une autre version). Valeur par défaut : OtherVersion
.
Dans le cas d’agents hébergés, les versions Azure PowerShell prises en charge sont 2.1.0
, 3.8.0
, 4.2.1
et 5.1.1
6.7.0
.
Pour sélectionner la dernière version disponible sur l’agent, sélectionnez LatestVersion
(Dernière version installée).
Pour les agents privés, vous pouvez spécifier une version par défaut de Azure PowerShell à l’aide OtherVersion
de (Spécifier une autre version).
preferredAzurePowerShellVersion
- Version Azure PowerShell préférée
Alias d’entrée : CustomTargetAzurePs
. string
. Nécessaire lorsque TargetAzurePs = OtherVersion
.
La version Azure PowerShell préférée doit être une version sémantique appropriée, par exemple. 1.2.3.
. Regex like 2.\*,2.3.\*
n’est pas pris en charge. Les agents hébergés prennent actuellement en charge les versions 2.1.0
de module Azure , 3.8.0
, 4.2.1
et les 5.1.1
versions 2.1.0
de module AzureRM , 3.8.0
, , 4.2.1
5.1.1
, 6.7.0
.
validateScriptSignature
- Valider la signature de script
boolean
. facultatif. Utilisez quand ScriptType = FilePath
. Valeur par défaut : false
.
Si cette valeur est true, la tâche case activée d’abord pour s’assurer que le script spécifié est signé et valide avant de l’exécuter.
Options de contrôle de la tâche
Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.
Variables de sortie
Aucun.
Notes
Ajout de la prise en charge de Fail on standard error et ErrorActionPreference.
Configuration requise
Condition requise | Description |
---|---|
Types de pipelines | YAML, build classique, version classique |
S’exécute sur | Agent, DeploymentGroup |
Demandes | Les agents auto-hébergés doivent avoir des fonctionnalités qui correspondent aux exigences suivantes pour exécuter des travaux qui utilisent cette tâche : azureps |
Capabilities | Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail. |
Restrictions de commandes | Quelconque |
Variables settables | Quelconque |
Version de l’agent | 2.0.0 ou supérieur |
Catégorie de la tâche | Déployer |