Web Apps - List Workflows
List the workflows for a web site, or a deployment slot.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows?api-version=2024-04-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
name
|
path | True |
string |
Site name. |
resource
|
path | True |
string |
Name of the resource group to which the resource belongs. Regex pattern: |
subscription
|
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 |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Workflow information returned. |
|
Other Status Codes |
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
List the workflows
Sample request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows?api-version=2024-04-01
Sample response
{
"value": [
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows/a1",
"name": "testsite2/a1",
"type": "Microsoft.Web/sites/workflows",
"location": "USAAnywhere",
"kind": "Stateful",
"properties": {
"flowState": "Enabled",
"health": {
"state": "Healthy"
}
}
},
{
"id": "/subscriptions/testsub/resourceGroups/testrg/providers/Microsoft.Web/sites/testsite2/workflows/stateful2",
"name": "testsite2/stateful2",
"type": "Microsoft.Web/sites/workflows",
"location": "USAAnywhere",
"kind": "Stateful",
"properties": {
"flowState": "Enabled",
"health": {
"state": "Unhealthy",
"error": {
"code": "InvalidWorkflowJson",
"message": "Invalid character after parsing property name. Expected ':' but got: \". Path '', line 2, position 2."
}
}
}
}
],
"nextLink": null
}
Definitions
Name | Description |
---|---|
Default |
App Service error response. |
Details | |
Error |
Error model. |
Error |
Body of the error response returned from the API. |
Properties |
Additional workflow properties. |
Workflow |
Workflow properties definition. |
Workflow |
Collection of Kudu workflow information elements. |
Workflow |
Represents the workflow health. |
Workflow |
Gets or sets the workflow health state. |
Workflow |
The workflow state. |
DefaultErrorResponse
App Service error response.
Name | Type | Description |
---|---|---|
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. |
ErrorEntity
Body of the error response returned from the API.
Name | Type | Description |
---|---|---|
code |
string |
Basic error code. |
details |
Error Details. |
|
extendedCode |
string |
Type of error. |
innerErrors |
Inner errors. |
|
message |
string |
Any details of the error. |
messageTemplate |
string |
Message template. |
parameters |
string[] |
Parameters for the template. |
target |
string |
The error target. |
Properties
Additional workflow properties.
Name | Type | Description |
---|---|---|
files |
object |
Gets or sets the files. |
flowState |
Gets or sets the state of the workflow. |
|
health |
Gets or sets workflow health. |
WorkflowEnvelope
Workflow properties definition.
Name | Type | Description |
---|---|---|
id |
string |
The resource id. |
kind |
string |
The resource kind. |
location |
string |
The resource location. |
name |
string |
Gets the resource name. |
properties |
Additional workflow properties. |
|
type |
string |
Gets the resource type. |
WorkflowEnvelopeCollection
Collection of Kudu workflow information elements.
Name | Type | Description |
---|---|---|
nextLink |
string |
Link to next page of resources. |
value |
Collection of resources. |
WorkflowHealth
Represents the workflow health.
Name | Type | Description |
---|---|---|
error |
Gets or sets the workflow error. |
|
state |
Gets or sets the workflow health state. |
WorkflowHealthState
Gets or sets the workflow health state.
Name | Type | Description |
---|---|---|
Healthy |
string |
|
NotSpecified |
string |
|
Unhealthy |
string |
|
Unknown |
string |
WorkflowState
The workflow state.
Name | Type | Description |
---|---|---|
Completed |
string |
|
Deleted |
string |
|
Disabled |
string |
|
Enabled |
string |
|
NotSpecified |
string |
|
Suspended |
string |