Workflows - List By Resource Group

Service:

Logic Apps

API Version:

2016-06-01

Gets a list of workflows by resource group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows?api-version=2016-06-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows?api-version=2016-06-01&$top={$top}&$filter={$filter}

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The resource group name.
subscriptionId	path	True	string	The subscription id.
api-version	query	True	string	The API version.
$filter	query		string	The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId.
$top	query		integer (int32)	The number of items to be included in the result.

Responses

Name	Type	Description
200 OK	WorkflowListResult	OK

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 all workflows in a resource group

Sample request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows?api-version=2016-06-01

Sample response

Status code:

200

{
  "value": [
    {
      "properties": {
        "provisioningState": "Succeeded",
        "createdTime": "2018-04-25T01:39:21.4365247Z",
        "changedTime": "2018-08-09T22:54:54.3533634Z",
        "state": "Enabled",
        "version": "08586677515911718341",
        "accessEndpoint": "http://tempuri.org",
        "integrationAccount": {
          "name": "test-integration-account",
          "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/integrationAccounts/test-integration-account",
          "type": "Microsoft.Logic/integrationAccounts"
        },
        "definition": {
          "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
          "contentVersion": "1.0.0.0",
          "parameters": {},
          "triggers": {},
          "actions": {},
          "outputs": {}
        },
        "parameters": {}
      },
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow",
      "name": "test-workflow",
      "type": "Microsoft.Logic/workflows",
      "location": "brazilsouth",
      "tags": {}
    }
  ]
}

Definitions

Name	Description
Object
ParameterType
ResourceReference	The resource reference.
Sku	The sku type.
SkuName	The sku name.
Workflow	The workflow type.
WorkflowListResult	The list of workflows.
WorkflowParameter	The workflow parameters.
WorkflowProvisioningState
WorkflowState

Object

Object

ParameterType

Enumeration

Value	Description
NotSpecified
String
SecureString
Int
Float
Bool
Array
Object
SecureObject

ResourceReference

Object

The resource reference.

Name	Type	Description
id	string	The resource id.
name	string	Gets the resource name.
type	string	Gets the resource type.

Sku

Object

The sku type.

Name	Type	Description
name	SkuName	The name.
plan	ResourceReference	The reference to plan.

SkuName

Enumeration

The sku name.

Value	Description
NotSpecified
Free
Shared
Basic
Standard
Premium

Workflow

Object

The workflow type.

Name	Type	Description
id	string	The resource id.
location	string	The resource location.
name	string	Gets the resource name.
properties.accessEndpoint	string	Gets the access endpoint.
properties.changedTime	string (date-time)	Gets the changed time.
properties.createdTime	string (date-time)	Gets the created time.
properties.definition	Object	The definition. See Schema reference for Workflow Definition Language in Azure Logic Apps.
properties.integrationAccount	ResourceReference	The integration account.
properties.parameters	<string,  WorkflowParameter>	The parameters.
properties.provisioningState	WorkflowProvisioningState	Gets the provisioning state.
properties.sku	Sku	The sku.
properties.state	WorkflowState	The state.
properties.version	string	Gets the version.
tags	object	The resource tags.
type	string	Gets the resource type.

WorkflowListResult

Object

The list of workflows.

Name	Type	Description
nextLink	string	The URL to get the next set of results.
value	Workflow[]	The list of workflows.

WorkflowParameter

Object

The workflow parameters.

Name	Type	Description
description	string	The description.
metadata	Object	The metadata.
type	ParameterType	The type.
value	Object	The value.

WorkflowProvisioningState

Enumeration

Value	Description
NotSpecified
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Moving
Updating
Registering
Registered
Unregistering
Unregistered
Completed

WorkflowState

Enumeration

Value	Description
NotSpecified
Completed
Enabled
Disabled
Deleted
Suspended