AzureSpringCloud@0 - Azure Spring Apps v0 タスク

このタスクでは、Azure Spring Apps にアプリケーションをデプロイし、それらのデプロイを管理します。

重要

このタスクは、 Azure Spring Apps の Basic/Standard プランと Enterprise プランでサポートされています。 詳細については、「 Azure Spring Apps へのアプリケーションデプロイを自動化する」を参照してください。

構文

# Azure Spring Apps v0
# Deploy applications to Azure Spring Apps and manage deployments.
- task: AzureSpringCloud@0
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    Action: 'Deploy' # 'Deploy' | 'Set Production' | 'Delete Staging Deployment'. Required. Action. Default: Deploy.
    AzureSpringCloud: # string. Required. Azure Spring Apps Name. 
    AppName: # string. Required. App. 
    #DeploymentType: 'Artifacts' # 'Artifacts' | 'CustomContainer'. Optional. Use when Action = Deploy. Deployment Type. Default: Artifacts.
    #UseStagingDeployment: true # boolean. Optional. Use when Action = Deploy || Action = Set Production. Use Staging Deployment. Default: true.
    #CreateNewDeployment: false # boolean. Optional. Use when Action = Deploy && UseStagingDeployment = false. Create a new staging deployment if one does not exist. Default: false.
    #DeploymentName: # string. Optional. Use when UseStagingDeployment = false && Action != Delete Staging Deployment. Deployment. 
    #Package: '$(System.DefaultWorkingDirectory)/**/*.jar' # string. Optional. Use when Action = Deploy && DeploymentType = Artifacts. Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.jar.
    #RegistryServer: 'docker.io' # string. Optional. Use when Action = Deploy && DeploymentType = CustomContainer. Registry Server. Default: docker.io.
    #RegistryUsername: # string. Optional. Use when Action = Deploy && DeploymentType = CustomContainer. Registry Username. 
    #RegistryPassword: # string. Optional. Use when Action = Deploy && DeploymentType = CustomContainer. Registry Password. 
    #ImageName: 'hello-world:v1' # string. Optional. Use when Action = Deploy && DeploymentType = CustomContainer. Image Name and Tag. Default: hello-world:v1.
    #ImageCommand: # string. Optional. Use when Action = Deploy && DeploymentType = CustomContainer. Image Command. 
    #ImageArgs: # string. Optional. Use when Action = Deploy && DeploymentType = CustomContainer. Image Arguments. 
    #ImageLanguageFramework: # 'springboot'. Optional. Use when Action = Deploy && DeploymentType = CustomContainer. Language Framework. 
  # Application and Configuration Settings
    #Builder: # string. Optional. Use when Action = Deploy && DeploymentType = Artifacts. Builder. 
    #EnvironmentVariables: # string. Optional. Use when Action = Deploy. Environment Variables. 
    #JvmOptions: # string. Optional. Use when Action = Deploy && DeploymentType = Artifacts. JVM Options. 
    #RuntimeVersion: 'Java_11' # 'Java_8' | 'Java_11' | 'Java_17' | 'Java_21' | 'NetCore_31'. Optional. Use when Action = Deploy && DeploymentType = Artifacts. Runtime Version. Default: Java_11.
    #DotNetCoreMainEntryPath: # string. Optional. Use when RuntimeVersion = NetCore_31. Main Entry Path. 
    #Version: # string. Optional. Use when Action = Deploy. Version.

入力

azureSubscription - Azure サブスクリプション
入力エイリアス: ConnectedServiceName。 string. 必須です。

デプロイの Azure Resource Manager サブスクリプションを指定します。

Action - アクション
string. 必須です。 使用できる値: Deploy、 Set Production (運用展開の設定)、 Delete Staging Deployment。 既定値: Deploy。

Azure Spring Apps で実行されるアクション。

AzureSpringCloud - Azure Spring Apps 名
string. 必須です。

デプロイする Azure Spring Apps インスタンスの名前またはリソース ID。

AppName - アプリ
string. 必須です。

デプロイする Azure Spring Apps アプリの名前。 アプリは、タスクの実行前に存在する必要があります。

DeploymentType - デプロイの種類
string. 省略可能。 の場合は Action = Deployを使用します。 使用できる値: Artifacts、 CustomContainer (カスタム コンテナー)。 既定値: Artifacts。

