AzureRmWebAppDeployment@3: tarea de implementación de Azure App Service v3

Use esta tarea para implementar en Azure App Service una aplicación web, móvil o de API mediante Docker, Java, .NET, .NET Core, Node.js, PHP, Python o Ruby.

Nota

Use AzureFunctionApp@1 para implementar aplicaciones Azure Functions.

Syntax

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

Entradas

azureSubscription - Suscripción de Azure
Alias de entrada: ConnectedServiceName. string. Obligatorio.

Especifique la suscripción de Azure Resource Manager para la implementación.

appType - Tipo de aplicación
Alias de entrada: WebAppKind. string. Obligatorio. Valores permitidos: app (Aplicación web), applinux (Aplicación web de Linux), functionapp (Aplicación de funciones (no recomendado, Usar Azure Functions tarea)), api (aplicación de API), mobileapp (aplicación móvil). Valor predeterminado: app.

Especifique el tipo de aplicación web que se va a implementar.

Nota: Especifique Linux Web App para imágenes de plataforma integradas o implementaciones de imágenes de contenedor personalizadas.

WebAppName - nombre de App Service
string. Obligatorio.

Especifique el nombre de un Azure App Service existente. Los servicios de aplicaciones basados en el tipo de aplicación seleccionado solo se mostrarán al usar la tarea asistente.

DeployToSlotFlag - Implementación en ranura
boolean. Opcional. Use cuando WebAppKind != "". Valor predeterminado: false.

Use esta opción para realizar la implementación en una ranura existente que no sea la ranura de producción. Si esta opción no está seleccionada, el Azure App Service se implementará en el espacio de producción.

ResourceGroupName - Grupo de recursos
string. Necesario cuando DeployToSlotFlag = true.

Especifique el grupo de recursos de Azure que contiene el Azure App Service especificado anteriormente.

SlotName - Ranura
string. Necesario cuando DeployToSlotFlag = true.

Especifique una ranura existente que no sea la ranura de producción.

ImageSource - Origen de la imagen
string. Opcional. Use cuando WebAppKind = applinux || WebAppKind = linux. Valores permitidos: Registry (Container Registry), Builtin (imagen integrada). Valor predeterminado: Registry.

App Service en Linux ofrece dos opciones diferentes para publicar la aplicación:

Implementación de imágenes personalizadas o implementación de aplicaciones con una imagen de plataforma integrada.

AzureContainerRegistry - Registro
string. Necesario cuando ImageSource = AzureContainerRegistry.

Un nombre de dominio de nivel superior único global para su registro específico.

Nota: Un nombre de imagen completo tendrá el formato: <registry>/<repository>:.<tag> Por ejemplo, myregistry.azurecr.io/nginx:latest.

AzureContainerRegistryLoginServer - Nombre del servidor de inicio de sesión del Registro
string. Opcional. Use cuando ImageSource = invalidimagesource.

Especifique un nombre de servidor de inicio de sesión de Azure Container Registry.

AzureContainerRegistryImage - Imagen
string. Necesario cuando ImageSource = AzureContainerRegistry.

Nombre del repositorio donde se almacenan las imágenes de contenedor.

Nota: Un nombre de imagen completo tendrá el formato: <registry>/<repository>:.<tag> Por ejemplo, myregistry.azurecr.io/nginx:latest.

AzureContainerRegistryTag - Etiqueta
string. Opcional. Use cuando ImageSource = AzureContainerRegistry.

Este es el mecanismo que usan los registros para proporcionar una versión a las imágenes de Docker.

Nota: Un nombre de imagen completo tendrá el formato: <registry>/<repository>:.<tag> Por ejemplo, myregistry.azurecr.io/nginx:latest.

DockerRepositoryAccess - Acceso al repositorio
string. Necesario cuando ImageSource = invalidImage. Valores permitidos: private, public. Valor predeterminado: public.

Especifique el acceso al repositorio de Docker.

dockerRegistryConnection - Conexión del Registro
Alias de entrada: RegistryConnectedServiceName. string. Necesario cuando DockerRepositoryAccess = private || ImageSource = PrivateRegistry.

