Web Apps - Deploy Workflow Artifacts

Service:

App Service

API Version:

2024-04-01

Description for Creates the artifacts for web site, or a deployment slot.

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

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Site name.
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
appSettings	Object	Application settings of the workflow.
files	object	Files of the app.
filesToDelete	string[]	Files of the app to delete.

Responses

Name	Type	Description
200 OK		Artifacts deployed.
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

Examples

Delete workflow artifacts

Deploys workflow artifacts

Delete workflow artifacts

Sample request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/deployWorkflowArtifacts?api-version=2024-04-01

{
  "filesToDelete": [
    "test/workflow.json",
    "test/"
  ]
}

Sample response

Status code:

200

Deploys workflow artifacts

Sample request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/deployWorkflowArtifacts?api-version=2024-04-01

{
  "files": {
    "test1/workflow.json": {
      "definition": {
        "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
        "actions": {},
        "contentVersion": "1.0.0.0",
        "outputs": {},
        "triggers": {
          "When_events_are_available_in_Event_hub": {
            "inputs": {
              "parameters": {
                "eventHubName": "test123"
              },
              "serviceProviderConfiguration": {
                "connectionName": "eventHub",
                "operationId": "receiveEvents",
                "serviceProviderId": "/serviceProviders/eventHub"
              }
            },
            "splitOn": "@triggerOutputs()?['body']",
            "type": "ServiceProvider"
          }
        }
      },
      "kind": "Stateful"
    },
    "connections.json": {
      "serviceProviderConnections": {
        "eventHub": {
          "parameterValues": {
            "connectionString": "@appsetting('eventHub_connectionString')"
          },
          "serviceProvider": {
            "id": "/serviceProviders/eventHub"
          },
          "displayName": "example1"
        }
      },
      "managedApiConnections": {}
    }
  },
  "appSettings": {
    "eventHub_connectionString": "Endpoint=sb://example.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=EXAMPLE1a2b3c4d5e6fEXAMPLE="
  }
}

Sample response

Status code:

200

Definitions

Name	Description
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
Object
WorkflowArtifacts	The workflow filter.

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.

Object

WorkflowArtifacts

The workflow filter.

Name	Type	Description
appSettings	Object	Application settings of the workflow.
files	object	Files of the app.
filesToDelete	string[]	Files of the app to delete.