POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/validate/?api-version=2023-01-01

Validates the workflow definition.

Servers

Path parameters

Name Type Required Description
name String Yes

Site name.

subscriptionId String Yes

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

resourceGroupName String Yes

Name of the resource group to which the resource belongs.

workflowName String Yes

The workflow name.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String No

The resource id.

name String No

Gets the resource name.

properties Object No

The workflow properties.

properties.definition Object No
properties.createdTime String No

Gets the created time.

properties.parameters Object No

The parameters.

properties.parameters.name Object No

The workflow parameters.

properties.parameters.name.description String No

The description.

properties.parameters.name.type String No

The parameter type.

Possible values:

  • "NotSpecified"
  • "Array"
  • "Int"
  • "Float"
  • "Object"
  • "String"
  • "Bool"
  • "SecureObject"
  • "SecureString"
properties.parameters.name.metadata Object No
properties.parameters.name.value Object No
properties.changedTime String No

Gets the changed time.

properties.state String No

The workflow state.

Possible values:

  • "NotSpecified"
  • "Disabled"
  • "Enabled"
  • "Suspended"
  • "Completed"
  • "Deleted"
properties.accessEndpoint String No

Gets the access endpoint.

properties.sku Object No

The sku type.

properties.sku.name String Yes

The sku name.

Possible values:

  • "NotSpecified"
  • "Free"
  • "Basic"
  • "Shared"
  • "Standard"
  • "Premium"
properties.sku.plan Object No

The resource reference.

properties.sku.plan.id String No

The resource id.

properties.sku.plan.name String No

Gets the resource name.

properties.sku.plan.type String No

Gets the resource type.

properties.endpointsConfiguration Object No

The endpoints configuration.

properties.endpointsConfiguration.connector Object No

The flow endpoints configuration.

properties.endpointsConfiguration.connector.outgoingIpAddresses[] Array No

The outgoing ip address.

properties.endpointsConfiguration.connector.outgoingIpAddresses[].address String No

The address.

properties.endpointsConfiguration.connector.accessEndpointIpAddresses[] Array No

The access endpoint ip address.

properties.endpointsConfiguration.connector.accessEndpointIpAddresses[].address String No

The address.

properties.endpointsConfiguration.workflow Object No

The flow endpoints configuration.

properties.endpointsConfiguration.workflow.outgoingIpAddresses[] Array No

The outgoing ip address.

properties.endpointsConfiguration.workflow.outgoingIpAddresses[].address String No

The address.

properties.endpointsConfiguration.workflow.accessEndpointIpAddresses[] Array No

The access endpoint ip address.

properties.endpointsConfiguration.workflow.accessEndpointIpAddresses[].address String No

The address.

properties.integrationAccount Object No

The resource reference.

properties.integrationAccount.id String No

The resource id.

properties.integrationAccount.name String No

Gets the resource name.

properties.integrationAccount.type String No

Gets the resource type.

properties.provisioningState String No

The workflow provisioning state.

Possible values:

  • "NotSpecified"
  • "Accepted"
  • "Running"
  • "Renewing"
  • "Registered"
  • "Unregistered"
  • "Deleted"
  • "Succeeded"
  • "Unregistering"
  • "Deleting"
  • "Waiting"
  • "Created"
  • "Moving"
  • "Registering"
  • "Completed"
  • "Creating"
  • "Canceled"
  • "Updating"
  • "Pending"
  • "InProgress"
  • "Ready"
  • "Failed"
properties.accessControl Object No

The access control configuration.

properties.accessControl.contents Object No

The access control configuration policy.

properties.accessControl.contents.openAuthenticationPolicies Object No

AuthenticationPolicy of type Open.

properties.accessControl.contents.openAuthenticationPolicies.policies Object No

Open authentication policies.

properties.accessControl.contents.openAuthenticationPolicies.policies.name Object No

Open authentication access policy defined by user.

properties.accessControl.contents.openAuthenticationPolicies.policies.name.claims[] Array No

The access policy claims.

properties.accessControl.contents.openAuthenticationPolicies.policies.name.claims[].name String No

The name of the claim.

properties.accessControl.contents.openAuthenticationPolicies.policies.name.claims[].value String No

The value of the claim.

properties.accessControl.contents.openAuthenticationPolicies.policies.name.type String No

Open authentication policy provider type.

Possible values:

  • "AAD"
properties.accessControl.contents.allowedCallerIpAddresses[] Array No

The allowed caller IP address ranges.

