AzureContainerApps@1 - Azure Container Apps Deploy v1 タスク
Azure Container Apps をビルドしてデプロイするための Azure DevOps タスク。
構文
# Azure Container Apps Deploy v1
# An Azure DevOps Task to build and deploy Azure Container Apps.
- task: AzureContainerApps@1
inputs:
# advanced
#workingDirectory: # string. Alias: cwd. Working Directory.
#appSourcePath: # string. Application source path.
azureSubscription: # string. Alias: connectedServiceNameARM. Required. Azure Resource Manager connection.
#acrName: # string. Azure Container Registry name.
#acrUsername: # string. Azure Container Registry username.
#acrPassword: # string. Azure Container Registry password.
#dockerfilePath: # string. Dockerfile path.
#imageToBuild: # string. Docker image to build.
#imageToDeploy: # string. Docker image to deploy.
#containerAppName: # string. Azure Container App name.
#resourceGroup: # string. Azure resource group name.
#containerAppEnvironment: # string. Azure Container App environment.
#runtimeStack: # string. Application runtime stack.
#targetPort: # string. Application target port.
#location: # string. Location of the Container App.
#environmentVariables: # string. Environment variables.
#ingress: # string. Ingress setting.
#yamlConfigPath: # string. YAML configuration file path.
#disableTelemetry: # boolean. Disable telemetry.
入力
workingDirectory
-
作業ディレクトリの
入力エイリアス: cwd。
string.
スクリプトが実行されている現在の作業ディレクトリ。 空は、リポジトリ (ビルド) または成果物 (リリース) のルートであり、$(System.DefaultWorkingDirectory) です。
appSourcePath
-
アプリケーション ソース パスの
string.
ビルドするソース アプリケーション コードのランナーの絶対パス。 指定しない場合は、コンテナー アプリに参照するイメージがあることを確認するために、"imageToDeploy" 引数を指定する必要があります。
ACR に新しいイメージをプッシュするときは、acrName と appSourcePath タスクの入力が必要です。
Azure Resource Manager 接続 を
入力エイリアス: connectedServiceNameARM。
string. 必須。
デプロイ用の Azure Resource Manager サービス接続を指定します。 このサービス接続は、コンテナー アプリが作成または更新されるユーザーの Azure サブスクリプションにリンクされている必要があります。 このサービス接続 サブスクリプション内でこれらの変更を行うための適切なアクセス許可 (共同作成者ロールなど) を持っている必要があります。
Azure Container Registry 名 を
string.
実行可能なアプリケーション イメージがプッシュされる Azure Container Registry の名前。
ACR に新しいイメージをプッシュするときは、acrName と appSourcePath タスクの入力が必要です。
Azure Container Registry ユーザー名 を
string.
指定された Azure Contrainer Registry へのプッシュ要求の認証に使用されるユーザー名。 指定しない場合、アクセス トークンは 'az acr login' を介して生成され、要求を認証するために 'docker login' に提供されます。
Azure Container Registry のパスワード を
string.
指定された Azure Contrainer Registry へのプッシュ要求を認証するために使用されるパスワード。 指定しない場合、アクセス トークンは 'az acr login' を介して生成され、要求を認証するために 'docker login' に提供されます。
Dockerfile パス を
string.
指定されたアプリケーション ソースの Dockerfile への相対パス (_without ファイル プレフィックス (次の 例を参照)。 指定されていない場合、このタスクは、指定されたアプリケーション ソースのルートに "Dockerfile" という名前のファイルがあるかどうかを確認し、そのファイルを使用してイメージをビルドします。 それ以外の場合は、Oryx++ Builder を使用してイメージが作成されます。
Docker イメージを imageToBuild - して をビルドする
string.
ビルドされ、ACR にプッシュされ、このタスクによってコンテナー アプリにデプロイされるイメージのカスタム名。 注: このイメージ名には ACR サーバーを含める必要があります。例: <acr-name>.azurecr.io/<repo>:<tag>. この引数を指定しない場合、既定のイメージ名は <acr-name>.azurecr.io/ado-task/container-app:<build-id>.<build-number>の形式で構築されます。
docker イメージを imageToDeploy - して をデプロイする
string.
ACR に既にプッシュされ、このタスクによってコンテナー アプリにデプロイされるイメージの名前。 注: イメージ名には ACR サーバーを含める必要があります。例: <acr-name>.azurecr.io/<repo>:<tag>. この引数を指定しない場合は、'imageToBuild' 引数に指定 (または決定) された値が使用されます。 プルする認証を必要とする ACR インスタンスでこのイメージが見つかった場合は、acrName 引数、または acrUsername 引数と acrPassword 引数を指定して、ACR インスタンスに対する要求を認証できます。
Azure Container App 名 を
string.
作成または更新される Azure Container App の名前。 指定しない場合、この値は ado-task-app-<build-id>-<build-number>の形式になります。
Azure リソース グループ名 を
string.
Azure Container App が作成される (または現在存在する) 既存のリソース グループ。 指定しない場合、この値は <container-app-name>-rgの形式になります。
Azure Container App 環境 を
string.
アプリケーションで使用する Azure Container App 環境の名前。 指定しない場合は、コンテナー アプリのリソース グループ内の既存の環境が使用されます。それ以外の場合は、<container-app-name>-envの形式で環境が作成されます。
アプリケーション ランタイム スタック の
string.
コンテナー アプリにデプロイされる最終的な実行可能なアプリケーション イメージで使用されるプラットフォーム バージョン スタック。 この値は、フォーメーション <platform>:<version>で指定する必要があります。 指定しない場合、この値は、提供されたアプリケーションの内容に基づいて Oryx によって決定されます。 Oryx でサポートされているランタイム スタックの詳細については、このドキュメント
アプリケーション ターゲット ポート の
string.
コンテナー アプリがリッスンするターゲット ポート。 指定しない場合、この値は Python アプリケーションの場合は "80"、サポートされている他のすべてのプラットフォームでは "8080" になります。
コンテナー アプリ の
string.
コンテナー アプリ (およびその他の作成されたリソース) がデプロイされる場所。
environmentVariables
-
環境変数
string.
コンテナーの環境変数の一覧。 'key=value' 形式のスペース区切り値。 既存の値をクリアする空の文字列。 シークレットを参照するためのプレフィックス値に 'secretref:' を付けます。
ingress
-
イングレス設定の
string.
可能なオプション: 外部、内部、無効。
external に設定すると (コンテナー アプリの作成時に既定値が指定されていない場合)、構成されているアプリ環境エンドポイントに応じて、コンテナー アプリがインターネットまたは VNET から表示されます。
internalに設定すると、コンテナー アプリはアプリ環境内からのみ表示されます。
disabledに設定すると、このコンテナー アプリのイングレスは無効になり、HTTP または TCP エンドポイントはありません。
YAML 構成ファイルのパス を
string.
コンテナー アプリの構成を詳しく説明する YAML ファイルへの完全パス (実行中の Azure Pipelines エージェント上)。
YAML 構成ファイル の resourceGroup プロパティは使用。この値は、タスクに指定された resourceGroup 引数またはタスクによって生成された既定のリソース グループ名のいずれかから取得されます。 YAML 構成ファイルで提供されるその他のすべてのプロパティは、このタスクの引数として指定された値をオーバーライドします。たとえば、containerAppName 引数がタスクに指定され、name プロパティが YAML 構成ファイルに設定されている場合、コンテナー アプリの作成時または更新時に YAML ファイルの name プロパティが使用されます。
イメージとアプリケーションのソース引数 (、appSourcePath、imageToDeployなど) は、コンテナー アプリで使用されるイメージを最初にビルドまたはプッシュするために引き続き使用されます。この場合、指定された YAML 構成ファイルは、imageToDeploy で指定されたイメージ (またはシナリオに応じて imageToBuild) を参照する必要があります。
新しいコンテナー アプリを作成すると、コンテナー アプリの作成時に YAML 構成ファイルにリストされているすべてのプロパティ (上記 resourceGroup を除く) が設定されます。 既存のコンテナー アプリを更新すると、ファイルに一覧表示されているプロパティのみがコンテナー アプリで更新されます。
現在、YAML ファイルでは、使用されるコンテナー レジストリのマネージド ID 認証の設定はサポートされていません。この問題の詳細については、この GitHub の問題
yamlConfigPath 引数が指定されている場合、YAML ファイルは対応する az containerapp コマンド (create またはシナリオに応じて update します。 YAML 構成ファイルが提供される場合の動作の詳細については、対応するコマンドにリンクされているドキュメントを参照してください。
YAML 構成ファイルの構造の詳細については、このサイトの
disableTelemetry
-
テレメトリ を無効にする
boolean.
'true' に設定すると、この Azure DevOps タスクによってテレメトリは収集されません。 'false' に設定されている場合、またはこの引数が指定されていない場合、この Azure DevOps タスクを対象とするコンテナー アプリのビルドとデプロイシナリオに関するテレメトリが Microsoft に送信されます。
タスク コントロールのオプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「コントロール オプションと一般的なタスク プロパティを参照してください。
出力変数
何一つ。
備考
この Azure Pipelines タスクを使用すると、ユーザーは、以前にビルドされたイメージ、イメージをビルドできる Dockerfile、またはビルダーを使用してユーザーの実行可能なアプリケーション イメージを作成することで、Azure Pipelines ワークフロー内の Azure Container App にアプリケーション ソースを簡単にデプロイできます。
タスクには、次の 2 つの使用パターンがあります。
-
ACR にイメージをプッシュする - ACR に新しいイメージをプッシュするときは、
acrNameとappSourcePathタスクの入力が必要です。 -
以前にプッシュされたイメージ をデプロイする - 以前にプッシュされたイメージをデプロイする場合は、
imageToDeployタスクの入力が必要です。 プルする認証を必要とする ACR インスタンスでこのイメージが見つかった場合は、acrName引数、またはacrUsername引数とacrPassword引数を指定して、ACR インスタンスに対する要求を認証できます。
手記
このタスクのメタデータで正式に "必須" とマークされているタスク入力はありませんが、2 つの主な使用パターンのいずれかを使用してこのタスクを正常に実行するには、一部の入力を指定する必要があります。
指定されたアプリケーション ソースで Dockerfile が見つからないか指定されていない場合は、このタスクによって次の手順が実行されます。
- Oryx++ Builder を使用して、Oryx を使用してアプリケーション ソースをビルドし、実行可能なアプリケーション イメージを生成します
- この実行可能なアプリケーション イメージを、指定された Azure Container Registry にプッシュします
- このイメージに基づいてコンテナー アプリを作成または更新します
Dockerfile がアプリケーション ソースで検出または検出された場合、ビルダーは使用されません。イメージは docker build の呼び出しでビルドされ、このイメージに基づいてコンテナー アプリが作成または更新されます。
以前にビルドされたイメージが既に ACR インスタンスにプッシュされていて、このタスクに提供されている場合、アプリケーション ソースは必要なく、コンテナー アプリの作成または更新時にイメージが使用されます。
Microsoft でホストされているエージェントでこのタスクを実行する
このタスクを Microsoft ホステッド エージェント
- macOS
- Microsoft が提供
macOS ランナーは Docker と共にインストールされません (詳細については、こちら )。その結果、このタスクは、ビルドされた実行可能なアプリケーション イメージを ACR にプッシュするなど、 コマンドを実行できません。
- Microsoft が提供
- ウィンドウズ
- Microsoft から提供 Windows ランナー
には Docker がインストールされていますが、既定では Linux ベースのイメージをプルダウンできません。その結果、このタスクは、提供されたアプリケーションソースから実行可能なアプリケーションイメージを作成するためにOryxビルダーをプルダウンすることはできません。
- Microsoft から提供 Windows ランナー
詳細については、以下 Docker の前提条件に関するセクションを参照してください。
データ/テレメトリ収集に関する通知
既定では、この Azure DevOps タスクは Microsoft の次のデータを収集します。
- ユーザーが対象とするコンテナー アプリのビルドとデプロイのシナリオ
- 、つまり、、Oryx++ Builder を使用した、指定された/見つかった Dockerfile を使用した、または以前にビルドされたイメージを提供した
注意 : イメージ名は収集
- タスクの処理時間 (ミリ秒単位)
- タスクの結果
- (、成功、失敗)
- Oryx++ Builder を使用する場合、Oryx を使用して提供されるアプリケーションの構築に関連するイベントとメトリック
データ収集を無効にする場合は、disableTelemetry 引数を trueに設定してください。
前提 条件
このタスクを実行する前に、Azure リソースと Azure DevOps サービス接続は、このタスクに指定された引数に応じて必須または省略可能です。
Azure DevOps サービス接続
Azure にデプロイするには、設定セクションの [サービス] タブを使用して、Azure サブスクリプションを Team Foundation Server または Azure Pipelines にリンクする必要があります。 [アカウント管理] 画面 (画面右上の歯車アイコン) を開き、[サービス] タブをクリックして、ビルドまたはリリース管理の定義で使用する Azure サブスクリプションを追加します。
Azure CLI
このタスクでは、Azure CLI を Azure Pipelines エージェントにインストールして、タスクの実行中にさまざまなコマンドを実行する必要があります。 エージェントに Azure CLI をインストールする方法の詳細については、このドキュメント
港湾労働者
このタスクでは、指定された Azure Container Registry にイメージをプッシュするために、Docker が Azure Pipelines エージェントにインストールされている必要があります。 エージェントに Docker をインストールする方法の詳細については、このドキュメント
さらに、Windows エージェントでこのタスクを実行しているユーザーは、Linux ベースのイメージをプルダウンできないという問題が発生する可能性があります。これを解決するには、このサイト にアクセスするか、エージェントの DockerCli.exe ファイル (通常は Program Files\Docker\Docker フォルダー内) に配置して実行してください
& `.\DockerCli.exe` -SwitchDaemon
このタスクを実行しているエージェントに Docker がインストールされていない場合でも、次のシナリオが有効になります。
- コンテナー アプリがデプロイする
imageToDeploy引数に、以前にビルドした イメージを指定する
Docker がエージェント上にあり、Linux ベースのイメージを操作できない場合、次のシナリオは引き続き有効です。
- コンテナー アプリがデプロイする
imageToDeploy引数に、以前にビルドした イメージを指定する - コンテナー アプリでビルドおよびデプロイされるアプリケーション ソースの一部として
Dockerfileを提供する-
注意:
Dockerfileには Linux ベースのイメージ レイヤーを含めることはできません
-
注意:
pack CLI
パック CLI は Cloud Native Buildpacks プロジェクトによって管理され、このタスクでは、アプリケーション ソース コードが提供され、追加の Dockerfile が指定または見つからない場合に、ユーザーの実行可能なアプリケーション イメージを作成するために使用されます。 ビルダー は、Oryx によって作成され、このタスクに提供されたアプリケーション ソース コードを取り込み、イメージ レジストリにプッシュし、コンテナー アプリ内でアプリケーションをビルドして実行するために使用できるイメージを生成します。
パック CLI の安定したバージョンは、タスクを実行している Azure Pipelines エージェントにインストールされ、このエージェントのベース OS に応じて、インストールを支援するためにさまざまなツールが活用されます。
- Windows ランナーの場合:
- 次の操作を行うために、一連の PowerShell コマンドが実行されます。
-
packフォルダーがまだ存在しない場合は、エージェントの一時フォルダーにpackフォルダーを作成します - パック CLI
.zipをこのpackフォルダーにダウンロードします - この
.zipからコンテンツを解凍し、packフォルダーに配置します。 -
.zipを削除します
-
- 次の操作を行うために、一連の PowerShell コマンドが実行されます。
- Windows 以外のランナーの場合:
-
curlは、pack実行可能ファイルを含む.tgzをプルダウンするために使用されます -
tarを使用して、.tgzを解凍し、pack実行可能ファイルを/usr/local/binに配置します
-
Azure Container Registry
ユーザーがコンテナー イメージをプッシュできる Azure Container Registry が存在する必要があります。 このタスクでは、Azure Container Registry を利用して、ビルドされた実行可能なアプリケーション イメージをコンテナー アプリにプッシュするか、コンテナー アプリのデプロイを行います。
acrName 引数を使用して、Azure Container Registry の名前が必要です。
ユーザーは、Azure Container Registry インスタンスへの呼び出しを認証する acrUsername 引数と acrPassword 引数の値を指定することもできます。指定しない場合は、代わりに呼び出しを認証する Azure CLI を介してアクセス トークンが生成されます。
Azure Container App 環境
Azure Container App 環境 は、タスクのパフォーマンスを向上させるために、ユーザーが以前に作成しておくことをお勧めします。 以前に環境が作成されていない場合、または作成されたコンテナー アプリのホストに使用されているリソース グループに環境が見つからない場合は、az containerapp up コマンドの一部として環境が作成されるため、時間がかかる場合があります。
例
次の例では、さまざまなシナリオで AzureContainerApps を使用する方法について説明します。
最小 - コンテナー アプリのアプリケーション イメージをビルドする
steps:
- task: AzureContainerApps@1
displayName: Build and deploy Container App
inputs:
connectedServiceNameARM: 'azure-subscription-service-connection'
appSourcePath: '$(System.DefaultWorkingDirectory)'
acrName: 'mytestacr'
これにより、<container-app-name>-rgという名前の新しいリソース グループに ado-task-app-<build-id>-<build-number> という名前の新しいコンテナー アプリが作成されます。 コンテナー アプリは、指定された appSourcePath からビルドされ、指定された ACR インスタンスにプッシュされたイメージに基づいています。 指定された ACR インスタンスへのプッシュを認証するためのアクセス トークンが生成されます。
最小 - コンテナー アプリに対して以前に公開されたイメージを使用する
steps:
- task: AzureContainerApps@1
displayName: Build and deploy Container App
inputs:
connectedServiceNameARM: 'azure-subscription-service-connection'
imageToDeploy: mcr.microsoft.com/<existing-image>:latest
これにより、<container-app-name>-rg という名前の新しいリソース グループに ado-task-app-<build-id>-<build-number> という名前の新しいコンテナー アプリが作成されます。新しいイメージはビルドされませんが、mcr.microsoft.com/<existing-image>:latest という名前の既存のイメージがコンテナー アプリに使用されます。
最小 - コンテナー アプリ用に以前に発行されたイメージで YAML 構成ファイルを使用する
steps:
- task: AzureContainerApps@1
displayName: Build and deploy Container App
inputs:
yamlConfigPath: simple-image-container-app.yaml
これにより、<container-app-name>-rg という名前の新しいリソース グループに ado-task-app-<build-id>-<build-number> という名前の新しいコンテナー アプリが作成されます。新しいイメージはビルドされませんが、mcr.microsoft.com/<existing-image>:latest という名前の既存のイメージがコンテナー アプリに使用されます。 コンテナー アプリに関する追加のプロパティは、
simple-image-container-app.yaml ファイルの構造は次のとおりです。
properties:
managedEnvironmentId: /subscriptions/SUBSCRIPTION_ID/resourceGroups/RESOURCE_GROUP/providers/Microsoft.App/managedEnvironments/CONTAINER_APP_ENVIRONMENT
configuration:
ingress:
external: true
allowInsecure: false
targetPort: 80
template:
containers:
- image: mcr.microsoft.com/<existing-image>:latest
name: mysampleimagecontainer
ACR 資格情報を使用した認証
steps:
- task: AzureContainerApps@1
displayName: Build and deploy Container App
inputs:
connectedServiceNameARM: 'azure-subscription-service-connection'
appSourcePath: '$(System.DefaultWorkingDirectory)'
acrName: 'mytestacr'
acrUsername: $(ACR_USERNAME_SECRET)
acrPassword: $(ACR_PASSWORD_SECRET)
これにより、<container-app-name>-rgという名前の新しいリソース グループに ado-task-app-<build-id>-<build-number> という名前の新しいコンテナー アプリが作成されます。 コンテナー アプリは、指定された appSourcePath からビルドされ、指定された ACR インスタンスにプッシュされたイメージに基づいています。 指定された ACR 資格情報は、ACR インスタンスへの呼び出しを認証するために使用されます。
指定されたコンテナー アプリ名
steps:
- task: AzureContainerApps@1
displayName: Build and deploy Container App
inputs:
connectedServiceNameARM: 'azure-subscription-service-connection'
appSourcePath: '$(System.DefaultWorkingDirectory)'
acrName: 'mytestacr'
containerAppName: 'my-test-container-app'
これにより、新しいリソース グループ名に my-test-container-app という名前の新しいコンテナー アプリ my-test-container-app-rg作成されます。
指定されたリソース グループ
steps:
- task: AzureContainerApps@1
displayName: Build and deploy Container App
inputs:
connectedServiceNameARM: 'azure-subscription-service-connection'
appSourcePath: '$(System.DefaultWorkingDirectory)'
acrName: 'mytestacr'
resourceGroup: 'my-test-rg'
これにより、my-test-rgという名前のリソース グループに ado-task-app-<build-id>-<build-number> という名前の新しいコンテナー アプリが作成されます。
my-test-rg リソース グループが存在しない場合は、このタスクの一部として作成されます。
指定されたコンテナー アプリ名とリソース グループ
steps:
- task: AzureContainerApps@1
displayName: Build and deploy Container App
inputs:
connectedServiceNameARM: 'azure-subscription-service-connection'
appSourcePath: '$(System.DefaultWorkingDirectory)'
acrName: 'mytestacr'
containerAppName: 'my-test-container-app'
resourceGroup: 'my-test-rg'
これにより、my-test-rgという名前のリソース グループに my-test-container-app という名前の新しいコンテナー アプリが作成されます。
my-test-rg リソース グループが存在しない場合は、このタスクの一部として作成されます。
コンテナー アプリ環境が提供されます
steps:
- task: AzureContainerApps@1
displayName: Build and deploy Container App
inputs:
connectedServiceNameARM: 'azure-subscription-service-connection'
appSourcePath: '$(System.DefaultWorkingDirectory)'
acrName: 'mytestacr'
containerAppEnvironment: 'my-test-container-app-env'
これにより、ado-task-app-<build-id>-<build-number> という名前の新しいコンテナー アプリが、my-test-container-app-envという名前の新しいコンテナー アプリ環境を持つ <container-app-name>-rg という名前の新しいリソース グループに作成されます。
ランタイム スタックが提供されます
steps:
- task: AzureContainerApps@1
displayName: Build and deploy Container App
inputs:
connectedServiceNameARM: 'azure-subscription-service-connection'
appSourcePath: '$(System.DefaultWorkingDirectory)'
acrName: 'mytestacr'
runtimeStack: 'dotnetcore:7.0'
これにより、ado-task-app-<build-id>-<build-number> という名前の新しいコンテナー アプリが、実行可能なアプリケーション イメージで .NET 7 ランタイム スタックを使用 <container-app-name>-rg という名前の新しいリソース グループに作成されます。
Dockerfile が提供されました
steps:
- task: AzureContainerApps@1
displayName: Build and deploy Container App
inputs:
connectedServiceNameARM: 'azure-subscription-service-connection'
appSourcePath: '$(System.DefaultWorkingDirectory)'
acrName: 'mytestacr'
dockerfilePath: 'test.Dockerfile'
これにより、ado-task-app-<build-id>-<build-number> という名前の新しいコンテナー アプリが <container-app-name>-rg という名前の新しいリソース グループに作成されます。このリソース グループでは、指定されたアプリケーション ソース パス ディレクトリにある test.Dockerfile ファイルから実行可能なアプリケーション イメージが作成されます。
appSourcePath 引数と dockerfilePath 引数は、タスク内で連結されます。
ビルドするイメージが用意されています
steps:
- task: AzureContainerApps@1
displayName: Build and deploy Container App
inputs:
connectedServiceNameARM: 'azure-subscription-service-connection'
appSourcePath: '$(System.DefaultWorkingDirectory)'
acrName: 'mytestacr'
imageToBuild: 'mytestacr.azurecr.io/app:latest'
これにより、ado-task-app-<build-id>-<build-number> という名前の新しいコンテナー アプリが <container-app-name>-rg という名前の新しいリソース グループに作成されます。ここで、イメージがビルドされて ACR にプッシュ mytestacr.azurecr.io/app:latest。
必要条件
| 要件 | 形容 |
|---|---|
| パイプラインの種類 | YAML、クラシック ビルド、クラシック リリース |
| 実行日 | エージェント、DeploymentGroup |
| の需要 | 何一つ |
| 機能の | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
| コマンドの制限 | 任意 |
| 設定可能な変数 | 任意 |
| エージェントのバージョン | 2.144.0 以上 |
| タスク カテゴリ | 展開 |
関連項目
- Azure Pipelines から Azure Container Apps にデプロイする