AzurePowerShell@5 - Azure PowerShell v5 工作

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

備註

根據預設，Azure PowerShell v5 會使用適用於 Linux 的 PowerShell Core 代理程式和 Windows PowerShell for Windows 代理程式。 若要在 Windows 代理程式上使用最新版本的 PowerShell，請將 pwsh 參數設定為 true。 接著會改用 PowerShell Core。

語法

# Azure PowerShell v5
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@5
  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.
    #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 訂用帳戶。

您可以使用範本表示式來指定服務連線輸入。 在下列範例中，azureSubscription 會使用格式字串和以 environmentName 變數為基礎的運算式來建立。

pool:
  vmImage: ubuntu-latest

variables:
  # Format string for the service connection
  azureSubscriptionFormat: 'connectionString-{0}-001'

stages:
- stage: Prepare
  variables:
    environmentName: 'test'
    # Stage level variable with the service connection name
    # Evaluates to conenctionString-test-001
    azureSubscription: ${{ format(variables.azureSubscriptionFormat, variables.environmentName) }}

  jobs:
  - job: RunStuff
    steps:
    - task: AzureCLI@2
      inputs:
        # Set this input to the computed value
        azureSubscription: ${{ variables.azureSubscription }}
        scriptType: bash
        scriptLocation: inlineScript
        inlineScript: 'echo Hello ${{ variables.azureSubscription }}'

    - task: AzurePowerShell@5
      inputs:
        # Set this input to the computed value
        azureSubscription: ${{ variables.azureSubscription }}
        azurePowerShellVersion: 'LatestVersion'
        scriptType: 'InlineScript'
        inline: Write-Host "Hello ${{ variables.azureSubscription }}"

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。

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

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

如果是裝載的代理程序，支援的 Azure PowerShell 版本會 1.0.0、1.6.0、2.3.2、2.6.0和 3.1.0（裝載 VS2017 佇列）。 若要挑選代理程式上可用的最新版本，請選取 [LatestVersion [最新安裝的版本]。

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

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

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

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

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

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

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

workingDirectory - 工作目錄
string。

執行文稿的工作目錄。

工作控制選項

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

輸出變數

沒有。

備註

故障排除

腳本在本機運作，但在管線中失敗

當管線中使用的服務連線沒有足夠的許可權執行腳本時，通常會發生這種情況。 在本機，腳本會以您的認證執行，而且可能會因為您擁有必要的存取權而成功。

若要解決此問題，請確定服務準則/驗證認證具有必要的權限。 如需詳細資訊，請參閱使用角色型存取控制來管理 Azure 訂用帳戶資源的存取。

錯誤： 找不到模組： '<模組名稱>' 版本： '<版本>'。 如果模組最近已安裝，請在重新啟動 Azure Pipelines 工作代理程式之後重試

Azure PowerShell 工作會使用 Azure/AzureRM/Az PowerShell 模組來與 Azure 訂用帳戶互動。 當裝載代理程式上無法使用PowerShell模組時，就會發生此問題。 因此，針對特定工作版本，慣用 Azure PowerShell 版本 必須在可用版本的清單中指定 Azure PowerShell 版本選項。 您可以在 Microsoft 裝載的代理程式的 Software 資料表中找到已安裝的軟體。

服務連線問題

若要針對與服務連線相關的問題進行疑難解答，請參閱 服務連線疑難解答。

範例

下列範例示範如何從檔案叫用腳本，並將腳本自變數傳遞給它。

- task: AzurePowerShell@5
  inputs:
    azureSubscription: my-arm-service-connection
    scriptType: filePath
    scriptPath: $(Build.SourcesDirectory)\myscript.ps1
    scriptArguments:
      -Arg1 val1 `
      -Arg2 val2 `
      -Arg3 val3
    azurePowerShellVersion: latestVersion
    pwsh: true

下列自變數示範如何叫用內嵌腳本。

- task: AzurePowerShell@5
  inputs:
    azureSubscription: 'Azure subscription connection placeholder'
    azurePowerShellVersion: LatestVersion
    ScriptType: 'InlineScript'
    Inline: |
      # You can write your azure powershell scripts inline here. 
      # You can also pass predefined and custom variables to this script using arguments
      Write-Host 'Hello'
      Write-Host 'World!'

需求

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