Freigeben über


AzurePowerShell@4 – Azure PowerShell v4-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 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.

Eingaben

azureSubscription - Azure-Abonnement
Eingabealias: ConnectedServiceNameARM. string. Erforderlich.

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. Dies sollte ein vollqualifizierter Pfad oder ein pfad relativ zum Standardarbeitsverzeichnis sein.


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 maximal 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. Kann entweder Ordinalparameter 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 zutrifft, schlägt diese Aufgabe fehl, wenn Fehler in die Fehlerpipeline geschrieben werden oder Wenn Daten in den Standardfehlerdatenstrom geschrieben werden.


RestrictContextToCurrentTask - Beschränken des Kontextbereichs auf die aktuelle Aufgabe
boolean. Standardwert. false.

Wenn dies zutrifft, beschränkt diese Aufgabe den Kontextbereich nur auf die aktuelle Aufgabe, und der Kontext ist für andere Aufgaben in der Pipeline bei Verwendung eines privaten Agents nicht verfügbar.


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

Bei gehosteten Agents wird die Azure PowerShell Version unterstützt: 1.0.0 (Gehostete VS2017-Warteschlange). Um die neueste auf dem Agent verfügbare Version auszuwählen, wählen Sie (Neueste installierte Version) aus LatestVersion .

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


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

Die bevorzugte Azure PowerShell Version muss eine geeignete semantische Version sein, z. B. 1.2.3. RegEx-Like 2.\*,2.3.\* wird nicht unterstützt. Der gehostete VS2017-Pool unterstützt derzeit die Az-Modulversion. 1.0.0.


pwsh - Verwenden von PowerShell Core
boolean. Standardwert. false.

Wenn dies zutrifft, verwendet pwsh.exe die Aufgabe unter Windows aus Ihrem Pfad anstelle von powershell.exe.


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

Wenn dies zutrifft, überprüft die Aufgabe zunächst, ob das angegebene Skript signiert und gültig ist, bevor es ausgeführt wird.


workingDirectory - Arbeitsverzeichnis
string.

Das Arbeitsverzeichnis, in dem das Skript 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 Az Module und plattformübergreifende Agents hinzugefügt.

Anforderungen

Anforderung BESCHREIBUNG
Pipelinetypen YAML, Klassischer Build, klassisches Release
Wird ausgeführt auf Agent, DeploymentGroup
Forderungen Keine
Capabilities Diese Aufgabe erfüllt keine Anforderungen an nachfolgende Aufgaben im Auftrag.
Befehlseinschränkungen Any
Setzbare Variablen Any
Agent-Version 2.115.0 oder höher
Aufgabenkategorie Bereitstellen