AzureRmWebAppDeployment@3 - v3 タスクのデプロイAzure App Service

このタスクを使用して、Docker、Java、.NET、.NET Core、Node.js、PHP、Python、または Ruby を使用して Web、モバイル、または API アプリをAzure App Serviceするためにデプロイします。

注意

AzureFunctionApp@1を使用して、Azure Functions アプリをデプロイします。

構文

# Azure App Service deploy v3
# Deploy to Azure App Service a web, mobile, or API app using Docker, Java, .NET, .NET Core, Node.js, PHP, Python, or Ruby.
- task: AzureRmWebAppDeployment@3
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    appType: 'app' # 'app' | 'applinux' | 'functionapp' | 'api' | 'mobileapp'. Alias: WebAppKind. Required. App type. Default: app.
    WebAppName: # string. Required. App Service name. 
    #DeployToSlotFlag: false # boolean. Optional. Use when WebAppKind != "". Deploy to slot. Default: false.
    #ResourceGroupName: # string. Required when DeployToSlotFlag = true. Resource group. 
    #SlotName: # string. Required when DeployToSlotFlag = true. Slot. 
    #ImageSource: 'Registry' # 'Registry' | 'Builtin'. Optional. Use when WebAppKind = applinux || WebAppKind = linux. Image Source. Default: Registry.
    #AzureContainerRegistry: # string. Required when ImageSource = AzureContainerRegistry. Registry. 
    #AzureContainerRegistryLoginServer: # string. Optional. Use when ImageSource = invalidimagesource. Registry Login Server Name. 
    #AzureContainerRegistryImage: # string. Required when ImageSource = AzureContainerRegistry. Image. 
    #AzureContainerRegistryTag: # string. Optional. Use when ImageSource = AzureContainerRegistry. Tag. 
    #DockerRepositoryAccess: 'public' # 'private' | 'public'. Required when ImageSource = invalidImage. Repository Access. Default: public.
    #dockerRegistryConnection: # string. Alias: RegistryConnectedServiceName. Required when DockerRepositoryAccess = private || ImageSource = PrivateRegistry. Registry Connection. 
    #PrivateRegistryImage: # string. Required when ImageSource = PrivateRegistry. Image. 
    #PrivateRegistryTag: # string. Optional. Use when ImageSource = PrivateRegistry. Tag. 
    #DockerNamespace: # string. Required when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource  = Registry. Registry or Namespace. 
    #DockerRepository: # string. Required when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource  = Registry. Image. 
    #DockerImageTag: # string. Optional. Use when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource  = Registry. Tag. 
    #VirtualApplication: # string. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Virtual application. 
    #Package: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Required when WebAppKind != linux && WebAppKind != applinux &&  WebAppKind != "". Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
    #packageForLinux: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Alias: BuiltinLinuxPackage. Required when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin. Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
    #RuntimeStack: # string. Required when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin. Runtime Stack. 
    #StartupCommand: # string. Optional. Use when WebAppKind = applinux || WebAppKind = linux. Startup command. 
  # Output
    #WebAppUri: # string. Optional. Use when WebAppKind != "". App Service URL. 
  # Post Deployment Action
    #ScriptType: # 'Inline Script' | 'File Path'. Optional. Use when WebAppKind != "". Deployment script type. 
    #InlineScript: ':: You can provide your deployment commands here. One command per line.' # string. Required when ScriptType == Inline Script && WebAppKind != "". Inline Script. Default: :: You can provide your deployment commands here. One command per line..
    #ScriptPath: # string. Required when ScriptType == File Path && WebAppKind != "". Deployment script path. 
  # File Transforms & Variable Substitution Options
    #GenerateWebConfig: false # boolean. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Generate Web.config. Default: false.
    #WebConfigParameters: # string. Required when GenerateWebConfig == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Web.config parameters. 
    #enableXmlTransform: false # boolean. Alias: XmlTransformation. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. XML transformation. Default: false.
    #enableXmlVariableSubstitution: false # boolean. Alias: XmlVariableSubstitution. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. XML variable substitution. Default: false.
    #JSONFiles: # string. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. JSON variable substitution. 
  # Application and Configuration Settings
    #AppSettings: # string. App settings. 
    #ConfigurationSettings: # string. Configuration settings. 
  # Additional Deployment Options
    #TakeAppOfflineFlag: false # boolean. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Take App Offline. Default: false.
    #UseWebDeploy: false # boolean. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Publish using Web Deploy. Default: false.
    #SetParametersFile: # string. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". SetParameters file. 
    #RemoveAdditionalFilesFlag: false # boolean. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Remove additional files at destination. Default: false.
    #ExcludeFilesFromAppDataFlag: false # boolean. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Exclude files from the App_Data folder. Default: false.
    #AdditionalArguments: # string. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Additional arguments. 
    #RenameFilesFlag: false # boolean. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Rename locked files. Default: false.