Especifique la conexión del Registro.

PrivateRegistryImage - Imagen
string. Necesario cuando ImageSource = PrivateRegistry.

Nombre del repositorio donde se almacenan las imágenes de contenedor.

Nota: Un nombre de imagen completo tendrá el formato: <registry><repository>:<tag>. Por ejemplo, myregistry.azurecr.io/nginx:latest.

PrivateRegistryTag - Etiqueta
string. Opcional. Use cuando ImageSource = PrivateRegistry.

Las etiquetas son el mecanismo que usan los registros para proporcionar una versión a las imágenes de Docker.

Nota: Un nombre de imagen completo tendrá el formato : '<registry>/<repository>:<tag>'. Por ejemplo, myregistry.azurecr.io/nginx:latest.

DockerNamespace - Registro o espacio de nombres
string. Necesario cuando WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registry.

Un nombre de dominio de nivel superior único global para su registro o espacio de nombres específico.

Nota: Un nombre de imagen completo tendrá el formato: <registry or namespace>/<repository>:.<tag> Por ejemplo, myregistry.azurecr.io/nginx:latest.

DockerRepository - Imagen
string. Necesario cuando WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registry.

Nombre del repositorio donde se almacenan las imágenes de contenedor.

Nota: Un nombre de imagen completo tendrá el formato :<registry or namespace>/<repository>:.<tag> Por ejemplo, myregistry.azurecr.io/nginx:latest.

DockerImageTag - Etiqueta
string. Opcional. Use cuando WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registry.

Este es el mecanismo que usan los registros para proporcionar a las imágenes de Docker una versión.

Nota: Un nombre de imagen completo tendrá el formato : "<registry or namespace>/<repository>:".<tag> Por ejemplo, myregistry.azurecr.io/nginx:latest.

VirtualApplication - Aplicación virtual
string. Opcional. Use cuando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "".

Especifique el nombre de la aplicación virtual que se ha configurado en el Azure Portal. La opción no es necesaria para las implementaciones en la raíz de App Service.

Package - Paquete o carpeta
string. Necesario cuando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Valor predeterminado: $(System.DefaultWorkingDirectory)/**/*.zip.

Ruta de acceso del archivo al paquete o una carpeta que contiene el contenido de App Service generado por MSBuild o un archivo zip o war comprimido.

Las variables son Build y Release. Se admiten caracteres comodín.

Por ejemplo, $(System.DefaultWorkingDirectory)/\*\*/\*.zip o $(System.DefaultWorkingDirectory)/\*\*/\*.war.

packageForLinux - Paquete o carpeta
Alias de entrada: BuiltinLinuxPackage. string. Necesario cuando WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin. Valor predeterminado: $(System.DefaultWorkingDirectory)/**/*.zip.

Ruta de acceso del archivo al paquete o una carpeta que contiene el contenido de App Service generado por MSBuild o un archivo zip o war comprimido.

Las variables son Build y Release. Se admiten caracteres comodín.

Por ejemplo, $(System.DefaultWorkingDirectory)/\*\*/\*.zip o $(System.DefaultWorkingDirectory)/\*\*/\*.war.

RuntimeStack - Pila en tiempo de ejecución
string. Necesario cuando WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin.

Especifique el marco y la versión.

StartupCommand - Comando de inicio
string. Opcional. Use cuando WebAppKind = applinux || WebAppKind = linux.

Especifique el comando de inicio.

WebAppUri - dirección URL de App Service
string. Opcional. Use cuando WebAppKind != "".

Especifique un nombre para la variable de salida que se genera para la dirección URL del Azure App Service. La variable se puede usar en tareas posteriores.

ScriptType - Tipo de script de implementación
string. Opcional. Use cuando WebAppKind != "". Valores permitidos: Inline Script, File Path (ruta de acceso del archivo de script).

