Workflows - Validate

服務:

App Service

API 版本:

2023-12-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=2023-12-01

URI 參數

名稱	位於	必要	類型	Description
name	path	True	string	網站名稱。
resourceGroupName	path	True	string	資源所屬資源群組的名稱。 Regex 模式: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	您的 Azure 訂用帳戶識別碼。 這是 GUID 格式的字串 (例如 0000000000-0000-0000-0000-0000000000000) 。
workflowName	path	True	string	工作流程名稱。
api-version	query	True	string	API 版本

要求本文

名稱	類型	Description
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	資源標籤。

回應

名稱	類型	Description
200 OK		確定
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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=2023-12-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/2023-12-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 typing import Any, IO, Union

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/2023-12-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/21c2852d62ccc3abe9cc3800c989c6826f8363dc/specification/web/resource-manager/Microsoft.Web/stable/2023-12-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");

/**
 * 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/2023-12-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/2023-12-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

定義

名稱	Description
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

錯誤屬性指出邏輯服務無法處理傳入要求的原因。 錯誤訊息中提供了原因。

名稱	類型	Description
code	string	錯誤碼。
message	string	指出作業失敗原因的錯誤訊息。

ErrorResponse

錯誤回應指出邏輯服務無法處理傳入要求。 error 屬性包含錯誤詳細數據。

名稱	類型	Description
error	ErrorProperties	錯誤屬性。

FlowAccessControlConfiguration

訪問控制組態。

名稱	類型	Description
actions	FlowAccessControlConfigurationPolicy	工作流程動作的訪問控制組態。
contents	FlowAccessControlConfigurationPolicy	用於存取工作流程執行內容的訪問控制組態。
triggers	FlowAccessControlConfigurationPolicy	叫用工作流程觸發程式的訪問控制組態。
workflowManagement	FlowAccessControlConfigurationPolicy	工作流程管理的訪問控制組態。

FlowAccessControlConfigurationPolicy

訪問控制設定原則。

名稱	類型	Description
allowedCallerIpAddresses	IpAddressRange[]	允許的呼叫端IP位址範圍。
openAuthenticationPolicies	OpenAuthenticationAccessPolicies	工作流程的驗證原則。

FlowEndpoints

流程端點組態。

名稱	類型	Description
accessEndpointIpAddresses	IpAddress[]	存取端點 IP 位址。
outgoingIpAddresses	IpAddress[]	傳出IP位址。

FlowEndpointsConfiguration

端點組態。

名稱	類型	Description
connector	FlowEndpoints	連接器端點。
workflow	FlowEndpoints	工作流程端點。

IpAddress

IP 位址。

名稱	類型	Description
address	string	位址。

IpAddressRange

IP 位址範圍。

名稱	類型	Description
addressRange	string	IP 位址範圍。

Kind

工作流程種類。

名稱	類型	Description
Stateful	string
Stateless	string

ManagedServiceIdentity

受控服務識別。

名稱	類型	Description
principalId	string	受控服務識別的主體標識碼。
tenantId	string	受控服務識別的租使用者。
type	ManagedServiceIdentityType	受控服務識別的類型。
userAssignedIdentities	<string,  userAssignedIdentity>	與資源相關聯的使用者指派身分識別清單。 用戶識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

受控服務識別的類型。

名稱	類型	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

Object

OpenAuthenticationAccessPolicies

Open 類型的 AuthenticationPolicy。

名稱	類型	Description
policies	<string,  OpenAuthenticationAccessPolicy>	開啟驗證原則。

OpenAuthenticationAccessPolicy

開啟使用者定義的驗證存取原則。

名稱	類型	Description
claims	OpenAuthenticationPolicyClaim[]	存取原則宣告。
type	OpenAuthenticationProviderType	OAuth 的提供者類型。

OpenAuthenticationPolicyClaim

開啟驗證原則宣告。

名稱	類型	Description
name	string	宣告的名稱。
value	string	宣告的值。

OpenAuthenticationProviderType

開啟驗證原則提供者類型。

名稱	類型	Description
AAD	string

ParameterType

參數類型。

名稱	類型	Description
Array	string
Bool	string
Float	string
Int	string
NotSpecified	string
Object	string
SecureObject	string
SecureString	string
String	string

ResourceReference

資源參考。

名稱	類型	Description
id	string	資源標識碼。
name	string	取得資源名稱。
type	string	取得資源類型。

userAssignedIdentity

使用者指派的身分識別。

名稱	類型	Description
clientId	string	使用者指派身分識別的用戶端標識碼
principalId	string	使用者指派身分識別的主體標識碼

Workflow

工作流程類型。

名稱	類型	Description
id	string	資源標識碼。
identity	ManagedServiceIdentity	受控服務識別。
location	string	資源位置。
name	string	取得資源名稱。
properties.accessControl	FlowAccessControlConfiguration	訪問控制組態。
properties.accessEndpoint	string	取得存取端點。
properties.changedTime	string	取得變更的時間。
properties.createdTime	string	取得建立的時間。
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

工作流程參數。

名稱	類型	Description
description	string	描述。
metadata	Object	中繼資料。
type	ParameterType	類型。
value	Object	數值。

WorkflowProvisioningState

工作流程布建狀態。

名稱	類型	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

SKU 類型。

名稱	類型	Description
name	WorkflowSkuName	名稱。
plan	ResourceReference	計劃的參考。

WorkflowSkuName

SKU 名稱。

名稱	類型	Description
Basic	string
Free	string
NotSpecified	string
Premium	string
Shared	string
Standard	string

WorkflowState

工作流程狀態。

名稱	類型	Description
Completed	string
Deleted	string
Disabled	string
Enabled	string
NotSpecified	string
Suspended	string