Workflows - Validate

Tjänst:

App Service

API-version:

2023-12-01

Verifierar arbetsflödesdefinitionen.

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-parametrar

Name	I	Obligatorisk	Typ	Description
name	path	True	string	Webbplatsnamn.
resourceGroupName	path	True	string	Namnet på resursgruppen som resursen tillhör. Reguljärt uttrycksmönster: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	ditt prenumerations-ID för Azure Det här är en GUID-formaterad sträng (t.ex. 00000000-0000-0000-0000-0000-000000000).
workflowName	path	True	string	Arbetsflödets namn.
api-version	query	True	string	API-version

Begärandetext

Name	Typ	Description
identity	ManagedServiceIdentity	Hanterad tjänstidentitet.
location	string	Resursplatsen.
properties.accessControl	FlowAccessControlConfiguration	Konfigurationen för åtkomstkontroll.
properties.definition	Object	Definitionen.
properties.endpointsConfiguration	FlowEndpointsConfiguration	Konfigurationen av slutpunkter.
properties.integrationAccount	ResourceReference	Integrationskontot.
properties.integrationServiceEnvironment	ResourceReference	Integreringstjänstmiljön.
properties.kind	Kind	Arbetsflödestyp.
properties.parameters	<string,  WorkflowParameter>	Parametrarna.
properties.state	WorkflowState	Tillståndet.
tags	object	Resurstaggar.

Svar

Name	Typ	Description
200 OK		OK
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Validate a workflow

Exempelbegäran

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

Exempelsvar

Statuskod:

200

Definitioner

Name	Description
ErrorProperties	Felegenskaper anger varför logiktjänsten inte kunde bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.
ErrorResponse	Felsvaret anger att Logic Service inte kan bearbeta den inkommande begäran. Felegenskapen innehåller felinformationen.
FlowAccessControlConfiguration	Konfigurationen för åtkomstkontroll.
FlowAccessControlConfigurationPolicy	Konfigurationsprincipen för åtkomstkontroll.
FlowEndpoints	Konfiguration av flödesslutpunkter.
FlowEndpointsConfiguration	Konfigurationen av slutpunkter.
IpAddress	IP-adressen.
IpAddressRange	IP-adressintervallet.
Kind	Arbetsflödestyp.
ManagedServiceIdentity	Hanterad tjänstidentitet.
ManagedServiceIdentityType	Typ av hanterad tjänstidentitet.
Object
OpenAuthenticationAccessPolicies	AuthenticationPolicy av typen Öppna.
OpenAuthenticationAccessPolicy	Öppna åtkomstprincipen för autentisering som definieras av användaren.
OpenAuthenticationPolicyClaim	Öppna anspråk för autentiseringsprincip.
OpenAuthenticationProviderType	Öppna providertypen för autentiseringsprinciper.
ParameterType	Parametertypen.
ResourceReference	Resursreferensen.
userAssignedIdentity	Användartilldelad identitet.
Workflow	Arbetsflödestypen.
WorkflowParameter	Arbetsflödesparametrarna.
WorkflowProvisioningState	Arbetsflödets etableringstillstånd.
WorkflowSku	SKU-typen.
WorkflowSkuName	SKU-namnet.
WorkflowState	Arbetsflödestillståndet.

ErrorProperties

Felegenskaper anger varför logiktjänsten inte kunde bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Felsvaret anger att Logic Service inte kan bearbeta den inkommande begäran. Felegenskapen innehåller felinformationen.

Name	Typ	Description
error	ErrorProperties	Felegenskaperna.

FlowAccessControlConfiguration

Konfigurationen för åtkomstkontroll.

Name	Typ	Description
actions	FlowAccessControlConfigurationPolicy	Konfiguration av åtkomstkontroll för arbetsflödesåtgärder.
contents	FlowAccessControlConfigurationPolicy	Konfigurationen för åtkomstkontroll för åtkomst till arbetsflödets körningsinnehåll.
triggers	FlowAccessControlConfigurationPolicy	Konfiguration av åtkomstkontroll för att anropa arbetsflödesutlösare.
workflowManagement	FlowAccessControlConfigurationPolicy	Konfiguration av åtkomstkontroll för arbetsflödeshantering.

FlowAccessControlConfigurationPolicy

Konfigurationsprincipen för åtkomstkontroll.

Name	Typ	Description
allowedCallerIpAddresses	IpAddressRange[]	Ip-adressintervall för den tillåtna anroparen.
openAuthenticationPolicies	OpenAuthenticationAccessPolicies	Autentiseringsprinciperna för arbetsflödet.

