Web Apps - Get Workflow

Reference

Service:: App Service

API Version:: 2023-12-01

Get workflow information by its ID for web site, or a deployment slot.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows/{workflowName}?api-version=2023-12-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).
workflowName	path	True	string	Workflow name. Regex pattern: `^[a-z][a-z0-9]*$`
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	WorkflowEnvelope	Workflow information returned.
404 Not Found		Workflow with a name of {workflowName} does not exist.
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

GET a workflow

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows/stateful1?api-version=2023-12-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows/stateful1",
  "name": "testsite2/stateful1",
  "type": "Microsoft.Web/sites/workflows",
  "kind": "Stateful",
  "location": "USAAnywhere",
  "properties": {
    "files": {
      "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": {},
          "parameters": {},
          "triggers": {}
        }
      },
      "connections.json": {
        "managedApiConnections": {
          "office365": {
            "api": {
              "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/brazilsouth/managedApis/office365"
            },
            "connection": {
              "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/connections/office365-1"
            },
            "connectionRuntimeUrl": "string",
            "authentication": {
              "type": "Raw",
              "scheme": "Key",
              "parameter": "@appsetting('office365-connectionKey')"
            }
          }
        }
      }
    },
    "flowState": "Enabled",
    "health": {
      "state": "Healthy"
    }
  }
}

Status code:: 404

Definitions

Name	Description
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
ErrorEntity	Body of the error response returned from the API.
Properties	Additional workflow properties.
WorkflowEnvelope	Workflow properties definition.
WorkflowHealth	Represents the workflow health.
WorkflowHealthState	Gets or sets the workflow health state.
WorkflowState	The workflow state.

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.

ErrorEntity

Body of the error response returned from the API.

Name	Type	Description
code	string	Basic error code.
details	ErrorEntity[]	Error Details.
extendedCode	string	Type of error.
innerErrors	ErrorEntity[]	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	WorkflowState	Gets or sets the state of the workflow.
health	WorkflowHealth	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	Properties	Additional workflow properties.
type	string	Gets the resource type.

WorkflowHealth

Represents the workflow health.

Name	Type	Description
error	ErrorEntity	Gets or sets the workflow error.
state	WorkflowHealthState	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