Workflows - Validate

Service:

App Service

API Version:

2024-04-01

Validates the workflow definition.

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

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Site name.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
workflowName	path	True	string	The workflow name.
api-version	query	True	string	API Version

Request Body

Name	Type	Description
identity	ManagedServiceIdentity	Managed service identity.
location	string	The resource location.
properties.accessControl	FlowAccessControlConfiguration	The access control configuration.
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.kind	Kind	The workflow kind.
properties.parameters	<string,  WorkflowParameter>	The parameters.
properties.state	WorkflowState	The state.
tags	object	The resource tags.

Responses

Name	Type	Description
200 OK		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

Validate a workflow

Sample request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Web/sites/test-name/hostruntime/runtime/webhooks/workflow/api/management/workflows/test-workflow/validate?api-version=2024-04-01

{
  "properties": {
    "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": {}
    },
    "kind": "Stateful"
  }
}

Java

import com.azure.core.management.serializer.SerializerFactory;
import com.azure.core.util.serializer.SerializerEncoding;
import com.azure.resourcemanager.appservice.models.Kind;
import com.azure.resourcemanager.appservice.models.Workflow;
import java.io.IOException;

/**
 * Samples for Workflows Validate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Workflows_Validate.json
     */
    /**
     * Sample code: Validate a workflow.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void validateAWorkflow(com.azure.resourcemanager.AzureResourceManager azure) throws IOException {
        azure.webApps().manager().serviceClient().getWorkflows().validateWithResponse("test-resource-group",
            "test-name", "test-workflow",
            new Workflow().withDefinition(SerializerFactory.createDefaultManagementSerializerAdapter().deserialize(
                "{\"$schema\":\"https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#\",\"actions\":{},\"contentVersion\":\"1.0.0.0\",\"outputs\":{},\"parameters\":{},\"triggers\":{}}",
                Object.class, SerializerEncoding.JSON)).withKind(Kind.STATEFUL),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Workflows_Validate.json
func ExampleWorkflowsClient_Validate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewWorkflowsClient().Validate(ctx, "test-resource-group", "test-name", "test-workflow", armappservice.Workflow{
		Properties: &armappservice.WorkflowProperties{
			Definition: map[string]any{
				"$schema":        "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
				"actions":        map[string]any{},
				"contentVersion": "1.0.0.0",
				"outputs":        map[string]any{},
				"parameters":     map[string]any{},
				"triggers":       map[string]any{},
			},
			Kind: to.Ptr(armappservice.KindStateful),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Workflows_Validate.json
// this example is just showing the usage of "Workflows_Validate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "test-resource-group";
string name = "test-name";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);

// invoke the operation
string workflowName = "test-workflow";
WorkflowData data = new WorkflowData(new AzureLocation("placeholder"))
{
    Definition = BinaryData.FromObjectAsJson(new Dictionary<string, object>()
    {
        ["$schema"] = "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
        ["actions"] = new Dictionary<string, object>()
        {
        },
        ["contentVersion"] = "1.0.0.0",
        ["outputs"] = new Dictionary<string, object>()
        {
        },
        ["parameters"] = new Dictionary<string, object>()
        {
        },
        ["triggers"] = new Dictionary<string, object>()
        {
        }
    }),
    Kind = AppServiceKind.Stateful,
};
await webSite.ValidateWorkflowAsync(workflowName, data);

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

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.
Kind	The workflow kind.
ManagedServiceIdentity	Managed service identity.
ManagedServiceIdentityType	Type of managed service identity.
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.
userAssignedIdentity	User Assigned identity.
Workflow	The workflow type.
WorkflowParameter	The workflow parameters.
WorkflowProvisioningState	The workflow provisioning state.
WorkflowSku	The sku type.
WorkflowSkuName	The sku name.
WorkflowState	The workflow state.

ErrorProperties

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

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

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

The access control configuration policy.

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

FlowEndpoints

The flow endpoints configuration.

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

FlowEndpointsConfiguration

The endpoints configuration.

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

IpAddress

The ip address.

Name	Type	Description
address	string	The address.

IpAddressRange

The ip address range.

Name	Type	Description
addressRange	string	The IP address range.

Kind

The workflow kind.

Name	Type	Description
Stateful	string
Stateless	string

ManagedServiceIdentity

Managed service identity.

Name	Type	Description
principalId	string	Principal Id of managed service identity.
tenantId	string	Tenant of managed service identity.
type	ManagedServiceIdentityType	Type of managed service identity.
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

Type of managed service identity.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

Object

OpenAuthenticationAccessPolicies

AuthenticationPolicy of type Open.

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

OpenAuthenticationAccessPolicy

Open authentication access policy defined by user.

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

OpenAuthenticationPolicyClaim

Open authentication policy claim.

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

OpenAuthenticationProviderType

Open authentication policy provider type.

Name	Type	Description
AAD	string

ParameterType

The parameter type.

Name	Type	Description
Array	string
Bool	string
Float	string
Int	string
NotSpecified	string
Object	string
SecureObject	string
SecureString	string
String	string

ResourceReference

The resource reference.

Name	Type	Description
id	string	The resource id.
name	string	Gets the resource name.
type	string	Gets the resource type.

userAssignedIdentity

User Assigned identity.

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

Workflow

The workflow type.

Name	Type	Description
id	string	The resource id.
identity	ManagedServiceIdentity	Managed service identity.
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	Gets the changed time.
properties.createdTime	string	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.kind	Kind	The workflow kind.
properties.parameters	<string,  WorkflowParameter>	The parameters.
properties.provisioningState	WorkflowProvisioningState	Gets the provisioning state.
properties.sku	WorkflowSku	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

The workflow parameters.

Name	Type	Description
description	string	The description.
metadata	Object	The metadata.
type	ParameterType	The type.
value	Object	The value.

WorkflowProvisioningState

The workflow provisioning state.

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

WorkflowSku

The sku type.

Name	Type	Description
name	WorkflowSkuName	The name.
plan	ResourceReference	The reference to plan.

WorkflowSkuName

The sku name.

Name	Type	Description
Basic	string
Free	string
NotSpecified	string
Premium	string
Shared	string
Standard	string

WorkflowState

The workflow state.

Name	Type	Description
Completed	string
Deleted	string
Disabled	string
Enabled	string
NotSpecified	string
Suspended	string