Workflows - Create Or Update

Reference

Service:: Logic Apps

API Version:: 2016-06-01

Creates or updates a workflow.

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

URI Parameters

Name	In	Required	Type	Description
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	Workflow	OK
201 Created	Workflow	Created

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

Create or update a workflow

Sample request

HTTP

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

{
  "properties": {
    "definition": {
      "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
      "contentVersion": "1.0.0.0",
      "parameters": {
        "$connections": {
          "defaultValue": {},
          "type": "Object"
        }
      },
      "triggers": {
        "manual": {
          "type": "Request",
          "kind": "Http",
          "inputs": {
            "schema": {}
          }
        }
      },
      "actions": {
        "Find_pet_by_ID": {
          "runAfter": {},
          "type": "ApiConnection",
          "inputs": {
            "host": {
              "connection": {
                "name": "@parameters('$connections')['test-custom-connector']['connectionId']"
              }
            },
            "method": "get",
            "path": "/pet/@{encodeURIComponent('1')}"
          }
        }
      },
      "outputs": {}
    },
    "parameters": {
      "$connections": {
        "value": {
          "test-custom-connector": {
            "connectionId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Web/connections/test-custom-connector",
            "connectionName": "test-custom-connector",
            "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/brazilsouth/managedApis/test-custom-connector"
          }
        }
      }
    }
  },
  "location": "brazilsouth",
  "tags": {}
}

Sample response

Status code:: 200

{
  "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": {}
  }
}

Status code:: 201

{
  "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": {}
  }
}

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

ParameterType

Enumeration

Value	Description
Array
Bool
Float
Int
NotSpecified
Object
SecureObject
SecureString
String

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
Basic
Free
NotSpecified
Premium
Shared
Standard

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	Gets the changed time.
properties.createdTime	string	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
Accepted
Canceled
Completed
Created
Creating
Deleted
Deleting
Failed
Moving
NotSpecified
Ready
Registered
Registering
Running
Succeeded
Unregistered
Unregistering
Updating

WorkflowState

Enumeration

Value	Description
Completed
Deleted
Disabled
Enabled
NotSpecified
Suspended

Share via

Workflows - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create or update a workflow

Sample request

Sample response

Definitions

Object

ParameterType

ResourceReference

Sku

SkuName

Workflow

WorkflowParameter

WorkflowProvisioningState

WorkflowState

Additional resources