你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Workflows - Validate

服务:

App Service

API 版本:

2024-04-01

验证工作流定义。

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 参数

名称	在	必需	类型	说明
name	path	True	string	网站名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	资源所属的资源组的名称。
subscriptionId	path	True	string	Azure 订阅 ID。 这是 GUID 格式的字符串（例如 000000000-0000-0000-0000-00000000000000）。
workflowName	path	True	string	工作流名称。
api-version	query	True	string	API 版本

请求正文

名称	类型	说明
identity	ManagedServiceIdentity	托管服务标识。
location	string	资源位置。
properties.accessControl	FlowAccessControlConfiguration	访问控制配置。
properties.definition	Object	定义。
properties.endpointsConfiguration	FlowEndpointsConfiguration	终结点配置。
properties.integrationAccount	ResourceReference	集成帐户。
properties.integrationServiceEnvironment	ResourceReference	集成服务环境。
properties.kind	Kind	工作流类型。
properties.parameters	<string,  WorkflowParameter>	参数。
properties.state	WorkflowState	状态。
tags	object	资源标记。

响应

名称	类型	说明
200 OK		还行
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Validate a workflow

示例请求

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python workflows_validate.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    client.workflows.validate(
        resource_group_name="test-resource-group",
        name="test-name",
        workflow_name="test-workflow",
        validate={
            "properties": {
                "definition": {
                    "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
                    "actions": {},
                    "contentVersion": "1.0.0.0",
                    "outputs": {},
                    "parameters": {},
                    "triggers": {},
                },
                "kind": "Stateful",
            }
        },
    )


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Workflows_Validate.json
if __name__ == "__main__":
    main()

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

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Validates the workflow definition.
 *
 * @summary Validates the workflow definition.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/Workflows_Validate.json
 */
async function validateAWorkflow() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "test-resource-group";
  const name = "test-name";
  const workflowName = "test-workflow";
  const validate = {
    definition: {
      $schema:
        "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
      actions: {},
      contentVersion: "1.0.0.0",
      outputs: {},
      parameters: {},
      triggers: {},
    },
    kind: "Stateful",
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.workflows.validate(resourceGroupName, name, workflowName, validate);
  console.log(result);
}

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

示例响应

状态代码:

200

定义

名称	说明
ErrorProperties	错误属性指示逻辑服务无法处理传入请求的原因。 错误消息中提供了原因。
ErrorResponse	错误响应指示逻辑服务无法处理传入请求。 error 属性包含错误详细信息。
FlowAccessControlConfiguration	访问控制配置。
FlowAccessControlConfigurationPolicy	访问控制配置策略。
FlowEndpoints	流终结点配置。
FlowEndpointsConfiguration	终结点配置。
IpAddress	IP 地址。
IpAddressRange	IP 地址范围。
Kind	工作流类型。
ManagedServiceIdentity	托管服务标识。
ManagedServiceIdentityType	托管服务标识的类型。
Object
OpenAuthenticationAccessPolicies	Open 类型的 AuthenticationPolicy。
OpenAuthenticationAccessPolicy	打开用户定义的身份验证访问策略。
OpenAuthenticationPolicyClaim	打开身份验证策略声明。
OpenAuthenticationProviderType	打开身份验证策略提供程序类型。
ParameterType	参数类型。
ResourceReference	资源引用。
userAssignedIdentity	用户分配的标识。
Workflow	工作流类型。
WorkflowParameter	工作流参数。
WorkflowProvisioningState	工作流预配状态。
WorkflowSku	SKU 类型。
WorkflowSkuName	SKU 名称。
WorkflowState	工作流状态。

ErrorProperties

Object

错误属性指示逻辑服务无法处理传入请求的原因。 错误消息中提供了原因。

名称	类型	说明
code	string	错误代码。
message	string	指示作失败的原因的错误消息。

ErrorResponse

Object

错误响应指示逻辑服务无法处理传入请求。 error 属性包含错误详细信息。

名称	类型	说明
error	ErrorProperties	错误属性。

FlowAccessControlConfiguration

Object

访问控制配置。

名称	类型	说明
actions	FlowAccessControlConfigurationPolicy	工作流作的访问控制配置。
contents	FlowAccessControlConfigurationPolicy	用于访问工作流运行内容的访问控制配置。
triggers	FlowAccessControlConfigurationPolicy	用于调用工作流触发器的访问控制配置。
workflowManagement	FlowAccessControlConfigurationPolicy	工作流管理的访问控制配置。