入力

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

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

appType - アプリの種類
入力エイリアス: WebAppKind。 string. 必須です。 使用できる値: app (Web App) applinux 、(Linux Web App)、 functionapp (Function App (Not recommended、Use Azure Functions Task))、 api (API App)、 mobileapp (Mobile App)。 既定値: app。

デプロイする Web アプリの種類を指定します。

注: 組み込みのプラットフォーム イメージまたはカスタム コンテナー イメージのデプロイには、Linux Web App を指定します。

WebAppName - App Service名
string. 必須です。

既存のAzure App Serviceの名前を指定します。 選択したアプリの種類に基づくアプリ サービスは、タスク アシスタントを使用している場合にのみ一覧表示されます。

DeployToSlotFlag - スロットにデプロイする
boolean. 省略可能。 の場合は WebAppKind != ""を使用します。 既定値: false。

運用スロット以外の既存のスロットにデプロイするには、このオプションを使用します。 このオプションが選択されていない場合、Azure App Serviceは運用スロットにデプロイされます。

ResourceGroupName - リソース グループ
string. DeployToSlotFlag = true の場合に必要です。

上記で指定したAzure App Serviceを含む Azure リソース グループを指定します。

SlotName - スロット
string. DeployToSlotFlag = true の場合に必要です。

運用スロット以外の既存のスロットを指定します。

ImageSource - イメージ ソース
string. 省略可能。 の場合は WebAppKind = applinux || WebAppKind = linuxを使用します。 使用できる値: Registry (コンテナー レジストリ)、 Builtin (組み込みイメージ)。 既定値: Registry。

App Service on Linuxには、アプリケーションを発行するための 2 つの異なるオプションが用意されています。

組み込みのプラットフォーム イメージを使用したカスタム イメージのデプロイまたはアプリのデプロイ。

AzureContainerRegistry - レジストリ
string. ImageSource = AzureContainerRegistry の場合に必要です。

特定のレジストリのグローバルに一意の最上位ドメイン名。

注: 完全修飾イメージ名の形式<registry>/<repository><tag>は:です。 たとえば、myregistry.azurecr.io/nginx:latest です。

AzureContainerRegistryLoginServer - レジストリ ログイン サーバー名
string. 省略可能。 の場合は ImageSource = invalidimagesourceを使用します。

Azure コンテナー レジストリ ログイン サーバー名を指定します。

AzureContainerRegistryImage - イメージ
string. ImageSource = AzureContainerRegistry の場合に必要です。

コンテナー イメージが格納されているリポジトリの名前。

注: 完全修飾イメージ名の形式<registry>/<repository><tag>は:です。 たとえば、 myregistry.azurecr.io/nginx:.latest

AzureContainerRegistryTag - タグ
string. 省略可能。 の場合は ImageSource = AzureContainerRegistryを使用します。

これは、レジストリが Docker イメージにバージョンを提供するために使用するメカニズムです。

注: 完全修飾イメージ名の形式<registry>/<repository><tag>は:です。 たとえば、 myregistry.azurecr.io/nginx:.latest

DockerRepositoryAccess - リポジトリ へのアクセス
string. ImageSource = invalidImage の場合に必要です。 使用できる値: private、public。 既定値: public。

Docker リポジトリへのアクセスを指定します。

