AzurePowerShell@3 – Azure PowerShell v3-Aufgabe

Verwenden Sie diese Aufgabe, um ein PowerShell-Skript in einer Azure-Umgebung auszuführen. Der Azure-Kontext wird mit der bereitgestellten Azure Resource Manager-Dienstverbindung authentifiziert.

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.

Eingaben

azureConnectionType - Azure-Verbindungstyp
Eingabealias: ConnectedServiceNameSelector. string. Zulässige Werte: ConnectedServiceName (klassische Azure), ConnectedServiceNameARM (Azure Resource Manager). Standardwert. ConnectedServiceNameARM.

azureClassicSubscription - Klassisches Azure-Abonnement
Eingabealias: ConnectedServiceName. string. Erforderlich, wenn ConnectedServiceNameSelector = ConnectedServiceName.

Das klassische Azure-Abonnement, das vor der Ausführung von PowerShell konfiguriert werden soll.

azureSubscription - Azure-Abonnement
Eingabealias: ConnectedServiceNameARM. string. Erforderlich, wenn ConnectedServiceNameSelector = ConnectedServiceNameARM.

Das Azure Resource Manager Abonnement, das vor der Ausführung von PowerShell konfiguriert werden soll.

ScriptType - Skripttyp
string. Zulässige Werte: FilePath (Skriptdateipfad), InlineScript (Inlineskript). Standardwert. FilePath.

Der Typ des Skripts: Dateipfad oder Inline.

ScriptPath - Skriptpfad
string. Optional. Verwenden Sie , wenn ScriptType = FilePath.

Der Pfad des Skripts. Hierbei sollte es sich um einen vollqualifizierten Pfad oder einen pfad relativ zum Standardarbeitsverzeichnis handeln.

Inline - Inlineskript
string. Optional. Verwenden Sie , wenn ScriptType = InlineScript. Standardwert. # You can write your azure powershell scripts inline here. \n# You can also pass predefined and custom variables to this script using arguments.

Gibt das auszuführende Skript an. Die maximale unterstützte Inlineskriptlänge beträgt 5.000 Zeichen. Verwenden Sie ein Skript aus einer Datei, wenn Sie ein längeres Skript verwenden möchten.

ScriptArguments - Skriptargumente
string. Optional. Verwenden Sie , wenn ScriptType = FilePath.

Die zusätzlichen Parameter, die an PowerShell übergeben werden sollen. Dies können ordinale oder benannte Parameter sein.

errorActionPreference - ErrorActionPreference
string. Zulässige Werte: stop, continue und silentlyContinue. Standardwert. stop.

Wählt den Wert der Variablen für die ErrorActionPreference Ausführung des Skripts aus.

FailOnStandardError - Fehler beim Standardfehler
boolean. Standardwert. false.

Wenn dies wahr ist, tritt bei dieser Aufgabe ein Fehler auf, wenn Fehler in die Fehlerpipeline geschrieben werden oder wenn Daten in den Standardfehlerstream geschrieben werden.

azurePowerShellVersion - Azure PowerShell Version
Eingabealias: TargetAzurePs. string. Zulässige Werte: LatestVersion (Neueste installierte Version), OtherVersion (Andere Version angeben). Standardwert. OtherVersion.

Bei gehosteten Agents werden 2.1.0die Azure PowerShell Versionen unterstützt, 3.8.0, 4.2.1und 5.1.16.7.0. Um die neueste Version auszuwählen, die für den Agent verfügbar ist, wählen Sie (Neueste installierte Version) aus LatestVersion .

Für private Agents können Sie eine bevorzugte Version von Azure PowerShell mit OtherVersion angeben (Andere Version angeben).

preferredAzurePowerShellVersion - Bevorzugte Azure PowerShell Version
Eingabealias: CustomTargetAzurePs. string. Erforderlich, wenn TargetAzurePs = OtherVersion.

Die bevorzugte Azure PowerShell Version muss eine richtige semantische Version sein, z. B. 1.2.3.. Regex like 2.\*,2.3.\* wird nicht unterstützt. Gehostete Agents unterstützen derzeit Azure-Modulversionen , , , und AzureRM-Modulversionen 2.1.0, 3.8.0, 4.2.1, 6.7.05.1.1. 5.1.14.2.13.8.02.1.0

validateScriptSignature - Überprüfen der Skriptsignatur
boolean. Optional. Verwenden Sie , wenn ScriptType = FilePath. Standardwert. false.

Wenn dies wahr ist, überprüft der Task zuerst, ob das angegebene Skript signiert und gültig ist, bevor es ausgeführt wird.

Optionen für die Vorgangskontrolle

Alle Vorgänge verfügen zusätzlich zu ihren Eingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerungsoptionen und allgemeine Aufgabeneigenschaften.

Ausgabevariablen

Keine.

Hinweise

Unterstützung für Fail on Standard Error und ErrorActionPreference hinzugefügt.

Anforderungen

Anforderung	BESCHREIBUNG
Pipelinetypen	YAML, Klassischer Build, klassische Version
Wird ausgeführt auf	Agent, DeploymentGroup
Forderungen	Selbstgehostete Agents müssen über Funktionen verfügen, die den folgenden Anforderungen entsprechen , um Aufträge auszuführen, die diese Aufgabe verwenden: azureps
Capabilities	Diese Aufgabe erfüllt keine Anforderungen an nachfolgende Aufgaben im Auftrag.
Befehlseinschränkungen	Any
Einstellbare Variablen	Any
Agent-Version	2.0.0 oder höher
Aufgabenkategorie	Bereitstellen