Workflows

Create Or Update

Creates or updates a workflow.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}?api-version=2016-06-01

Properties

api-version

The API version.

inquery
requiredTrue
typestring
resourceGroupName

The resource group name.

inpath
requiredTrue
typestring
subscriptionId

The subscription id.

inpath
requiredTrue
typestring
workflow

The workflow.

inbody
requiredTrue
typeWorkflow
properties

The workflow properties.

typeobject
typeWorkflowProperties
provisioningState

Gets the provisioning state.

read onlyTrue
typeWorkflowProvisioningState { NotSpecified, Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Moving, Updating, Registering, Registered, Unregistering, Unregistered, Completed }
createdTime

Gets the created time.

read onlyTrue
typedate-time
changedTime

Gets the changed time.

read onlyTrue
typedate-time
state

The state.

typeWorkflowState { NotSpecified, Completed, Enabled, Disabled, Deleted, Suspended }
version

Gets the version.

read onlyTrue
typestring
accessEndpoint

Gets the access endpoint.

read onlyTrue
typestring
sku

The sku.

typeobject
typeSku
name

The name.

requiredTrue
typeSkuName { NotSpecified, Free, Shared, Basic, Standard, Premium }
plan

The reference to plan.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
integrationAccount

The integration account.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
definition

The definition.

typeobject
typeObject
parameters

The parameters.

typeobject
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
location

The resource location.

typestring
tags

The resource tags.

typeobject
workflowName

The workflow name.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK

typeWorkflow
properties

The workflow properties.

typeobject
typeWorkflowProperties
provisioningState

Gets the provisioning state.

read onlyTrue
typeWorkflowProvisioningState { NotSpecified, Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Moving, Updating, Registering, Registered, Unregistering, Unregistered, Completed }
createdTime

Gets the created time.

read onlyTrue
typedate-time
changedTime

Gets the changed time.

read onlyTrue
typedate-time
state

The state.

typeWorkflowState { NotSpecified, Completed, Enabled, Disabled, Deleted, Suspended }
version

Gets the version.

read onlyTrue
typestring
accessEndpoint

Gets the access endpoint.

read onlyTrue
typestring
sku

The sku.

typeobject
typeSku
name

The name.

requiredTrue
typeSkuName { NotSpecified, Free, Shared, Basic, Standard, Premium }
plan

The reference to plan.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
integrationAccount

The integration account.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
definition

The definition.

typeobject
typeObject
parameters

The parameters.

typeobject
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
location

The resource location.

typestring
tags

The resource tags.

typeobject
201 response

Created

typeWorkflow
properties

The workflow properties.

typeobject
typeWorkflowProperties
provisioningState

Gets the provisioning state.

read onlyTrue
typeWorkflowProvisioningState { NotSpecified, Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Moving, Updating, Registering, Registered, Unregistering, Unregistered, Completed }
createdTime

Gets the created time.

read onlyTrue
typedate-time
changedTime

Gets the changed time.

read onlyTrue
typedate-time
state

The state.

typeWorkflowState { NotSpecified, Completed, Enabled, Disabled, Deleted, Suspended }
version

Gets the version.

read onlyTrue
typestring
accessEndpoint

Gets the access endpoint.

read onlyTrue
typestring
sku

The sku.

typeobject
typeSku
name

The name.

requiredTrue
typeSkuName { NotSpecified, Free, Shared, Basic, Standard, Premium }
plan

The reference to plan.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
integrationAccount

The integration account.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
definition

The definition.

typeobject
typeObject
parameters

The parameters.

typeobject
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
location

The resource location.

typestring
tags

The resource tags.

typeobject

Delete

Deletes a workflow.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}?api-version=2016-06-01

Properties

api-version

The API version.

inquery
requiredTrue
typestring
resourceGroupName

The resource group name.

inpath
requiredTrue
typestring
subscriptionId

The subscription id.

inpath
requiredTrue
typestring
workflowName

The workflow name.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK

204 response

No Content

Disable

Disables a workflow.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/disable?api-version=2016-06-01

Properties

api-version

The API version.

inquery
requiredTrue
typestring
resourceGroupName

The resource group name.

inpath
requiredTrue
typestring
subscriptionId

The subscription id.

inpath
requiredTrue
typestring
workflowName

The workflow name.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK

Enable

Enables a workflow.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/enable?api-version=2016-06-01

Properties

api-version

The API version.

inquery
requiredTrue
typestring
resourceGroupName

The resource group name.

inpath
requiredTrue
typestring
subscriptionId

The subscription id.

inpath
requiredTrue
typestring
workflowName

The workflow name.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK

Generate Upgraded Definition

Generates the upgraded definition for a workflow.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/generateUpgradedDefinition?api-version=2016-06-01

Properties

api-version

The API version.

inquery
requiredTrue
typestring
parameters

Parameters for generating an upgraded definition.

inbody
requiredTrue
typeGenerateUpgradedDefinitionParameters
targetSchemaVersion

The target schema version.

typestring
resourceGroupName

The resource group name.

inpath
requiredTrue
typestring
subscriptionId

The subscription id.

inpath
requiredTrue
typestring
workflowName