dockerRegistryConnection - レジストリ接続
入力エイリアス: RegistryConnectedServiceName。 string. DockerRepositoryAccess = private || ImageSource = PrivateRegistry の場合に必要です。

レジストリ接続を指定します。

PrivateRegistryImage - イメージ
string. ImageSource = PrivateRegistry の場合に必要です。

コンテナー イメージが格納されているリポジトリの名前。

注: 完全修飾イメージ名の形式<registry><repository><tag>は:です。 たとえば、 myregistry.azurecr.io/nginx:.latest

PrivateRegistryTag - タグ
string. 省略可能。 の場合は ImageSource = PrivateRegistryを使用します。

タグは、レジストリが Docker イメージにバージョンを提供するために使用するメカニズムです。

注: 完全修飾イメージ名の形式は、'<registry>/<repository>:<tag>' になります。 たとえば、 myregistry.azurecr.io/nginx:.latest

DockerNamespace - レジストリまたは名前空間
string. WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registry の場合に必要です。

特定のレジストリまたは名前空間のグローバルに一意のトップレベル ドメイン名。

注: 完全修飾イメージ名の形式<registry or namespace>/<repository><tag>は:です。 たとえば、 myregistry.azurecr.io/nginx:.latest

DockerRepository - イメージ
string. WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registry の場合に必要です。

コンテナー イメージが格納されているリポジトリの名前。

注: 完全修飾イメージ名の形式は、'<registry or namespace>/<repository>: です。<tag> たとえば、 myregistry.azurecr.io/nginx:.latest

DockerImageTag - タグ
string. 省略可能。 の場合は WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registryを使用します。

これは、レジストリが Docker イメージにバージョンを提供するために使用するメカニズムです。

注: 完全修飾イメージ名は、'<registry or namespace>/<repository>:<tag>' という形式になります。 たとえば、 myregistry.azurecr.io/nginx:.latest

VirtualApplication - 仮想アプリケーション
string. 省略可能。 の場合は WebAppKind != linux && WebAppKind != applinux && WebAppKind != ""を使用します。

Azure portalで構成されている仮想アプリケーションの名前を指定します。 このオプションは、App Service ルートへのデプロイには必要ありません。

Package - パッケージまたはフォルダー
string. WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" の場合に必要です。 既定値: $(System.DefaultWorkingDirectory)/**/*.zip。

MSBuild または圧縮 zip または war ファイルによって生成されたアプリ サービスの内容を含むパッケージまたはフォルダーへのファイル パス。

変数は ビルド と リリースです。 ワイルドカードが サポートされています。

たとえば、$(System.DefaultWorkingDirectory)/\*\*/\*.zip または $(System.DefaultWorkingDirectory)/\*\*/\*.war です。

packageForLinux - パッケージまたはフォルダー
入力エイリアス: BuiltinLinuxPackage。 string. WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin の場合に必要です。 既定値: $(System.DefaultWorkingDirectory)/**/*.zip。

MSBuild または圧縮 zip または war ファイルによって生成されたアプリ サービスの内容を含むパッケージまたはフォルダーへのファイル パス。

変数は ビルド と リリースです。 ワイルドカードが サポートされています。

たとえば、$(System.DefaultWorkingDirectory)/\*\*/\*.zip または $(System.DefaultWorkingDirectory)/\*\*/\*.war です。

RuntimeStack - ランタイム スタック
string. WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin の場合に必要です。

フレームワークとバージョンを指定します。

StartupCommand - スタートアップ コマンド
string. 省略可能。 の場合は WebAppKind = applinux || WebAppKind = linuxを使用します。

スタートアップ コマンドを指定します。

WebAppUri - App Service URL
string. 省略可能。 の場合は WebAppKind != ""を使用します。

Azure App Serviceの URL に対して生成される出力変数の名前を指定します。 変数は、後続のタスクで使用できます。

ScriptType - デプロイ スクリプトの種類
string. 省略可能。 の場合は WebAppKind != ""を使用します。 使用できる値: Inline Script、 File Path (スクリプト ファイル パス)。