ソース コードまたは Java パッケージを使用してデプロイするには、"Artifacts" を選択します。コンテナー イメージを使用してデプロイするには、[カスタム コンテナー] を選択します。

UseStagingDeployment - ステージングデプロイを使用する
boolean. 省略可能。 の場合は Action = Deploy || Action = Set Productionを使用します。 既定値: true。

この入力は、タスクの実行時に、 として staging設定されているデプロイを自動的に選択します。

に設定されている true場合は、実行時にステージング デプロイ として設定されているデプロイにタスクを適用します。 省略した場合は、 パラメーターを DeploymentName 設定する必要があります。

CreateNewDeployment - ステージング デプロイが存在しない場合は、新しいステージング デプロイを作成します。
boolean. 省略可能。 の場合は Action = Deploy && UseStagingDeployment = falseを使用します。 既定値: false。

を に true設定し、 で DeploymentName 指定されたデプロイが実行時に存在しない場合は、作成されます。 省略した場合は、 パラメーターを DeploymentName 設定する必要があります。

DeploymentName - 展開
string. 省略可能。 の場合は UseStagingDeployment = false && Action != Delete Staging Deploymentを使用します。

このタスクが適用される デプロイ 。 ブルーグリーンデプロイを使用しない場合は、このフィールドを に設定します default。 値は文字で始まる必要があり、小文字と数字のみで構成されます。

Package - パッケージまたはフォルダー
string. 省略可能。 の場合は Action = Deploy && DeploymentType = Artifactsを使用します。 既定値: $(System.DefaultWorkingDirectory)/**/*.jar。

Azure Spring Apps アプリのコンテンツを含むパッケージまたはフォルダーへのファイル パス (.jar Java 用のファイル、 .zip .NET Core 用)。
変数 ( ビルド | リリース) とワイルドカードがサポートされています。
たとえば、$(System.DefaultWorkingDirectory)/**/*.jar のように指定します。

Builder - ビルダー
string. 省略可能。 の場合は Action = Deploy && DeploymentType = Artifactsを使用します。

VMware Tanzu® Build Service™ のビルダーを選択します。これはエンタープライズ層で使用できます。
詳細については、「Tanzu Build Service の使用」をチェック。

RegistryServer - レジストリ サーバー
string. 省略可能。 の場合は Action = Deploy && DeploymentType = CustomContainerを使用します。 既定値: docker.io。

コンテナー イメージのレジストリ。 既定値: docker.io。

RegistryUsername - レジストリ ユーザー名
string. 省略可能。 の場合は Action = Deploy && DeploymentType = CustomContainerを使用します。

コンテナー レジストリのユーザー名です。

RegistryPassword - レジストリ パスワード
string. 省略可能。 の場合は Action = Deploy && DeploymentType = CustomContainerを使用します。

コンテナー レジストリのパスワード。

ImageName - イメージ名とタグ
string. 省略可能。 の場合は Action = Deploy && DeploymentType = CustomContainerを使用します。 既定値: hello-world:v1。

コンテナー イメージ タグ。

ImageCommand - Image コマンド
string. 省略可能。 の場合は Action = Deploy && DeploymentType = CustomContainerを使用します。

コンテナー イメージのコマンド。

ImageArgs - Image 引数
string. 省略可能。 の場合は Action = Deploy && DeploymentType = CustomContainerを使用します。

コンテナー イメージの引数。

ImageLanguageFramework - 言語フレームワーク
string. 省略可能。 の場合は Action = Deploy && DeploymentType = CustomContainerを使用します。 使用できる値: springboot。

EnvironmentVariables - 環境変数
string. 省略可能。 の場合は Action = Deployを使用します。

構文 -key value を使用して入力する環境変数 (例: -CUSTOMER_NAME Contoso-WEBSITE_TIME_ZONE)。 スペースを含む値は、二重引用符で囲む必要があります (例: "Eastern Standard Time")。

JvmOptions - JVM オプション
string. 省略可能。 の場合は Action = Deploy && DeploymentType = Artifactsを使用します。

アプリの JVM オプションを編集します。 JVM オプションを含む文字列 (例: -Xms1024m -Xmx2048m)。

