Workflows - Update

Service:: Logic Apps

API Version:: 2019-05-01

Updates a workflow.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}?api-version=2019-05-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.

Responses

Name	Type	Description
200 OK	Workflow	OK
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

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

Patch a workflow

Sample request

HTTP

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

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": {},
    "endpointsConfiguration": {
      "workflow": {
        "outgoingIpAddresses": [
          {
            "address": "13.84.159.168"
          },
          {
            "address": "13.65.86.56"
          },
          {
            "address": "13.65.82.190"
          }
        ],
        "accessEndpointIpAddresses": [
          {
            "address": "104.210.153.89"
          },
          {
            "address": "13.85.79.155"
          },
          {
            "address": "13.65.39.247"
          }
        ]
      },
      "connector": {
        "outgoingIpAddresses": [
          {
            "address": "40.84.145.61"
          }
        ]
      }
    }
  }
}

Definitions

Name	Description
ErrorProperties	Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.
ErrorResponse	Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.
FlowAccessControlConfiguration	The access control configuration.
FlowAccessControlConfigurationPolicy	The access control configuration policy.
FlowEndpoints	The flow endpoints configuration.
FlowEndpointsConfiguration	The endpoints configuration.
IpAddress	The ip address.
IpAddressRange	The ip address range.
ManagedServiceIdentity	Managed service identity properties.
ManagedServiceIdentityType	Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource.
Object
OpenAuthenticationAccessPolicies	AuthenticationPolicy of type Open.
OpenAuthenticationAccessPolicy	Open authentication access policy defined by user.
OpenAuthenticationPolicyClaim	Open authentication policy claim.
OpenAuthenticationProviderType	Open authentication policy provider type.
ParameterType	The parameter type.
ResourceReference	The resource reference.
Sku	The sku type.
SkuName	The sku name.
userAssignedIdentity	User Assigned identity properties.
Workflow	The workflow type.
WorkflowParameter	The workflow parameters.
WorkflowProvisioningState	The workflow provisioning state.
WorkflowState	The workflow state.

ErrorProperties

Object

Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

ErrorResponse

Object

Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.

Name	Type	Description
error	ErrorProperties	The error properties.

FlowAccessControlConfiguration

Object

The access control configuration.

Name	Type	Description
actions	FlowAccessControlConfigurationPolicy	The access control configuration for workflow actions.
contents	FlowAccessControlConfigurationPolicy	The access control configuration for accessing workflow run contents.
triggers	FlowAccessControlConfigurationPolicy	The access control configuration for invoking workflow triggers.
workflowManagement	FlowAccessControlConfigurationPolicy	The access control configuration for workflow management.

FlowAccessControlConfigurationPolicy

Object

The access control configuration policy.

Name	Type	Description
allowedCallerIpAddresses	IpAddressRange[]	The allowed caller IP address ranges.
openAuthenticationPolicies	OpenAuthenticationAccessPolicies	The authentication policies for workflow.

FlowEndpoints

Object

The flow endpoints configuration.

Name	Type	Description
accessEndpointIpAddresses	IpAddress[]	The access endpoint ip address.
outgoingIpAddresses	IpAddress[]	The outgoing ip address.

FlowEndpointsConfiguration

Object

The endpoints configuration.

Name	Type	Description
connector	FlowEndpoints	The connector endpoints.
workflow	FlowEndpoints	The workflow endpoints.

IpAddress

Object

The ip address.

Name	Type	Description
address	string	The address.

IpAddressRange

Object

The ip address range.

Name	Type	Description
addressRange	string	The IP address range.

ManagedServiceIdentity

Object

Managed service identity properties.

Name	Type	Description
principalId	string (uuid)	Principal Id of managed service identity.
tenantId	string (uuid)	Tenant of managed service identity.
type	ManagedServiceIdentityType	Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource.
userAssignedIdentities	<string, userAssignedIdentity>	The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Enumeration

Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource.

Value	Description
SystemAssigned
UserAssigned
None

Object

OpenAuthenticationAccessPolicies

Object

AuthenticationPolicy of type Open.

Name	Type	Description
policies	<string, OpenAuthenticationAccessPolicy>	Open authentication policies.

OpenAuthenticationAccessPolicy

Object

Open authentication access policy defined by user.

Name	Type	Description
claims	OpenAuthenticationPolicyClaim[]	The access policy claims.
type	OpenAuthenticationProviderType	Type of provider for OAuth.

OpenAuthenticationPolicyClaim

Object

Open authentication policy claim.

Name	Type	Description
name	string	The name of the claim.
value	string	The value of the claim.

OpenAuthenticationProviderType

Enumeration

Open authentication policy provider type.

Value	Description
AAD

ParameterType

Enumeration

The parameter type.

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

userAssignedIdentity

Object

User Assigned identity properties.

Name	Type	Description
clientId	string	Client Id of user assigned identity
principalId	string	Principal Id of user assigned identity

Workflow

Object

The workflow type.

Name	Type	Description
id	string	The resource id.
identity	ManagedServiceIdentity	Managed service identity properties.
___location	string	The resource ___location.
name	string	Gets the resource name.
properties.accessControl	FlowAccessControlConfiguration	The access control configuration.
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.
properties.endpointsConfiguration	FlowEndpointsConfiguration	The endpoints configuration.
properties.integrationAccount	ResourceReference	The integration account.
properties.integrationServiceEnvironment	ResourceReference	The integration service environment.
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

The workflow provisioning state.

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

WorkflowState

Enumeration

The workflow state.

Value	Description
NotSpecified
Completed
Enabled
Disabled
Deleted
Suspended

Share via

Workflows - Update

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Patch a workflow

Sample request

Sample response

Definitions

ErrorProperties

ErrorResponse

FlowAccessControlConfiguration

FlowAccessControlConfigurationPolicy

FlowEndpoints

FlowEndpointsConfiguration

IpAddress

IpAddressRange

ManagedServiceIdentity

ManagedServiceIdentityType

Object

OpenAuthenticationAccessPolicies

OpenAuthenticationAccessPolicy

OpenAuthenticationPolicyClaim

OpenAuthenticationProviderType

ParameterType

ResourceReference

Sku

SkuName

userAssignedIdentity

Workflow

WorkflowParameter

WorkflowProvisioningState

WorkflowState