Freigeben über

AzureAppServiceSettings@1 – Azure App Service Einstellungen v1-Aufgabe

  • Artikel

Aktualisierungen oder fügt App Service-Einstellungen in einer Azure-Web-App für Linux oder Windows hinzu.

Syntax

# 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.

Eingaben

azureSubscription - Azure-Abonnement
Eingabealias: ConnectedServiceName. string. Erforderlich.

Wählt das Azure Resource Manager-Abonnement aus.


appName - App Service Name
string. Erforderlich.

Gibt den Namen einer vorhandenen Azure App Service ein oder wählt diese aus.


resourceGroupName - Ressourcengruppe
string. Erforderlich.

Gibt die Azure-Ressourcengruppe ein, die die oben angegebene Azure App Service enthält, oder wählt sie aus.


slotName - Slot
string. Standardwert. production.

Gibt einen vorhandenen Slot ein oder wählt diese aus. Wenn Sie keinen Slot auswählen, werden Änderungen an der Produktion vorgenommen.


appSettings - App-Einstellungen
string.

Anwendungseinstellungen in der JSON-Syntax. Schließen Sie Werte, die Leerzeichen enthalten, in doppelte Anführungszeichen ein. Weitere Informationen finden Sie unter Konfigurieren von App-Einstellungen.

Es folgt ein Beispiel für die JSON-Syntax:

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

generalSettings - Allgemeine Einstellungen
string.

Allgemeine Einstellungen in der JSON-Syntax. Schließen Sie Werte, die Leerzeichen enthalten, in doppelte Anführungszeichen ein. Eine Liste der verfügbaren Eigenschaften finden Sie in der Dokumentation App Service SiteConfig-Objekt. Weitere Informationen finden Sie unter Konfigurieren allgemeiner Einstellungen.

Es folgt ein Beispiel für die JSON-Syntax:

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

connectionStrings - Verbindungszeichenfolgen
string.

Verbindungszeichenfolgen in JSON-Syntax. Schließen Sie Werte, die Leerzeichen enthalten, in doppelte Anführungszeichen ein. Weitere Informationen finden Sie unter Konfigurieren von Verbindungszeichenfolgen.

Es folgt ein Beispiel für die JSON-Syntax:

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

Aufgabensteuerungsoptionen

Alle Aufgaben verfügen zusätzlich zu den Aufgabeneingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerungsoptionen und allgemeine Aufgabeneigenschaften.

Ausgabevariablen

Keine.

Hinweise

Verwenden Sie diese Aufgabe, um App-Einstellungen, Verbindungszeichenfolgen und andere allgemeine Einstellungen massenweise mithilfe der JSON-Syntax in Ihrer Web-App oder einem ihrer Bereitstellungsslots zu konfigurieren. Die Aufgabe funktioniert auf plattformübergreifenden Azure Pipelines-Agents unter Windows, Linux oder Mac. Die Aufgabe funktioniert für ASP.NET-, ASP.NET Core-, PHP-, Java-, Python-, Go- und Node.js-basierte Webanwendungen.

Beispiele

Der folgende YAML-Beispielausschnitt stellt eine Webanwendung in einem Azure-Web-App-Dienst bereit, der unter Windows ausgeführt wird.


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
        }
      ]

Anforderungen

Anforderung BESCHREIBUNG
Pipelinetypen YAML, Klassischer Build, klassische Version
Wird ausgeführt auf Agent, DeploymentGroup
Forderungen Keine
Capabilities Diese Aufgabe erfüllt keine Anforderungen an nachfolgende Aufgaben im Auftrag.
Befehlseinschränkungen Any
Einstellbare Variablen Any
Agent-Version 2.104.1 oder höher
Aufgabenkategorie Bereitstellen