Personaliza la implementación proporcionando un script que se ejecutará en el servicio App de Azure una vez que la tarea haya completado la implementación correctamente. Por ejemplo, esto puede restaurar paquetes para aplicaciones node, PHP y Python. Obtenga más información sobre la implementación de Azure App Service.

InlineScript - Script insertado
string. Necesario cuando ScriptType == Inline Script && WebAppKind != "". Valor predeterminado: :: You can provide your deployment commands here. One command per line..

ScriptPath - Ruta de acceso del script de implementación
string. Necesario cuando ScriptType == File Path && WebAppKind != "".

GenerateWebConfig - Generación de Web.config
boolean. Opcional. Use cuando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Valor predeterminado: false.

Se generará e implementará un estándar Web.config en Azure App Service si la aplicación no tiene una. Los valores de web.config se pueden editar y variar en función del marco de trabajo de la aplicación. Por ejemplo, para la node.js aplicación, web.config tendrá valores de archivo de inicio y iis_node módulo. Obtenga más información sobre la implementación de Azure App Service.

WebConfigParameters - parámetros deWeb.config
string. Necesario cuando GenerateWebConfig == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war.

Edita valores como archivos de inicio en el archivo generado web.config . Esta característica de edición solo es para el objeto generado web.config. Obtenga más información sobre la implementación de Azure App Service.

AppSettings - Configuración de la aplicación
string.

Edita la configuración de la aplicación web siguiendo la sintaxis -key value . Los valores que contienen espacios deben ir entre comillas dobles. Ejemplos: -Port 5000-RequestTimeout 5000-WEBSITE_TIME_ZONE"Eastern Standard Time".

ConfigurationSettings - Configuración
string.

Edita las opciones de configuración de la aplicación web siguiendo el valor de sintaxis -key . Los valores que contienen espacios deben ir entre comillas dobles.

Ejemplos: -phpVersion 5.6-linuxFxVersion: node|6.11.

TakeAppOfflineFlag - Desconectar la aplicación
boolean. Opcional. Use cuando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Valor predeterminado: false.

Use esta opción para desconectar el Azure App Service colocando un app_offline.htm archivo en el directorio raíz del App Service antes de que comience la operación de sincronización. El archivo se quitará después de que la sincronización se complete correctamente.

UseWebDeploy - Publicación mediante Web Deploy
boolean. Opcional. Use cuando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Valor predeterminado: false.

Publish using Web Deploy Las opciones solo se admiten cuando se usa el agente de Windows. En otras plataformas, la tarea se basa en las API REST de Kudu para implementar el Azure App Service y no se admiten las siguientes opciones.

SetParametersFile - Archivo SetParameters
string. Opcional. Use cuando UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "".

Ubicación del SetParameters.xml archivo que se va a usar.

RemoveAdditionalFilesFlag - Eliminación de archivos adicionales en el destino
boolean. Opcional. Use cuando UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Valor predeterminado: false.

Use esta opción para eliminar archivos de la Azure App Service que no tengan archivos coincidentes en el paquete o la carpeta App Service.

Nota: Esto también quitará todos los archivos relacionados con cualquier extensión instalada en este Azure App Service. Para evitar esto, active la Exclude files from App_Data folder casilla.

ExcludeFilesFromAppDataFlag - Exclusión de archivos de la carpeta App_Data
boolean. Opcional. Use cuando UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Valor predeterminado: false.

Use esta opción para evitar que los archivos de la App_Data carpeta se implementen o eliminen del Azure App Service.

AdditionalArguments - Argumentos adicionales
string. Opcional. Use cuando UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "".

Los argumentos adicionales de Web Deploy que siguen la sintaxis -key:value.

Se aplicarán al implementar Azure App Service. Ejemplos: -disableLink:AppPoolExtension-disableLink:ContentExtension.

Vea más ejemplos de Configuración de la operación de implementación web.

RenameFilesFlag - Cambiar el nombre de los archivos bloqueados
boolean. Opcional. Use cuando UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Valor predeterminado: false.

