AzureAppServiceSettings@1 - Azure App Service設定 v1 タスク

  • [アーティクル]

Azure Web App for Linux または Windows でアプリ サービス設定を更新または追加します。

構文

# Azure App Service Settings v1
# Update/Add App settings an Azure Web App for Linux or Windows.
- task: AzureAppServiceSettings@1
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    appName: # string. Required. App Service name. 
    resourceGroupName: # string. Required. Resource group. 
    #slotName: 'production' # string. Slot. Default: production.
  # Application and Configuration Settings
    #appSettings: # string. App settings. 
    #generalSettings: # string. General settings. 
    #connectionStrings: # string. Connection Strings.

入力

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

Azure Resource Manager サブスクリプションを選択します。


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

既存のAzure App Serviceの名前を入力または選択します。


resourceGroupName - リソース グループ
string. 必須です。

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


slotName - スロット
string. 既定値: production。

既存のスロットを入力または選択します。 スロットを選択しない場合は、運用環境に変更が加わります。


appSettings - アプリの設定
string.

JSON 構文のアプリケーション設定。 スペースを含む値を二重引用符で囲みます。 詳細については、「アプリ設定の構成」を参照してください。

JSON 構文の例を次に示します。

[
   {
    "name": "key1",
    "value": "valueabcd",
    "slotSetting": false
   },
   {
    "name": "key2",
    "value": "valueefgh",
    "slotSetting": true
   }
]

generalSettings - 全般設定
string.

JSON 構文の一般的な設定。 スペースを含む値を二重引用符で囲みます。 使用可能なプロパティの一覧については、App Service SiteConfig オブジェクトのドキュメントを参照してください。 詳細については、「 全般設定の構成」を参照してください。

JSON 構文の例を次に示します。

[
   {
    "alwaysOn": true,
    "webSocketsEnabled": false
   }
]

connectionStrings - 接続文字列
string.

JSON 構文の接続文字列。 スペースを含む値を二重引用符で囲みます。 詳細については、「接続文字列の構成」を参照してください。

JSON 構文の例を次に示します。

[
   {
    "name": "key1",
    "value": "valueabcd",
    "type": "MySql",
    "slotSetting": false
   },
   {
    "name": "key2",
    "value": "valueefgh",
    "type": "Custom",
    "slotSetting": true
   }
]

タスク コントロールのオプション

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

出力変数

[なし] :

解説

このタスクを使用して、Web アプリまたはそのデプロイ スロットの JSON 構文を使用して、アプリ設定、接続文字列、その他の一般的な設定を一括で構成します。 このタスクは、Windows、Linux、または Mac を実行しているクロスプラットフォームの Azure Pipelines エージェントで動作します。 このタスクは、ASP.NET、ASP.NET Core、PHP、Java、Python、Go、Node.js ベースの Web アプリケーションに対して機能します。

例

次の YAML スニペットの例では、Windows で実行されている Azure Web App サービスに Web アプリケーションをデプロイします。


variables:
  azureSubscription: Contoso
  WebApp_Name: sampleWebApp
  # To ignore SSL error uncomment the below variable
  # VSTS_ARM_REST_IGNORE_SSL_ERRORS: true

steps:

- task: AzureWebApp@1
  displayName: Azure Web App Deploy
  inputs:
    azureSubscription: $(azureSubscription)
    appName: $(WebApp_Name)
    package: $(System.DefaultWorkingDirectory)/**/*.zip

- task: AzureAppServiceSettings@1
  displayName: Azure App Service Settings
  inputs:
    azureSubscription: $(azureSubscription)
    appName: $(WebApp_Name)
   # To deploy the settings on a slot, provide slot name as below. By default, the settings would be applied to the actual Web App (Production slot)
   # slotName: staging
    appSettings: |
      [
        {
          "name": "APPINSIGHTS_INSTRUMENTATIONKEY",
          "value": "$(Key)",
          "slotSetting": false
        },
        {
          "name": "MYSQL_DATABASE_NAME",
          "value": "$(DB_Name)", 
          "slotSetting": false
        }
      ]
    generalSettings: |
      [
        {
          "alwaysOn": true,
          "webSocketsEnabled": false
        }
      ]
    connectionStrings: |
      [
        {
          "name": "MysqlCredentials",
          "value": "$(MySQl_ConnectionString)",
          "type": "MySql",
          "slotSetting": false
        }
      ]

要件

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