Create Azure Web App target command

Last updated 2023-03-28T15:04:13.0560386+00:00

Azure Web App

Command: New-OctopusAzureWebAppTarget

Parameter	Value
`-name`	name for the Octopus deployment target
`-azureWebApp`	Name of the Azure Web App
`-azureWebAppSlot`	Name of the Azure Web App Slot
`-azureResourceGroupName`	Name of the Azure Resource Group
`-octopusAccountIdOrName`	Name or Id of the Account Resource in Octopus
`-octopusRoles`	Comma separated list of Roles to assign
`-updateIfExisting`	Will update an existing Web App target with the same name, create if it doesn't exist
`-octopusDefaultWorkerPoolIdOrName`	Name or Id of the Worker Pool for the deployment target to use. (Optional). Added in 2020.6.0.

Examples

# Using default options
New-OctopusAzureWebAppTarget -name "My Azure Web Application" `
                             -azureWebApp "WebApp1" `
                             -azureResourceGroupName "WebApp1-ResourceGroup"  `
                             -octopusAccountIdOrName "Dev Azure Account" `
                             -octopusRoles "AzureWebApp" `
                             -updateIfExisting

# Specifying a default worker pool for the target
New-OctopusAzureWebAppTarget -name "My Azure Web Application" `
                             -azureWebApp "WebApp1" `
                             -azureResourceGroupName "WebApp1-ResourceGroup"  `
                             -octopusAccountIdOrName "Dev Azure Account" `
                             -octopusRoles "AzureWebApp" `
                             -octopusDefaultWorkerPoolIdOrName "Worker Pool with Azure Access" `
                             -updateIfExisting

If your process creates dynamic deployment targets from a script, and then deploys to those targets in a subsequent step, make sure you add a full health check step for the role of the newly created targets after the step that creates and registers the targets.

This allows Octopus to ensure the new targets are ready for deployment by staging packages required by subsequent steps that perform the deployment.

Need support? We're here to help.