properties.accessControl.contents.allowedCallerIpAddresses[].addressRange String No

The IP address range.

properties.accessControl.actions Object No

The access control configuration policy.

properties.accessControl.actions.openAuthenticationPolicies Object No

AuthenticationPolicy of type Open.

properties.accessControl.actions.openAuthenticationPolicies.policies Object No

Open authentication policies.

properties.accessControl.actions.openAuthenticationPolicies.policies.name Object No

Open authentication access policy defined by user.

properties.accessControl.actions.openAuthenticationPolicies.policies.name.claims[] Array No

The access policy claims.

properties.accessControl.actions.openAuthenticationPolicies.policies.name.claims[].name String No

The name of the claim.

properties.accessControl.actions.openAuthenticationPolicies.policies.name.claims[].value String No

The value of the claim.

properties.accessControl.actions.openAuthenticationPolicies.policies.name.type String No

Open authentication policy provider type.

Possible values:

  • "AAD"
properties.accessControl.actions.allowedCallerIpAddresses[] Array No

The allowed caller IP address ranges.

properties.accessControl.actions.allowedCallerIpAddresses[].addressRange String No

The IP address range.

properties.accessControl.workflowManagement Object No

The access control configuration policy.

properties.accessControl.workflowManagement.openAuthenticationPolicies Object No

AuthenticationPolicy of type Open.

properties.accessControl.workflowManagement.openAuthenticationPolicies.policies Object No

Open authentication policies.

properties.accessControl.workflowManagement.openAuthenticationPolicies.policies.name Object No

Open authentication access policy defined by user.

properties.accessControl.workflowManagement.openAuthenticationPolicies.policies.name.claims[] Array No

The access policy claims.

properties.accessControl.workflowManagement.openAuthenticationPolicies.policies.name.claims[].name String No

The name of the claim.

properties.accessControl.workflowManagement.openAuthenticationPolicies.policies.name.claims[].value String No

The value of the claim.

properties.accessControl.workflowManagement.openAuthenticationPolicies.policies.name.type String No

Open authentication policy provider type.

Possible values:

  • "AAD"
properties.accessControl.workflowManagement.allowedCallerIpAddresses[] Array No

The allowed caller IP address ranges.

properties.accessControl.workflowManagement.allowedCallerIpAddresses[].addressRange String No

The IP address range.

properties.accessControl.triggers Object No

The access control configuration policy.

properties.accessControl.triggers.openAuthenticationPolicies Object No

AuthenticationPolicy of type Open.

properties.accessControl.triggers.openAuthenticationPolicies.policies Object No

Open authentication policies.

properties.accessControl.triggers.openAuthenticationPolicies.policies.name Object No

Open authentication access policy defined by user.

properties.accessControl.triggers.openAuthenticationPolicies.policies.name.claims[] Array No

The access policy claims.

properties.accessControl.triggers.openAuthenticationPolicies.policies.name.claims[].name String No

The name of the claim.

properties.accessControl.triggers.openAuthenticationPolicies.policies.name.claims[].value String No

The value of the claim.

properties.accessControl.triggers.openAuthenticationPolicies.policies.name.type String No

Open authentication policy provider type.

Possible values:

  • "AAD"
properties.accessControl.triggers.allowedCallerIpAddresses[] Array No

The allowed caller IP address ranges.

properties.accessControl.triggers.allowedCallerIpAddresses[].addressRange String No

The IP address range.

properties.version String No

Gets the version.

properties.integrationServiceEnvironment Object No

The resource reference.

properties.integrationServiceEnvironment.id String No

The resource id.

properties.integrationServiceEnvironment.name String No

Gets the resource name.

properties.integrationServiceEnvironment.type String No

Gets the resource type.

properties.kind String No

The workflow kind.

Possible values:

  • "Stateful"
  • "Stateless"
location String No

The resource location.

tags Object No

The resource tags.

type String No

Gets the resource type.

identity Object No

Managed service identity.

identity.tenantId String No

Tenant of managed service identity.

identity.type String No

Type of managed service identity.

Possible values:

  • "SystemAssigned"
  • "UserAssigned"
  • "None"
  • "SystemAssigned, UserAssigned"
identity.userAssignedIdentities Object No

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}

identity.userAssignedIdentities.name Object No

User Assigned identity.

identity.userAssignedIdentities.name.principalId String No

Principal Id of user assigned identity

identity.userAssignedIdentities.name.clientId String No

Client Id of user assigned identity

identity.principalId String No

Principal Id of managed service identity.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.