AzurePowerShell@3 - v3 タスクのAzure PowerShell

このタスクを使用して、Azure 環境内で PowerShell スクリプトを実行します。 Azure コンテキストは、指定された Azure Resource Manager サービス接続で認証されます。

構文

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

入力

azureConnectionType - Azure 接続の種類
入力エイリアス: ConnectedServiceNameSelector。 string. 使用できる値: ConnectedServiceName (Azure クラシック)、 ConnectedServiceNameARM (Azure Resource Manager)。 既定値: ConnectedServiceNameARM。

azureClassicSubscription - Azure クラシック サブスクリプション
入力エイリアス: ConnectedServiceName。 string. ConnectedServiceNameSelector = ConnectedServiceName の場合に必要です。

PowerShell を実行する前に構成する Azure クラシック サブスクリプション。

azureSubscription - Azure サブスクリプション
入力エイリアス: ConnectedServiceNameARM。 string. ConnectedServiceNameSelector = ConnectedServiceNameARM の場合に必要です。

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。

実行するスクリプトを指定します。 サポートされているインライン スクリプトの最大長は 5,000 文字です。 より長いスクリプトを使用する場合は、ファイルのスクリプトを使用します。

ScriptArguments - スクリプト引数
string. 省略可能。 の場合は ScriptType = FilePathを使用します。

PowerShell に渡す追加のパラメーター。 これらは、序数パラメーターまたは名前付きパラメーターのいずれかです。

errorActionPreference - ErrorActionPreference
string. 許可値: stop、continue、silentlyContinue。 既定値: stop。

スクリプトを実行するための変数の ErrorActionPreference 値を選択します。

FailOnStandardError - 標準エラー時に失敗する
boolean. 既定値: false。

これが true の場合、エラーがエラー パイプラインに書き込まれた場合、または標準エラー ストリームにデータが書き込まれた場合、このタスクは失敗します。

azurePowerShellVersion - Azure PowerShell バージョン
入力エイリアス: TargetAzurePs。 string. 使用できる値: LatestVersion (インストールされている最新バージョン) OtherVersion 、(他のバージョンを指定します)。 既定値: OtherVersion。

ホストされているエージェントの場合、サポートされているAzure PowerShellバージョンは2.1.0、、3.8.0、4.2.15.1.1および 6.7.0です。 エージェントで使用可能な最新バージョンを選択するには、[(インストールされている最新バージョン)] を選択 LatestVersion します。

プライベート エージェントの場合は、(他のバージョンを指定する) を使用して、Azure PowerShellの優先バージョンをOtherVersion指定できます。

preferredAzurePowerShellVersion - 優先Azure PowerShellバージョン
入力エイリアス: CustomTargetAzurePs。 string. TargetAzurePs = OtherVersion の場合に必要です。

推奨されるAzure PowerShellバージョンは、適切なセマンティックバージョンである必要があります。 1.2.3.. のような 2.\*,2.3.\* 正規表現はサポートされていません。 現在、ホストされるエージェントでは、Azure モジュールの2.1.0バージョン 、、3.8.0、4.2.15.1.1および AzureRM モジュールの2.1.0バージョン 、3.8.0、4.2.1、、 5.1.16.7.0がサポートされています。

validateScriptSignature - スクリプト署名を検証する
boolean. 省略可能。 の場合は ScriptType = FilePathを使用します。 既定値: false。

これが true の場合、タスクは最初にチェックして、指定したスクリプトが署名され、実行前に有効であることを確認します。

タスク制御オプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。

出力変数

[なし] :

解説

標準エラーの失敗と ErrorActionPreference のサポートが追加されました。

要件

要件	説明
パイプラインの種類	YAML、クラシック ビルド、クラシック リリース
実行日	エージェント、DeploymentGroup
確認要求	セルフホステッド エージェントには、このタスクを使用するジョブを実行するための次の要求に一致する機能が必要です。
Capabilities	このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限	Any
設定可能な変数	Any
エージェントのバージョン	2.0.0 以上
タスクのカテゴリ	配置