FlowEndpoints

Konfiguration av flödesslutpunkter.

Name	Typ	Description
accessEndpointIpAddresses	IpAddress[]	Ip-adressen för åtkomstslutpunkten.
outgoingIpAddresses	IpAddress[]	Den utgående IP-adressen.

FlowEndpointsConfiguration

Konfigurationen av slutpunkter.

Name	Typ	Description
connector	FlowEndpoints	Anslutningsslutpunkterna.
workflow	FlowEndpoints	Arbetsflödets slutpunkter.

IpAddress

IP-adressen.

Name	Typ	Description
address	string	Adressen.

IpAddressRange

IP-adressintervallet.

Name	Typ	Description
addressRange	string	IP-adressintervallet.

Kind

Arbetsflödestyp.

Name	Typ	Description
Stateful	string
Stateless	string

ManagedServiceIdentity

Hanterad tjänstidentitet.

Name	Typ	Description
principalId	string	Huvud-ID för hanterad tjänstidentitet.
tenantId	string	Klientorganisation för hanterad tjänstidentitet.
type	ManagedServiceIdentityType	Typ av hanterad tjänstidentitet.
userAssignedIdentities	<string,  userAssignedIdentity>	Listan över användartilldelade identiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet.

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

Object

OpenAuthenticationAccessPolicies

AuthenticationPolicy av typen Öppna.

Name	Typ	Description
policies	<string,  OpenAuthenticationAccessPolicy>	Öppna autentiseringsprinciper.

OpenAuthenticationAccessPolicy

Öppna åtkomstprincipen för autentisering som definieras av användaren.

Name	Typ	Description
claims	OpenAuthenticationPolicyClaim[]	Anspråk för åtkomstprincip.
type	OpenAuthenticationProviderType	Typ av provider för OAuth.

OpenAuthenticationPolicyClaim

Öppna anspråk för autentiseringsprincip.

Name	Typ	Description
name	string	Namnet på anspråket.
value	string	Anspråkets värde.

OpenAuthenticationProviderType

Öppna providertypen för autentiseringsprinciper.

Name	Typ	Description
AAD	string

ParameterType

Parametertypen.

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

ResourceReference

Resursreferensen.

Name	Typ	Description
id	string	Resurs-ID:t.
name	string	Hämtar resursnamnet.
type	string	Hämtar resurstypen.

userAssignedIdentity

Användartilldelad identitet.

Name	Typ	Description
clientId	string	Klient-ID för användartilldelad identitet
principalId	string	Huvudkonto-ID för användartilldelad identitet

Workflow

Arbetsflödestypen.

Name	Typ	Description
id	string	Resurs-ID:t.
identity	ManagedServiceIdentity	Hanterad tjänstidentitet.
location	string	Resursplatsen.
name	string	Hämtar resursnamnet.
properties.accessControl	FlowAccessControlConfiguration	Konfigurationen för åtkomstkontroll.
properties.accessEndpoint	string	Hämtar åtkomstslutpunkten.
properties.changedTime	string	Hämtar den ändrade tiden.
properties.createdTime	string	Hämtar den skapade tiden.
properties.definition	Object	Definitionen.
properties.endpointsConfiguration	FlowEndpointsConfiguration	Konfigurationen av slutpunkter.
properties.integrationAccount	ResourceReference	Integrationskontot.
properties.integrationServiceEnvironment	ResourceReference	Integreringstjänstmiljön.
properties.kind	Kind	Arbetsflödestyp.
properties.parameters	<string,  WorkflowParameter>	Parametrarna.
properties.provisioningState	WorkflowProvisioningState	Hämtar etableringstillståndet.
properties.sku	WorkflowSku	SKU:n.
properties.state	WorkflowState	Tillståndet.
properties.version	string	Hämtar versionen.
tags	object	Resurstaggar.
type	string	Hämtar resurstypen.

WorkflowParameter

Arbetsflödesparametrarna.

Name	Typ	Description
description	string	Beskrivningen.
metadata	Object	Metadata.
type	ParameterType	Typen .
value	Object	Värdet.

WorkflowProvisioningState

Arbetsflödets etableringstillstånd.

Name	Typ	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-typen.

Name	Typ	Description
name	WorkflowSkuName	Namnet.
plan	ResourceReference	Referensen till planen.

WorkflowSkuName

SKU-namnet.

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

WorkflowState

Arbetsflödestillståndet.

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