Use esta opción para habilitar la marca MSDEPLOY_RENAME_LOCKED_FILES=1 msdeploy en Azure App Service configuración de la aplicación. La opción permite a msdeploy cambiar el nombre de los archivos bloqueados que están bloqueados durante la implementación de la aplicación.

enableXmlTransform - Transformación XML
Alias de entrada: XmlTransformation. boolean. Opcional. Use cuando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Valor predeterminado: false.

Las transformaciones de configuración se ejecutarán para *.Release.config y *.<EnvironmentName>.config en .*.config file

Las transformaciones de configuración se ejecutarán antes de la sustitución de variables.

Las transformaciones XML solo se admiten para la plataforma Windows.

enableXmlVariableSubstitution - Sustitución de variables XML
Alias de entrada: XmlVariableSubstitution. boolean. Opcional. Use cuando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Valor predeterminado: false.

Las variables definidas en la canalización de compilación o versión coincidirán con las entradas o name de las appSettingssecciones , applicationSettingsy connectionStrings de cualquier archivo de configuración y parameters.xml.key La sustitución de variables se ejecuta después de las transformaciones de configuración.

Nota: Si las mismas variables se definen en la canalización de versión y en el entorno, las variables de entorno reemplazarán las variables de canalización de versión.

JSONFiles - Sustitución de variables JSON
string. Opcional. Use cuando WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war.

Proporciona una nueva lista separada por líneas de archivos JSON para sustituir los valores de variable. Los nombres de los archivos se deben proporcionar en relación con la carpeta raíz.

Para sustituir variables JSON anidadas o jerárquicas, especifíquelas mediante JSONPath expresiones.

Por ejemplo, para reemplazar el valor de ConnectionString en el ejemplo siguiente, debe definir una variable como Data.DefaultConnection.ConnectionString en la canalización de compilación o versión (o el entorno de la canalización de versión).

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

La sustitución de variables se ejecuta después de las transformaciones de configuración.

Nota: Las variables de canalización se excluyen en sustitución.

Opciones de control de tareas

Todas las tareas tienen opciones de control además de las entradas de tareas. Para obtener más información, vea Opciones de control y propiedades de tareas comunes.

Variables de salida

Ninguno.

Comentarios

Hay disponible una versión más reciente de esta tarea. Para obtener más información, consulte AzureRmWebAppDeployment@4.

Solución de problemas

No puedo realizar la implementación web en mi Azure App Service mediante Microsoft Entra ID autenticación desde mi agente de Windows

La tarea de implementación de Azure App Service admite la conexión a Microsoft Azure con una conexión de servicio arm mediante Microsoft Entra ID, a menos que estén presentes las tres condiciones siguientes:

• Usa el formato de paquete web Deploy en un agente de Windows.
• El agente se ejecuta con una versión anterior de msdeploy.exe (por ejemplo, al usar la imagen del agente hospedado de windows-2019 ).
• La autenticación básica está deshabilitada para la Azure App Service

Si estas tres condiciones están presentes, recibirá un error como 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.

Para resolver este problema, puede elegir entre las siguientes opciones, en orden de preferencia.

1. Actualice la imagen del agente. Si usa agentes hospedados, pase de windows-2019 a windows-2022 (o windows-latest). Si usa agentes autohospedados, instale Visual Studio 2022 en el agente para obtener una versión más reciente de msdeploy.exe.
2. Si depende de una imagen de agente anterior y no puede actualizar el agente de la canalización, considere la posibilidad de dividir el trabajo para que la tarea de implementación de Azure App Service se ejecute en windows-2022 (o windows-latest).
3. Si ninguna de estas opciones es posible, puede habilitar la autenticación básica para la Azure App Service.

Requisitos

Requisito	Descripción
Tipos de canalización	YAML, compilación clásica, versión clásica
Se ejecuta en	Agente, DeploymentGroup
Peticiones	None
Capabilities	Esta tarea no satisface ninguna demanda de tareas posteriores en el trabajo.
Restricciones de comandos	Any
Variables que se pueden establecer	Any
Versión del agente	2.104.1 o superior
Categoría de la tarea:	Implementación