AzurePowerShell@3 - Azure PowerShell v3-taak
Gebruik deze taak om een PowerShell-script uit te voeren in een Azure-omgeving. De Azure-context wordt geverifieerd met de opgegeven Azure Resource Manager serviceverbinding.
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.
Invoerwaarden
azureConnectionType
- Azure-verbindingstype
Invoeralias: ConnectedServiceNameSelector
. string
. Toegestane waarden: ConnectedServiceName
(Klassiek van Azure), ConnectedServiceNameARM
(Azure Resource Manager). Standaardwaarde: ConnectedServiceNameARM
.
azureClassicSubscription
- Klassiek Azure-abonnement
Invoeralias: ConnectedServiceName
. string
. Vereist wanneer ConnectedServiceNameSelector = ConnectedServiceName
.
Het klassieke Azure-abonnement dat moet worden geconfigureerd voordat u PowerShell uitvoert.
azureSubscription
- Azure-abonnement
Invoeralias: ConnectedServiceNameARM
. string
. Vereist wanneer ConnectedServiceNameSelector = ConnectedServiceNameARM
.
Het Azure Resource Manager-abonnement dat moet worden geconfigureerd voordat u PowerShell uitvoert.
ScriptType
- Scripttype
string
. Toegestane waarden: FilePath
(Pad scriptbestand), InlineScript
(inlinescript). Standaardwaarde: FilePath
.
Het type script: bestandspad of inline.
ScriptPath
- Scriptpad
string
. Optioneel. Gebruik wanneer ScriptType = FilePath
.
Het pad van het script. Dit moet een volledig gekwalificeerd pad zijn of een ten opzichte van de standaardwerkmap.
Inline
- Inlinescript
string
. Optioneel. Gebruik wanneer ScriptType = InlineScript
. Standaardwaarde: # You can write your azure powershell scripts inline here. \n# You can also pass predefined and custom variables to this script using arguments
.
Hiermee wordt het script opgegeven dat moet worden uitgevoerd. De maximaal ondersteunde inlinescriptlengte is 5000 tekens. Gebruik een script uit een bestand als u een langer script wilt gebruiken.
ScriptArguments
- Scriptargumenten
string
. Optioneel. Gebruik wanneer ScriptType = FilePath
.
De aanvullende parameters die moeten worden doorgegeven aan PowerShell. Dit kunnen ordinale of benoemde parameters zijn.
errorActionPreference
- ErrorActionPreference
string
. Toegestane waarden: stop
, continue
, silentlyContinue
. Standaardwaarde: stop
.
Selecteert de waarde van de ErrorActionPreference
variabele voor het uitvoeren van het script.
FailOnStandardError
- Fout bij standaardfout
boolean
. Standaardwaarde: false
.
Wanneer dit waar is, mislukt deze taak als er fouten naar de foutpijplijn worden geschreven of als er gegevens naar de standaardfoutstroom worden geschreven.
azurePowerShellVersion
- Azure PowerShell versie
Invoeralias: TargetAzurePs
. string
. Toegestane waarden: LatestVersion
(Laatst geïnstalleerde versie), OtherVersion
(Geef een andere versie op). Standaardwaarde: OtherVersion
.
In het geval van gehoste agents zijn 2.1.0
de ondersteunde Azure PowerShell versies , 3.8.0
, 4.2.1
5.1.1
en 6.7.0
.
Als u de meest recente versie wilt kiezen die beschikbaar is op de agent, selecteert u LatestVersion
(Laatst geïnstalleerde versie).
Voor privéagenten kunt u een voorkeursversie van Azure PowerShell opgeven met (OtherVersion
Geef een andere versie op).
preferredAzurePowerShellVersion
- Voorkeursversie Azure PowerShell
Invoeralias: CustomTargetAzurePs
. string
. Vereist wanneer TargetAzurePs = OtherVersion
.
De voorkeursversie Azure PowerShell versie moet een juiste semantische versie zijn, bijvoorbeeld. 1.2.3.
. Regex like 2.\*,2.3.\*
wordt niet ondersteund. Gehoste agents ondersteunen momenteel Azure-moduleversies 2.1.0
, 3.8.0
, , 5.1.1
4.2.1
en AzureRM-moduleversies 2.1.0
, 3.8.0
, 4.2.1
5.1.1
, . 6.7.0
validateScriptSignature
- Scripthandtekening valideren
boolean
. Optioneel. Gebruik wanneer ScriptType = FilePath
. Standaardwaarde: false
.
Als dit waar is, controleert de taak eerst of het opgegeven script is ondertekend en geldig is voordat het wordt uitgevoerd.
Opties voor taakbeheer
Alle taken hebben besturingsopties naast hun taakinvoer. Zie Opties voor besturingselementen en algemene taakeigenschappen voor meer informatie.
Uitvoervariabelen
Geen.
Opmerkingen
Ondersteuning toegevoegd voor Fail on Standard Error en ErrorActionPreference.
Vereisten
Vereiste | Beschrijving |
---|---|
Pijplijntypen | YAML, klassieke build, klassieke release |
Wordt uitgevoerd op | Agent, DeploymentGroup |
Eisen | Zelf-hostende agents moeten mogelijkheden hebben die voldoen aan de volgende vereisten om taken uit te voeren die deze taak gebruiken: azureps |
Functies | Deze taak voldoet niet aan eventuele vereisten voor volgende taken in de taak. |
Opdrachtbeperkingen | Alle |
Instelbare variabelen | Alle |
Agentversie | 2.0.0 of hoger |
Taakcategorie | Implementeren |