タスクが正常にデプロイを完了すると、Azure アプリ サービスで実行されるスクリプトを指定して、デプロイをカスタマイズします。 たとえば、Node、PHP、Python アプリケーションのパッケージを復元できます。 Azure App Serviceデプロイの詳細については、こちらを参照してください。

InlineScript - インライン スクリプト
string. ScriptType == Inline Script && WebAppKind != "" の場合に必要です。 既定値: :: You can provide your deployment commands here. One command per line.。

ScriptPath - デプロイ スクリプトのパス
string. ScriptType == File Path && WebAppKind != "" の場合に必要です。

GenerateWebConfig - Web.configの生成
boolean. 省略可能。 の場合は WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .warを使用します。 既定値: false。

標準Web.configが生成され、アプリケーションに存在しない場合はAzure App Serviceにデプロイされます。 の web.config 値は編集でき、アプリケーション フレームワークによって異なります。 たとえば、アプリケーションの node.js 場合、 web.config にはスタートアップ ファイルと iis_node モジュール値があります。 Azure App Serviceデプロイの詳細については、こちらを参照してください。

WebConfigParameters - パラメーターのWeb.config
string. GenerateWebConfig == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war の場合に必要です。

生成された web.config ファイル内のスタートアップ ファイルなどの値を編集します。 この編集機能は、生成された に対してのみ使用されます web.config。 Azure App Serviceデプロイの詳細については、こちらを参照してください。

AppSettings - アプリの設定
string.

構文 -key 値 に従って Web アプリ アプリケーションの設定を編集します。 値に空白が含まれる場合は、二重引用符で囲む必要があります。 例: -Port 5000-WEBSITE_TIME_ZONE-RequestTimeout 5000"Eastern Standard Time"。

ConfigurationSettings - 構成設定
string.

構文 -key 値に従って Web アプリの構成設定を編集します。 値に空白が含まれる場合は、二重引用符で囲む必要があります。

例: -phpVersion 5.6-linuxFxVersion: node|6.11。

TakeAppOfflineFlag - アプリをオフラインにする
boolean. 省略可能。 の場合は WebAppKind != linux && WebAppKind != applinux && WebAppKind != ""を使用します。 既定値: false。

同期操作を開始する前に、App Serviceのルート ディレクトリにファイルをapp_offline.htm配置してAzure App Serviceをオフラインにするには、このオプションを使用します。 同期が正常に完了すると、ファイルは削除されます。

UseWebDeploy - Web 配置を使用して発行する
boolean. 省略可能。 の場合は WebAppKind != linux && WebAppKind != applinux && WebAppKind != ""を使用します。 既定値: false。

Publish using Web Deploy オプションは、Windows エージェントを使用する場合にのみサポートされます。 他のプラットフォームでは、タスクは Kudu REST API を使用してAzure App Serviceをデプロイしますが、次のオプションはサポートされていません。

SetParametersFile - SetParameters ファイル
string. 省略可能。 の場合は UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != ""を使用します。

使用するファイルの SetParameters.xml 場所。

RemoveAdditionalFilesFlag - コピー先で追加のファイルを削除する
boolean. 省略可能。 の場合は UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != ""を使用します。 既定値: false。

App Service パッケージまたはフォルダーに一致するファイルがないAzure App Service上のファイルを削除するには、このオプションを使用します。

注: これにより、このAzure App Serviceにインストールされているすべての拡張機能に関連するすべてのファイルも削除されます。 これを防ぐには、チェック ボックスを Exclude files from App_Data folder オンにします。

ExcludeFilesFromAppDataFlag - App_Data フォルダーからファイルを除外する
boolean. 省略可能。 の場合は UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != ""を使用します。 既定値: false。

フォルダー内のファイルがApp_DataAzure App Serviceに対して展開または削除されないようにするには、このオプションを使用します。

AdditionalArguments - 追加の引数
string. 省略可能。 の場合は UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != ""を使用します。

構文 -key:valueに続く追加の Web 配置引数。

これらは、Azure App Service をデプロイするときに適用されます。 例: -disableLink:AppPoolExtension-disableLink:ContentExtension。

Web 配置操作の設定のその他の例を参照してください。