FlowAccessControlConfigurationPolicy

Object

访问控制配置策略。

名称	类型	说明
allowedCallerIpAddresses	IpAddressRange[]	允许的调用方 IP 地址范围。
openAuthenticationPolicies	OpenAuthenticationAccessPolicies	工作流的身份验证策略。

FlowEndpoints

Object

流终结点配置。

名称	类型	说明
accessEndpointIpAddresses	IpAddress[]	访问终结点 IP 地址。
outgoingIpAddresses	IpAddress[]	传出 IP 地址。

FlowEndpointsConfiguration

Object

终结点配置。

名称	类型	说明
connector	FlowEndpoints	连接器终结点。
workflow	FlowEndpoints	工作流终结点。

IpAddress

Object

IP 地址。

名称	类型	说明
address	string	地址。

IpAddressRange

Object

IP 地址范围。

名称	类型	说明
addressRange	string	IP 地址范围。

Kind

枚举

工作流类型。

值	说明
Stateful
Stateless

ManagedServiceIdentity

Object

托管服务标识。

名称	类型	说明
principalId	string	托管服务标识的主体 ID。
tenantId	string	托管服务标识的租户。
type	ManagedServiceIdentityType	托管服务标识的类型。
userAssignedIdentities	<string,  userAssignedIdentity>	与资源关联的用户分配标识的列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

枚举

托管服务标识的类型。

值	说明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

Object

Object

OpenAuthenticationAccessPolicies

Object

Open 类型的 AuthenticationPolicy。

名称	类型	说明
policies	<string,  OpenAuthenticationAccessPolicy>	打开身份验证策略。

OpenAuthenticationAccessPolicy

Object

打开用户定义的身份验证访问策略。

名称	类型	说明
claims	OpenAuthenticationPolicyClaim[]	访问策略声明。
type	OpenAuthenticationProviderType	OAuth 的提供程序类型。

OpenAuthenticationPolicyClaim

Object

打开身份验证策略声明。

名称	类型	说明
name	string	声明的名称。
value	string	声明的值。

OpenAuthenticationProviderType

枚举

打开身份验证策略提供程序类型。

值	说明
AAD

ParameterType

枚举

参数类型。

值	说明
Array
Bool
Float
Int
NotSpecified
Object
SecureObject
SecureString
String

ResourceReference

Object

资源引用。

名称	类型	说明
id	string	资源 ID。
name	string	获取资源名称。
type	string	获取资源类型。

userAssignedIdentity

Object

用户分配的标识。

名称	类型	说明
clientId	string	用户分配标识的客户端 ID
principalId	string	用户分配标识的主体 ID

Workflow

Object

工作流类型。

名称	类型	说明
id	string	资源 ID。
identity	ManagedServiceIdentity	托管服务标识。
location	string	资源位置。
name	string	获取资源名称。
properties.accessControl	FlowAccessControlConfiguration	访问控制配置。
properties.accessEndpoint	string	获取访问终结点。
properties.changedTime	string (date-time)	获取更改的时间。
properties.createdTime	string (date-time)	获取创建的时间。
properties.definition	Object	定义。
properties.endpointsConfiguration	FlowEndpointsConfiguration	终结点配置。
properties.integrationAccount	ResourceReference	集成帐户。
properties.integrationServiceEnvironment	ResourceReference	集成服务环境。
properties.kind	Kind	工作流类型。
properties.parameters	<string,  WorkflowParameter>	参数。
properties.provisioningState	WorkflowProvisioningState	获取预配状态。
properties.sku	WorkflowSku	SKU。
properties.state	WorkflowState	状态。
properties.version	string	获取版本。
tags	object	资源标记。
type	string	获取资源类型。

WorkflowParameter

Object

工作流参数。

名称	类型	说明
description	string	说明。
metadata	Object	元数据。
type	ParameterType	类型。
value	Object	值。

WorkflowProvisioningState

枚举

工作流预配状态。

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

WorkflowSku

Object

SKU 类型。

名称	类型	说明
name	WorkflowSkuName	名称。
plan	ResourceReference	计划的引用。

WorkflowSkuName

枚举

SKU 名称。

值	说明
Basic
Free
NotSpecified
Premium
Shared
Standard

WorkflowState

枚举

工作流状态。

值	说明
Completed
Deleted
Disabled
Enabled
NotSpecified
Suspended