The workflow name.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK

typeObject

Get

Gets a workflow.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}?api-version=2016-06-01

Properties

api-version

The API version.

inquery
requiredTrue
typestring
resourceGroupName

The resource group name.

inpath
requiredTrue
typestring
subscriptionId

The subscription id.

inpath
requiredTrue
typestring
workflowName

The workflow name.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK

typeWorkflow
properties

The workflow properties.

typeobject
typeWorkflowProperties
provisioningState

Gets the provisioning state.

read onlyTrue
typeWorkflowProvisioningState { NotSpecified, Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Moving, Updating, Registering, Registered, Unregistering, Unregistered, Completed }
createdTime

Gets the created time.

read onlyTrue
typedate-time
changedTime

Gets the changed time.

read onlyTrue
typedate-time
state

The state.

typeWorkflowState { NotSpecified, Completed, Enabled, Disabled, Deleted, Suspended }
version

Gets the version.

read onlyTrue
typestring
accessEndpoint

Gets the access endpoint.

read onlyTrue
typestring
sku

The sku.

typeobject
typeSku
name

The name.

requiredTrue
typeSkuName { NotSpecified, Free, Shared, Basic, Standard, Premium }
plan

The reference to plan.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
integrationAccount

The integration account.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
definition

The definition.

typeobject
typeObject
parameters

The parameters.

typeobject
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
location

The resource location.

typestring
tags

The resource tags.

typeobject

List By Resource Group

Gets a list of workflows by resource group.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows?api-version=2016-06-01[&$top&$filter]

Properties

api-version

The API version.

inquery
requiredTrue
typestring
resourceGroupName

The resource group name.

inpath
requiredTrue
typestring
subscriptionId

The subscription id.

inpath
requiredTrue
typestring
$filter

The filter to apply on the operation.

inquery
requiredFalse
typestring
$top

The number of items to be included in the result.

inquery
requiredFalse
typeinteger

Returns (HTTP Response Codes)

200 response

OK

typeWorkflowListResult
value

The list of workflows.

typeWorkflow[]
properties

The workflow properties.

typeobject
typeWorkflowProperties
provisioningState

Gets the provisioning state.

read onlyTrue
typeWorkflowProvisioningState { NotSpecified, Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Moving, Updating, Registering, Registered, Unregistering, Unregistered, Completed }
createdTime

Gets the created time.

read onlyTrue
typedate-time
changedTime

Gets the changed time.

read onlyTrue
typedate-time
state

The state.

typeWorkflowState { NotSpecified, Completed, Enabled, Disabled, Deleted, Suspended }
version

Gets the version.

read onlyTrue
typestring
accessEndpoint

Gets the access endpoint.

read onlyTrue
typestring
sku

The sku.

typeobject
typeSku
name

The name.

requiredTrue
typeSkuName { NotSpecified, Free, Shared, Basic, Standard, Premium }
plan

The reference to plan.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
integrationAccount

The integration account.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
definition

The definition.

typeobject
typeObject
parameters

The parameters.

typeobject
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
location

The resource location.

typestring
tags

The resource tags.

typeobject
nextLink

The URL to get the next set of results.

typestring

List By Subscription

Gets a list of workflows by subscription.

GET /subscriptions/{subscriptionId}/providers/Microsoft.Logic/workflows?api-version=2016-06-01[&$top&$filter]

Properties

api-version

The API version.

inquery
requiredTrue
typestring
subscriptionId

The subscription id.

inpath
requiredTrue
typestring
$filter

The filter to apply on the operation.

inquery
requiredFalse
typestring
$top

The number of items to be included in the result.

inquery
requiredFalse
typeinteger

Returns (HTTP Response Codes)

200 response

OK

typeWorkflowListResult
value

The list of workflows.

typeWorkflow[]
properties

The workflow properties.

typeobject
typeWorkflowProperties
provisioningState

Gets the provisioning state.

read onlyTrue
typeWorkflowProvisioningState { NotSpecified, Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Moving, Updating, Registering, Registered, Unregistering, Unregistered, Completed }
createdTime

Gets the created time.

read onlyTrue
typedate-time
changedTime

Gets the changed time.

read onlyTrue
typedate-time
state

The state.

typeWorkflowState { NotSpecified, Completed, Enabled, Disabled, Deleted, Suspended }
version

Gets the version.

read onlyTrue
typestring
accessEndpoint

Gets the access endpoint.

read onlyTrue
typestring
sku

The sku.

typeobject
typeSku
name

The name.

requiredTrue
typeSkuName { NotSpecified, Free, Shared, Basic, Standard, Premium }
plan

The reference to plan.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
integrationAccount

The integration account.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
definition

The definition.

typeobject
typeObject
parameters

The parameters.

typeobject
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
location

The resource location.

typestring
tags

The resource tags.

typeobject
nextLink

The URL to get the next set of results.

typestring

List Swagger

Gets an OpenAPI definition for the workflow.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listSwagger?api-version=2016-06-01

Properties

api-version

The API version.

inquery
requiredTrue
typestring
resourceGroupName

The resource group name.

inpath
requiredTrue
typestring
subscriptionId

The subscription id.

