Web Apps - Get Workflow

Service:: App Service

API Version:: 2025-05-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=2025-05-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Site name.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
workflowName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	Workflow name.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	WorkflowEnvelope	Azure operation completed successfully.
404 Not Found		The server cannot find the requested resource.
Other Status Codes	DefaultErrorResponse	An unexpected 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

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


/**
 * Samples for WebApps GetWorkflow.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/GetWorkflow.json
     */
    /**
     * Sample code: GET a workflow.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void gETAWorkflow(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        manager.serviceClient().getWebApps().getWorkflowWithResponse("testrg123", "testsite2", "stateful1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v6"
)

// Generated from example definition: 2025-05-01/GetWorkflow.json
func ExampleWebAppsClient_GetWorkflow() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebAppsClient().GetWorkflow(ctx, "testrg123", "testsite2", "stateful1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armappservice.WebAppsClientGetWorkflowResponse{
	// 	WorkflowEnvelope: &armappservice.WorkflowEnvelope{
	// 		Name: to.Ptr("testsite2/stateful1"),
	// 		Type: to.Ptr("Microsoft.Web/sites/workflows"),
	// 		ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows/stateful1"),
	// 		Kind: to.Ptr("Stateful"),
	// 		Location: to.Ptr("USAAnywhere"),
	// 		Properties: &armappservice.WorkflowEnvelopeProperties{
	// 			Files: map[string]any{
	// 				"connections.json": map[string]any{
	// 					"managedApiConnections": map[string]any{
	// 						"office365": map[string]any{
	// 							"api": map[string]any{
	// 								"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/brazilsouth/managedApis/office365",
	// 							},
	// 							"authentication": map[string]any{
	// 								"type": "Raw",
	// 								"parameter": "@appsetting('office365-connectionKey')",
	// 								"scheme": "Key",
	// 							},
	// 							"connection": map[string]any{
	// 								"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/connections/office365-1",
	// 							},
	// 							"connectionRuntimeUrl": "string",
	// 						},
	// 					},
	// 				},
	// 				"workflow.json": map[string]any{
	// 					"definition": map[string]any{
	// 						"$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
	// 						"actions": map[string]any{
	// 						},
	// 						"contentVersion": "1.0.0.0",
	// 						"outputs": map[string]any{
	// 						},
	// 						"parameters": map[string]any{
	// 						},
	// 						"triggers": map[string]any{
	// 						},
	// 					},
	// 				},
	// 			},
	// 			FlowState: to.Ptr(armappservice.WorkflowStateEnabled),
	// 			Health: &armappservice.WorkflowHealth{
	// 				State: to.Ptr(armappservice.WorkflowHealthStateHealthy),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

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

Status code:: 404

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DefaultErrorResponse	App Service error response.
DefaultErrorResponseError	Error model.
DefaultErrorResponseErrorDetailsItem	Detailed errors.
ErrorEntity	Body of the error response returned from the API.
systemData	Metadata pertaining to creation and last modification of the resource.
WorkflowEnvelope	Workflow properties definition.
WorkflowEnvelopeProperties	Additional workflow properties.
WorkflowHealth	Represents the workflow health.
WorkflowHealthState	Gets or sets the workflow health state.
WorkflowState	The workflow state.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Object

App Service error response.

Name	Type	Description
error	DefaultErrorResponseError	Error model.

DefaultErrorResponseError

Object

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	DefaultErrorResponseErrorDetailsItem[]	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.

DefaultErrorResponseErrorDetailsItem

Object

Detailed errors.

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.

ErrorEntity

Object

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.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

WorkflowEnvelope

Object

Workflow properties definition.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	The resource kind.
location	string	The resource location.
name	string	The name of the resource
properties	WorkflowEnvelopeProperties	Additional workflow properties.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

WorkflowEnvelopeProperties

Object

Additional workflow properties.

Name	Type	Description
files		Gets or sets the files.
flowState	WorkflowState	Gets or sets the state of the workflow.
health	WorkflowHealth	Gets or sets workflow health.

WorkflowHealth

Object

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

Enumeration

Gets or sets the workflow health state.

Value	Description
NotSpecified
Healthy
Unhealthy
Unknown

WorkflowState

Enumeration

The workflow state.

Value	Description
NotSpecified
Completed
Enabled
Disabled
Deleted
Suspended

Share via

Web Apps - Get Workflow

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

GET a workflow

Sample request

Sample response

Definitions

createdByType

DefaultErrorResponse

DefaultErrorResponseError

DefaultErrorResponseErrorDetailsItem

ErrorEntity

systemData

WorkflowEnvelope

WorkflowEnvelopeProperties

WorkflowHealth

WorkflowHealthState

WorkflowState