AzurePowerShell@4 - Azure PowerShell v4 工作

使用此工作在 Azure 環境中執行 PowerShell 腳本。 Azure 內容會使用提供的 Azure Resource Manager 服務連線進行驗證。

語法

# 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.

輸入

azureSubscription - Azure 訂用帳戶
輸入別名：ConnectedServiceNameARM。 string。 必須的。

執行 PowerShell 之前要設定的 Azure Resource Manager 訂用帳戶。

ScriptType - 文稿類型
string。 允許的值：FilePath（腳本檔案路徑）、InlineScript（內嵌腳本）。 預設值：FilePath。

腳本的類型：檔案路徑或內嵌。

ScriptPath - 文稿路徑
string。 選擇性。 ScriptType = FilePath時使用 。

腳本的路徑。 這應該是完整路徑或相對於預設工作目錄的路徑。

Inline - 內嵌腳本
string。 選擇性。 ScriptType = InlineScript時使用 。 預設值：# You can write your azure powershell scripts inline here. \n# You can also pass predefined and custom variables to this script using arguments。

指定要執行的文稿。 支援的內嵌腳本長度上限為 5000 個字元。 如果您想要使用較長的腳稿，請使用檔案中的腳本。

ScriptArguments - 腳本自變數
string。 選擇性。 ScriptType = FilePath時使用 。

要傳遞至 PowerShell 的其他參數。 可以是序數或具名參數。

errorActionPreference - ErrorActionPreference
string。 允許的值：stop、continue、silentlyContinue。 預設值：stop。

選取 ErrorActionPreference 變數的值來執行腳本。

標準錯誤FailOnStandardError - 失敗
boolean。 預設值：false。

如果有任何錯誤寫入錯誤管線，或將任何數據寫入標準錯誤數據流，則此工作將會失敗。

RestrictContextToCurrentTask - 將內容範圍限制為目前的工作
boolean。 預設值：false。

當此為 true 時，此工作只會將內容範圍限製為目前的工作，而且使用私人代理程式時，管線中的其他工作將無法使用內容。

azurePowerShellVersion - Azure PowerShell 版本
輸入別名：TargetAzurePs。 string。 允許的值：LatestVersion（最新版本），OtherVersion（指定其他版本）。 預設值：OtherVersion。

如果裝載的代理程序，支援的 Azure PowerShell 版本為：1.0.0 （託管 VS2017 佇列）。 若要挑選代理程式上可用的最新版本，請選取 [LatestVersion [最新安裝的版本]。

針對私人代理程式，您可以使用 OtherVersion 來指定慣用版本的 Azure PowerShell（指定其他版本）。

preferredAzurePowerShellVersion - 慣用 Azure PowerShell 版本
輸入別名：CustomTargetAzurePs。 string。 TargetAzurePs = OtherVersion時為必要項。

慣用的 Azure PowerShell 版本必須是適當的語意版本，例如 不支援 1.2.3. Regex，例如 2.\*,2.3.\*。 裝載的 VS2017 集區目前支援 Az 模組版本 1.0.0.

pwsh - 使用 PowerShell Core
boolean。 預設值：false。

如果這是真的，則 Windows 上的工作會從您的路徑使用 pwsh.exe，而不是 powershell.exe。

validateScriptSignature - 驗證腳本簽章
boolean。 選擇性。 ScriptType = FilePath時使用 。 預設值：false。

如果這是 true，則工作會先檢查以確定指定的腳本已簽署且有效，再執行它。

workingDirectory - 工作目錄
string。

執行文稿的工作目錄。

工作控制選項

除了工作輸入之外，所有工作都有控制選項。 如需詳細資訊，請參閱 控制項選項和一般工作屬性。

輸出變數

沒有。

備註

已新增 Az Module 和跨平臺代理程序的支援。

需求

要求	說明
管線類型	YAML、傳統組建、傳統版本
執行於	Agent、DeploymentGroup
需求	沒有
功能	此工作不符合作業中後續工作的任何需求。
命令限制	任意
Settable 變數	任意
代理程式版本	2.115.0 或更新
工作類別	部署