inpath
requiredTrue
typestring
workflowName

The workflow name.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK

typeObject

Regenerate Access Key

Regenerates the callback URL access key for request triggers.

Examples

Regenerate the callback URL access key for request triggers

{
	"parameters": {
		"api-version": "2016-06-01",
		"resourceGroupName": "testResourceGroup",
		"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
		"workflowName": "testWorkflowName",
		"keyType": {
			"keyType": "Primary"
		}
	},
	"responses": {
		"200": {}
	}
}
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/regenerateAccessKey?api-version=2016-06-01

Properties

api-version

The API version.

inquery
requiredTrue
typestring
keyType

The access key type.

inbody
requiredTrue
typeRegenerateActionParameter
keyType

The key type.

typeKeyType { NotSpecified, Primary, Secondary }
resourceGroupName

The resource group name.

inpath
requiredTrue
typestring
subscriptionId

The subscription id.

inpath
requiredTrue
typestring
workflowName

The workflow name.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK

Update

Updates a workflow.

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}?api-version=2016-06-01

Properties

api-version

The API version.

inquery
requiredTrue
typestring
resourceGroupName

The resource group name.

inpath
requiredTrue
typestring
subscriptionId

The subscription id.

inpath
requiredTrue
typestring
workflow

The workflow.

inbody
requiredTrue
typeWorkflow
properties

The workflow properties.

typeobject
typeWorkflowProperties
provisioningState

Gets the provisioning state.

read onlyTrue
typeWorkflowProvisioningState { NotSpecified, Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Moving, Updating, Registering, Registered, Unregistering, Unregistered, Completed }
createdTime

Gets the created time.

read onlyTrue
typedate-time
changedTime

Gets the changed time.

read onlyTrue
typedate-time
state

The state.

typeWorkflowState { NotSpecified, Completed, Enabled, Disabled, Deleted, Suspended }
version

Gets the version.

read onlyTrue
typestring
accessEndpoint

Gets the access endpoint.

read onlyTrue
typestring
sku

The sku.

typeobject
typeSku
name

The name.

requiredTrue
typeSkuName { NotSpecified, Free, Shared, Basic, Standard, Premium }
plan

The reference to plan.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
integrationAccount

The integration account.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
definition

The definition.

typeobject
typeObject
parameters

The parameters.

typeobject
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
location

The resource location.

typestring
tags

The resource tags.

typeobject
workflowName

The workflow name.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK

typeWorkflow
properties

The workflow properties.

typeobject
typeWorkflowProperties
provisioningState

Gets the provisioning state.

read onlyTrue
typeWorkflowProvisioningState { NotSpecified, Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Moving, Updating, Registering, Registered, Unregistering, Unregistered, Completed }
createdTime

Gets the created time.

read onlyTrue
typedate-time
changedTime

Gets the changed time.

read onlyTrue
typedate-time
state

The state.

typeWorkflowState { NotSpecified, Completed, Enabled, Disabled, Deleted, Suspended }
version

Gets the version.

read onlyTrue
typestring
accessEndpoint

Gets the access endpoint.

read onlyTrue
typestring
sku

The sku.

typeobject
typeSku
name

The name.

requiredTrue
typeSkuName { NotSpecified, Free, Shared, Basic, Standard, Premium }
plan

The reference to plan.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
integrationAccount

The integration account.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
definition

The definition.

typeobject
typeObject
parameters

The parameters.

typeobject
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
location

The resource location.

typestring
tags

The resource tags.

typeobject

Validate

Validates the workflow definition.

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

Properties

api-version

The API version.

inquery
requiredTrue
typestring
location

The workflow location.

inpath
requiredTrue
typestring
resourceGroupName

The resource group name.

inpath
requiredTrue
typestring
subscriptionId

The subscription id.

inpath
requiredTrue
typestring
workflow

The workflow definition.

inbody
requiredTrue
typeWorkflow
properties

The workflow properties.

typeobject
typeWorkflowProperties
provisioningState

Gets the provisioning state.

read onlyTrue
typeWorkflowProvisioningState { NotSpecified, Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Moving, Updating, Registering, Registered, Unregistering, Unregistered, Completed }
createdTime

Gets the created time.

read onlyTrue
typedate-time
changedTime

Gets the changed time.

read onlyTrue
typedate-time
state

The state.

typeWorkflowState { NotSpecified, Completed, Enabled, Disabled, Deleted, Suspended }
version

Gets the version.

read onlyTrue
typestring
accessEndpoint

Gets the access endpoint.

read onlyTrue
typestring
sku

The sku.

typeobject
typeSku
name

The name.

requiredTrue
typeSkuName { NotSpecified, Free, Shared, Basic, Standard, Premium }
plan

The reference to plan.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
integrationAccount

The integration account.

typeobject
typeResourceReference
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
definition

The definition.

typeobject
typeObject
parameters

The parameters.

typeobject
id

The resource id.

read onlyTrue
typestring
name

Gets the resource name.

read onlyTrue
typestring
type

Gets the resource type.

read onlyTrue
typestring
location

The resource location.

typestring
tags

The resource tags.

typeobject
workflowName

The workflow name.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK