Dela via


AzurePowerShell@4 – Azure PowerShell v4-uppgift

Använd den här uppgiften för att köra ett PowerShell-skript i en Azure-miljö. Azure-kontexten autentiseras med den tillhandahållna Azure Resource Manager-tjänstanslutningen.

Syntax

# Azure PowerShell v4
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@4
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. 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.
    #RestrictContextToCurrentTask: false # boolean. Restrict scope of context to current task. 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
    #pwsh: false # boolean. Use PowerShell Core. Default: false.
    #validateScriptSignature: false # boolean. Optional. Use when ScriptType = FilePath. Validate script signature. Default: false.
    #workingDirectory: # string. Working Directory.
# Azure PowerShell v4
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@4
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. 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.
    #RestrictContextToCurrentTask: false # boolean. Restrict scope of context to current task. 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
    #pwsh: false # boolean. Use PowerShell Core. Default: false.
    #workingDirectory: # string. Working Directory.
# Azure PowerShell v4
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@4
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. 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
    #pwsh: false # boolean. Use PowerShell Core. Default: false.
    #workingDirectory: # string. Working Directory.
# Azure PowerShell v4
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@4
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. 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.

Indata

azureSubscription - Azure-prenumeration
Indataalias: ConnectedServiceNameARM. string. Krävs.

Azure Resource Manager-prenumeration som ska konfigureras innan du kör PowerShell.


ScriptType - Skripttyp
string. Tillåtna värden: FilePath (Skriptfilsökväg), InlineScript (infogat skript). Standardvärde: FilePath.

Typ av skript: filsökväg eller infogad.


ScriptPath - Skriptsökväg
string. Valfritt. Använd när ScriptType = FilePath.

Sökvägen till skriptet. Detta bör vara en fullständigt kvalificerad sökväg eller en i förhållande till standardarbetskatalogen.


Inline - Infogat skript
string. Valfritt. Använd när ScriptType = InlineScript. Standardvärde: # You can write your azure powershell scripts inline here. \n# You can also pass predefined and custom variables to this script using arguments.

Anger vilket skript som ska köras. Den maximala längden för infogade skript som stöds är 5 000 tecken. Använd ett skript från en fil om du vill använda ett längre skript.


ScriptArguments - Skriptargument
string. Valfritt. Använd när ScriptType = FilePath.

De ytterligare parametrar som ska skickas till PowerShell. Kan vara antingen ordningstal eller namngivna parametrar.


errorActionPreference - ErrorActionPreference
string. Tillåtna värden: stop, continue, silentlyContinue. Standardvärde: stop.

Väljer värdet för variabeln ErrorActionPreference för körning av skriptet.


FailOnStandardError - Fel vid standardfel
boolean. Standardvärde: false.

När detta är sant misslyckas den här uppgiften om några fel skrivs till felpipelinen eller om några data skrivs till standardfelströmmen.


RestrictContextToCurrentTask - Begränsa kontextomfånget till aktuell aktivitet
boolean. Standardvärde: false.

När detta är sant begränsar den här aktiviteten kontextomfånget endast till den aktuella aktiviteten och kontexten är inte tillgänglig för andra aktiviteter i pipelinen när du använder en privat agent.


azurePowerShellVersion - Azure PowerShell version
Indataalias: TargetAzurePs. string. Tillåtna värden: LatestVersion (senaste installerade versionen) OtherVersion (Ange annan version). Standardvärde: OtherVersion.

När det gäller värdbaserade agenter är den Azure PowerShell version som stöds: 1.0.0 (Värdbaserad VS2017-kö). Välj den senaste versionen som är tillgänglig i agenten genom att välja LatestVersion (Senaste installerade versionen).

För privata agenter kan du ange en önskad version av Azure PowerShell med (OtherVersionAnge annan version).


preferredAzurePowerShellVersion - Önskad Azure PowerShell version
Indataalias: CustomTargetAzurePs. string. Krävs när TargetAzurePs = OtherVersion.

Den föredragna Azure PowerShell version måste vara en korrekt semantisk version t.ex. 1.2.3. Regex liknande 2.\*,2.3.\* stöds inte. Den värdbaserade VS2017-poolen stöder för närvarande Az-modulversionen 1.0.0.


pwsh - Använda PowerShell Core
boolean. Standardvärde: false.

Om detta är sant används pwsh.exe aktiviteten i Windows från sökvägen i stället för powershell.exe.


validateScriptSignature - Verifiera skriptsignatur
boolean. Valfritt. Använd när ScriptType = FilePath. Standardvärde: false.

Om detta är sant kontrollerar aktiviteten först att det angivna skriptet är signerat och giltigt innan det körs.


workingDirectory - Arbetskatalog
string.

Arbetskatalogen där skriptet körs.


Kontrollalternativ för aktivitet

Alla aktiviteter har kontrollalternativ utöver sina aktivitetsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.

Utdatavariabler

Inga.

Kommentarer

Stöd har lagts till för Az Module och plattformsoberoende agenter.

Krav

Krav Beskrivning
Pipelinetyper YAML, klassisk version, klassisk version
Körs på Agent, DeploymentGroup
Krav Ingen
Funktioner Den här aktiviteten uppfyller inte några krav för efterföljande uppgifter i jobbet.
Kommandobegränsningar Valfri
Inställningsbara variabler Valfri
Agentversion 2.115.0 eller senare
Uppgiftskategori Distribuera