Linux エージェントで実行する場合はシェル スクリプトで Azure サブスクリプションに対して Azure CLI コマンドを実行し、Windows エージェントで実行する場合はバッチ スクリプトを実行します。
構文
# Azure CLI v1
# Run Azure CLI commands against an Azure subscription in a Shell script when running on Linux agent or Batch script when running on Windows agent.
- task: AzureCLI@1
inputs:
azureSubscription: # string. Alias: connectedServiceNameARM. Required. Azure subscription.
scriptLocation: 'scriptPath' # 'inlineScript' | 'scriptPath'. Required. Script Location. Default: scriptPath.
scriptPath: # string. Required when scriptLocation = scriptPath. Script Path.
#inlineScript: # string. Required when scriptLocation = inlineScript. Inline Script.
#arguments: # string. Alias: args. Arguments.
# Advanced
#addSpnToEnvironment: false # boolean. Access service principal details in script. Default: false.
#useGlobalConfig: false # boolean. Use global Azure CLI configuration. Default: false.
#workingDirectory: # string. Alias: cwd. Working Directory.
#failOnStandardError: false # boolean. Fail on Standard Error. Default: false.
入力
Azure サブスクリプション を
入力エイリアス: connectedServiceNameARM
。
string
。 必須。
デプロイ用の Azure Resource Manager サブスクリプションを選択します。
scriptLocation
-
スクリプトの場所の
string
。 必須。 使用できる値: inlineScript
(インライン スクリプト)、scriptPath
(スクリプト パス)。 既定値: scriptPath
.
スクリプトの場所を選択します。
scriptPath
-
スクリプト パスの
string
。
scriptLocation = scriptPath
する場合に必要です。
スクリプトの完全修飾パス、または既定の作業ディレクトリを基準としたパス。
インライン スクリプト の
string
。
scriptLocation = inlineScript
する場合に必要です。
スクリプトは、ここでインラインで記述できます。 Windows エージェントを使用する場合は、バッチ スクリプトを使用します。 Linux ベースのエージェントを使用する場合は、シェル スクリプトを使用します。 バッチ ファイルの場合は、すべての Azure コマンドの前にプレフィックス call
を使用します。 引数を使用して、このスクリプトに定義済み変数とカスタム変数を渡すこともできます
次の例を参照してください。 1 つ目はシェルの例で、2 つ目はバッチの例です。
azure --version || azure account show
call azure --version || call azure account show
スクリプトでサービス プリンシパルの詳細にアクセスする addSpnToEnvironment
-
boolean
。 既定値: false
.
選択した Azure エンドポイントのサービス プリンシパル ID とキーをスクリプトの実行環境に追加します。 スクリプトでは、$servicePrincipalId
変数と $servicePrincipalKey
変数を使用できます。
これが有効なのは、Azure エンドポイントにサービス プリンシパル認証スキームがある場合のみです。
useGlobalConfig
-
グローバル Azure CLI 構成 を使用する
boolean
。 既定値: false
.
これが false の場合、このタスクは Azure CLI 構成ディレクトリ 独自のを使用します。 これは、並列 リリースで Azure CLI タスク 実行するために使用できます。
workingDirectory
-
作業ディレクトリの
入力エイリアス: cwd
。
string
。
スクリプトが実行されている現在の作業ディレクトリ。 空白のままにした場合、この入力はリポジトリ (ビルド) または成果物 (リリース) のルートであり、$(System.DefaultWorkingDirectory)
。
標準エラーで失敗する failOnStandardError
-
boolean
。 既定値: false
.
この入力が true の場合、エラーが StandardError ストリームに書き込まれると、このタスクは失敗します。 標準エラーを無視する場合はチェック ボックスをオフにし、代わりに終了コードを使用して状態を判断します。
タスク コントロールのオプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「コントロール オプションと一般的なタスク プロパティを参照してください。
出力変数
なし。
注釈
バージョン 1.0 の新機能:
- Python ベースの新しい Azure CLI 2.0 をサポート
- クロスプラットフォーム エージェント (Linux、macOS、または Windows) で動作します
- Azure CLI 1.0 (node.jsベース) を使用する場合は、タスク バージョン 0.0 に切り替えます
- 制限事項: - Azure クラシック サブスクリプションはサポートされません。 Azure CLI 2.0 では、Azure Resource Manager (ARM) サブスクリプションのみがサポートされます。