Web Apps - Create MS Deploy Operation

Description for Invoke the MSDeploy web app extension.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy?api-version=2024-04-01

URI Parameters

Name In Required Type Description
name
path True

string

Name of web app.

resourceGroupName
path True

string

Name of the resource group to which the resource belongs.

Regex pattern: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

api-version
query True

string

API Version

Request Body

Name Type Description
kind

string

Kind of resource.

properties.addOnPackages

array

List of Add-On packages. Add-On packages implicitly enable the Do Not Delete MSDeploy rule.

Responses

Name Type Description
201 Created

MSDeployStatus

Deployment is scheduled.

Other Status Codes

Another deployment is in progress.

Other Status Codes

DefaultErrorResponse

App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Definitions

Name Description
DefaultErrorResponse

App Service error response.

Details
Error

Error model.

MSDeploy

MSDeploy ARM PUT information

MSDeployProvisioningState

Provisioning state

MSDeployStatus

MSDeploy ARM response

DefaultErrorResponse

App Service error response.

Name Type Description
error

Error

Error model.

Details

Name Type Description
code

string

Standardized string to programmatically identify the error.

message

string

Detailed error description and debugging information.

target

string

Detailed error description and debugging information.

Error

Error model.

Name Type Description
code

string

Standardized string to programmatically identify the error.

details

Details[]

Detailed errors.

innererror

string

More information to debug error.

message

string

Detailed error description and debugging information.

target

string

Detailed error description and debugging information.

MSDeploy

MSDeploy ARM PUT information

Name Type Description
id

string

Resource Id.

kind

string

Kind of resource.

name

string

Resource Name.

properties.addOnPackages

array

List of Add-On packages. Add-On packages implicitly enable the Do Not Delete MSDeploy rule.

type

string

Resource type.

MSDeployProvisioningState

Provisioning state

Name Type Description
accepted

string

canceled

string

failed

string

running

string

succeeded

string

MSDeployStatus

MSDeploy ARM response

Name Type Description
id

string

Resource Id.

kind

string

Kind of resource.

name

string

Resource Name.

properties.complete

boolean

Whether the deployment operation has completed

properties.deployer

string

Username of deployer

properties.endTime

string

End time of deploy operation

properties.provisioningState

MSDeployProvisioningState

Provisioning state

properties.startTime

string

Start time of deploy operation

type

string

Resource type.