Workflows - Validate

サービス:

App Service

API バージョン:

2024-11-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-11-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-000000000000)。
workflowName	path	True	string	ワークフロー名。
api-version	query	True	string	API バージョン

要求本文

名前	型	説明
identity	ManagedServiceIdentity	マネージド サービス ID。
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		[OK]
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 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-11-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-11-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-11-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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-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-11-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.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-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(default)
{
    Definition = BinaryData.FromObjectAsJson(new Dictionary<string, object>
    {
        ["$schema"] = "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
        ["actions"] = new object(),
        ["contentVersion"] = "1.0.0.0",
        ["outputs"] = new object(),
        ["parameters"] = new object(),
        ["triggers"] = new 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	エラー応答は、Logic サービスが受信要求を処理できないことを示します。 error プロパティには、エラーの詳細が含まれています。
FlowAccessControlConfiguration	アクセス制御の構成。
FlowAccessControlConfigurationPolicy	アクセス制御構成ポリシー。
FlowEndpoints	フロー エンドポイントの構成。
FlowEndpointsConfiguration	エンドポイントの構成。
IpAddress	IP アドレス。
IpAddressRange	IP アドレスの範囲。
Kind	ワークフローの種類。
ManagedServiceIdentity	マネージド サービス ID。
ManagedServiceIdentityType	マネージド サービス ID の種類。
Object
OpenAuthenticationAccessPolicies	種類が Open の AuthenticationPolicy。
OpenAuthenticationAccessPolicy	ユーザーによって定義された認証アクセス ポリシーを開きます。
OpenAuthenticationPolicyClaim	認証ポリシー要求を開きます。
OpenAuthenticationProviderType	認証ポリシー プロバイダーの種類を開きます。
ParameterType	パラメーターの型。
ResourceReference	リソース参照。
userAssignedIdentity	ユーザー割り当て ID。
Workflow	ワークフローの種類。
WorkflowParameter	ワークフロー パラメーター。
WorkflowProvisioningState	ワークフロー のプロビジョニング状態。
WorkflowSku	SKU の種類。
WorkflowSkuName	SKU 名。
WorkflowState	ワークフローの状態。

ErrorProperties

Object

エラー プロパティは、ロジック サービスが受信要求を処理できなかった理由を示します。 エラー メッセージに理由が示されます。

名前	型	説明
code	string	エラー コード。
message	string	操作が失敗した理由を示すエラー メッセージ。

ErrorResponse

Object

エラー応答は、Logic サービスが受信要求を処理できないことを示します。 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

マネージド サービス ID。

名前	型	説明
principalId	string	マネージド サービス ID のプリンシパル ID。
tenantId	string	マネージド サービス ID のテナント。
type	ManagedServiceIdentityType	マネージド サービス ID の種類。
userAssignedIdentities	<string,  userAssignedIdentity>	リソースに関連付けられているユーザー割り当て ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。

ManagedServiceIdentityType

列挙

マネージド サービス ID の種類。

値	説明
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

ユーザー割り当て ID。

名前	型	説明
clientId	string	ユーザー割り当て ID のクライアント ID
principalId	string	ユーザー割り当て ID のプリンシパル ID

Workflow

Object

ワークフローの種類。

名前	型	説明
id	string	リソース ID。
identity	ManagedServiceIdentity	マネージド サービス ID。
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