Share via

Workflows - Validate

Service:
Logic Apps
API Version:
2016-06-01

Validates the workflow definition.

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

URI Parameters

Name In Required Type Description
location
 path True

string

The workflow location.
resourceGroupName
 path True

string

The resource group name.
subscriptionId
 path True

string

The subscription id.
workflowName
 path True

string

The workflow name.
api-version
 query True

string

The API version.

Request Body

Name Type Description
location

string

The resource location.
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.sku

Sku

The sku.
properties.state

WorkflowState

The state.
tags

object

The resource tags.

Responses

Name Type Description
200 OK

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

Validate a workflow

Sample request

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

{
  "properties": {}
}

Sample response

Status code:
200

Definitions

Name Description
Object
ParameterType
ResourceReference

The resource reference.
Sku

The sku type.
SkuName

The sku name.
Workflow

The workflow type.
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.

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