RenameFilesFlag - ロックされたファイルの名前を変更する
boolean. 省略可能。 の場合は UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != ""を使用します。 既定値: false。

このオプションを使用して、アプリケーション設定で msdeploy フラグMSDEPLOY_RENAME_LOCKED_FILES=1Azure App Service有効にします。 オプションを使用すると、msdeploy で、アプリのデプロイ中にロックされているロックされたファイルの名前を変更できます。

enableXmlTransform - XML 変換
入力エイリアス: XmlTransformation。 boolean. 省略可能。 の場合は WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .warを使用します。 既定値: false。

構成変換は、 と に対*.Release.config*.<EnvironmentName>.configして実行されます*.config file。

構成変換は、変数の置換の前に実行されます。

XML 変換は、Windows プラットフォーム向けにのみサポートされています。

enableXmlVariableSubstitution - XML 変数の置換
入力エイリアス: XmlVariableSubstitution。 boolean. 省略可能。 の場合は WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .warを使用します。 既定値: false。

ビルドまたはリリース パイプラインで定義されている変数は、任意の構成ファイルと の key 、、および セクションの appSettingsapplicationSettingsまたは name エントリとconnectionStrings照合parameters.xmlされます。 変数置換は、構成変換の後に実行されます。

注: リリース パイプラインと環境で同じ変数が定義されている場合、環境変数はリリース パイプライン変数よりも優先されます。

JSONFiles - JSON 変数の置換
string. 省略可能。 の場合は WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .warを使用します。

変数値を置き換える JSON ファイルの新しい行区切りリストを提供します。 ファイル名は、ルート フォルダーを基準にして指定されます。

入れ子または階層構造の JSON 変数を置き換える場合は、式を使用して JSONPath 指定します。

たとえば、次のサンプルの の ConnectionString 値を置き換えるには、ビルド/リリース パイプライン (またはリリース パイプラインの環境) のように変数 Data.DefaultConnection.ConnectionString を定義する必要があります。

{
  "Data": {
    "DefaultConnection": {
      "ConnectionString": "Server=(localdb)\SQLEXPRESS;Database=MyDB;Trusted_Connection=True"
    }
  }
}

変数置換は、構成変換の後に実行されます。

注: パイプライン変数は置換で除外されます。

タスク制御オプション

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

出力変数

[なし] :

解説

このタスクの新しいバージョンを使用できます。 詳細については、「 AzureRmWebAppDeployment@4」を参照してください。

トラブルシューティング

Windows エージェントからのMicrosoft Entra ID認証を使用してAzure App Serviceに Web 配置できない

Azure App Serviceデプロイ タスクでは、次の 3 つの条件がない限り、Microsoft Entra IDを使用した ARM サービス接続を使用した Microsoft Azure への接続がサポートされます。

• Windows エージェントで Web 配置パッケージ形式を使用している
• エージェントが以前のバージョンの msdeploy.exe で実行されている ( windows-2019 ホステッド エージェント イメージを使用する場合など)
• Azure App Serviceの基本認証が無効になっている

これら 3 つの条件が存在する場合は、次のようなエラーが表示されます App Service is configured to not use basic authentication. This requires Web Deploy msdeploy.exe version 7.1.7225.2108 or higher. You need a version of Visual Studio that includes an updated version of msdeploy.exe. For more information, visit https://aka.ms/azdo-webapp-msdeploy.

この問題を解決するには、優先順に次のオプションから選択できます。

1. エージェント イメージを更新します。 ホステッド エージェントを使用している場合は、 windows-2019 から windows-2022 (または windows-latest) に移行します。 セルフホステッド エージェントを使用している場合は、エージェントに Visual Studio 2022 をインストールして、新しいバージョンの msdeploy.exeを取得します。
2. 古いエージェント イメージに依存していて、パイプラインのエージェントを更新できない場合は、Azure App Serviceデプロイ タスクが windows-2022 (または windows-latest) で実行されるようにジョブを分割することを検討してください。
3. どちらのオプションも使用できない場合は、Azure App Serviceの基本認証を有効にすることができます。

要件

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