RuntimeVersion - ランタイム バージョン
string. 省略可能。 の場合は Action = Deploy && DeploymentType = Artifactsを使用します。 使用できる値: Java_8 (Java 8)、 Java_11 (Java 11)、 Java_17 (Java 17) Java_21 、(Java 21) NetCore_31 、(.Net Core 3.1)。 既定値: Java_11。

アプリを実行するランタイム バージョン。

DotNetCoreMainEntryPath - メイン エントリ パス
string. 省略可能。 の場合は RuntimeVersion = NetCore_31を使用します。

zip ルートを基準とした .NET 実行可能ファイルへのパス。

Version - バージョン
string. 省略可能。 の場合は Action = Deployを使用します。

デプロイ バージョン。 設定されていない場合、バージョンは変更されません。

タスク制御オプション

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

出力変数

このタスクでは、ダウンストリームのステップ、ジョブ、およびステージで使用できる次の 出力変数を定義します。

testEndpoint
[Deploy]\(デプロイ\) アクションの後のみ。 更新されたデプロイにアクセスするためのプライベート URL が含まれています。

注釈

このタスクを使用して、 Azure Spring Apps にアプリケーションをデプロイし、Azure Spring Cloud のデプロイを管理します。

重要

このタスクは、 Azure Spring Apps の Basic/Standard プランと Enterprise プランでサポートされています。 詳細については、「 Azure Spring Apps へのアプリケーションデプロイを自動化する」を参照してください。

例

次の例は、一般的な使用シナリオを示しています。 詳細については、「 Azure Spring Apps へのアプリケーションデプロイを自動化する」を参照してください。

ステージング環境のデプロイを削除する

[ステージング デプロイの削除] アクションを使用すると、運用トラフィックを受信していないデプロイを削除できます。 これにより、そのデプロイで使用されるリソースが解放され、新しいステージング デプロイのための領域が作り出されます:

variables:
  azureSubscription: Contoso

steps:
- task: AzureSpringCloud@0
  continueOnError: true # Don't fail the pipeline if a staging deployment doesn't already exist.
  inputs:
    continueOnError: true
    inputs:
    azureSubscription: $(azureSubscription)
    Action: 'Delete Staging Deployment'
    AppName: customer-api
    AzureSpringCloud: contoso-dev-az-spr-cld

デプロイ中

運用環境

次の例では、Azure Spring Apps の既定の運用デプロイにデプロイします。 これは、Basic SKU を使用する場合に考えられる唯一のデプロイ シナリオです:

注意

パッケージ検索パターンは、1 つのパッケージのみを返す必要があります。 ビルド タスクで sources.jar と javadoc.jar などの複数の JAR パッケージが生成される場合は、アプリケーションのバイナリ成果物にのみ一致するように検索パターンを絞り込む必要があります。

variables:
  azureSubscription: Contoso

steps:
- task: AzureSpringCloud@0
    inputs:
    azureSubscription: $(azureSubscription)
    Action: 'Deploy'
    AzureSpringCloud: contoso-dev-az-spr-cld
    AppName: customer-api
    UseStagingDeployment: false
    DeploymentName: default
    Package: '$(System.DefaultWorkingDirectory)/**/*customer-api*.jar'

ブルーグリーン

次の例では、既存のステージング デプロイにデプロイします。 このデプロイは、実稼働デプロイとして設定されるまで、実稼働トラフィックを受信しません。

variables:
  azureSubscription: Contoso

steps:
- task: AzureSpringCloud@0
    inputs:
    azureSubscription: $(azureSubscription)
    Action: 'Deploy'
    AzureSpringCloud: contoso-dev-az-spr-cld
    AppName: customer-api
    UseStagingDeployment: true
    Package: '$(System.DefaultWorkingDirectory)/**/*customer-api*.jar'

代替アプローチを含むブルーグリーンデプロイの詳細については、 ブルーグリーンデプロイ戦略に関するページを参照してください。

新規運用環境の設定

次の例では、現在のステージング デプロイを運用環境として設定し、運用環境のトラフィックを受信するデプロイを効果的にスワップします。

variables:
  azureSubscription: Contoso

steps:
- task: AzureSpringCloud@0
    inputs:
    azureSubscription: $(azureSubscription)
    Action: 'Set Production'
    AzureSpringCloud: contoso-dev-az-spr-cld
    AppName: customer-api
    UseStagingDeployment: true

要件

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