Workflows - Validate

Dienst:

App Service

API-Version:

2023-12-01

Überprüft die Workflowdefinition.

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

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Websitename.
resourceGroupName	path	True	string	Name der Ressourcengruppe, zu der die Ressource gehört. RegEx-Muster: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-00000000000000000).
workflowName	path	True	string	Den Workflownamen
api-version	query	True	string	API-Version

Anforderungstext

Name	Typ	Beschreibung
identity	ManagedServiceIdentity	Verwaltete Dienstidentität.
location	string	Der Ressourcenspeicherort.
properties.accessControl	FlowAccessControlConfiguration	Die Konfiguration der Zugriffssteuerung.
properties.definition	Object	Die Definition.
properties.endpointsConfiguration	FlowEndpointsConfiguration	Die Endpunktkonfiguration.
properties.integrationAccount	ResourceReference	Das Integrationskonto.
properties.integrationServiceEnvironment	ResourceReference	Die Integrationsdienstumgebung.
properties.kind	Kind	Die Workflowart.
properties.parameters	<string,  WorkflowParameter>	Die Parameter.
properties.state	WorkflowState	Das Land/die Region.
tags	object	Die Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK		OK
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Validate a workflow

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

Definitionen

Name	Beschreibung
ErrorProperties	Fehlereigenschaften geben an, warum der Logikdienst die eingehende Anforderung nicht verarbeiten konnte. Der Grund wird in der Fehlermeldung angegeben.
ErrorResponse	Fehlerantwort gibt an, dass der Logikdienst die eingehende Anforderung nicht verarbeiten kann. Die error-Eigenschaft enthält die Fehlerdetails.
FlowAccessControlConfiguration	Die Konfiguration der Zugriffssteuerung.
FlowAccessControlConfigurationPolicy	Die Konfigurationsrichtlinie für die Zugriffssteuerung.
FlowEndpoints	Die Konfiguration der Flowendpunkte.
FlowEndpointsConfiguration	Die Endpunktkonfiguration.
IpAddress	Die IP-Adresse.
IpAddressRange	Der IP-Adressbereich.
Kind	Die Workflowart.
ManagedServiceIdentity	Verwaltete Dienstidentität.
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität.
Object
OpenAuthenticationAccessPolicies	AuthenticationPolicy vom Typ Open.
OpenAuthenticationAccessPolicy	Öffnen Sie die vom Benutzer definierte Authentifizierungszugriffsrichtlinie.
OpenAuthenticationPolicyClaim	Öffnen Sie den Authentifizierungsrichtlinienanspruch.
OpenAuthenticationProviderType	Öffnen Sie den Typ des Authentifizierungsrichtlinienanbieters.
ParameterType	Der Parametertyp.
ResourceReference	Der Ressourcenverweis.
userAssignedIdentity	Vom Benutzer zugewiesene Identität.
Workflow	Der Workflowtyp.
WorkflowParameter	Die Workflowparameter.
WorkflowProvisioningState	Der Workflowbereitstellungsstatus.
WorkflowSku	Der SKU-Typ.
WorkflowSkuName	Der SKU-Name.
WorkflowState	Der Workflowszustand.

ErrorProperties

Fehlereigenschaften geben an, warum der Logikdienst die eingehende Anforderung nicht verarbeiten konnte. Der Grund wird in der Fehlermeldung angegeben.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Fehlerantwort gibt an, dass der Logikdienst die eingehende Anforderung nicht verarbeiten kann. Die error-Eigenschaft enthält die Fehlerdetails.

Name	Typ	Beschreibung
error	ErrorProperties	Die Fehlereigenschaften.

FlowAccessControlConfiguration

Die Konfiguration der Zugriffssteuerung.

Name	Typ	Beschreibung
actions	FlowAccessControlConfigurationPolicy	Die Zugriffssteuerungskonfiguration für Workflowaktionen.
contents	FlowAccessControlConfigurationPolicy	Die Zugriffssteuerungskonfiguration für den Zugriff auf Workflowausführungsinhalte.
triggers	FlowAccessControlConfigurationPolicy	Die Zugriffssteuerungskonfiguration zum Aufrufen von Workflowtriggern.
workflowManagement	FlowAccessControlConfigurationPolicy	Die Zugriffssteuerungskonfiguration für die Workflowverwaltung.

FlowAccessControlConfigurationPolicy

Die Konfigurationsrichtlinie für die Zugriffssteuerung.

Name	Typ	Beschreibung
allowedCallerIpAddresses	IpAddressRange[]	Die zulässigen IP-Adressbereiche des Aufrufers.
openAuthenticationPolicies	OpenAuthenticationAccessPolicies	Die Authentifizierungsrichtlinien für den Workflow.

FlowEndpoints

Die Konfiguration der Flowendpunkte.

Name	Typ	Beschreibung
accessEndpointIpAddresses	IpAddress[]	Die IP-Adresse des Zugriffsendpunkts.
outgoingIpAddresses	IpAddress[]	Die ausgehende IP-Adresse.

FlowEndpointsConfiguration

Die Endpunktkonfiguration.

Name	Typ	Beschreibung
connector	FlowEndpoints	Die Connectorendpunkte.
workflow	FlowEndpoints	Die Workflowendpunkte.

IpAddress

Die IP-Adresse.

Name	Typ	Beschreibung
address	string	Die Adresse.

IpAddressRange

Der IP-Adressbereich.

Name	Typ	Beschreibung
addressRange	string	Der IP-Adressbereich.

Kind

Die Workflowart.

Name	Typ	Beschreibung
Stateful	string
Stateless	string

ManagedServiceIdentity

Verwaltete Dienstidentität.

Name	Typ	Beschreibung
principalId	string	Prinzipal-ID der verwalteten Dienstidentität.
tenantId	string	Mandant der verwalteten Dienstidentität.
type	ManagedServiceIdentityType	Typ der verwalteten Dienstidentität.
userAssignedIdentities	<string,  userAssignedIdentity>	Die Liste der benutzerseitig zugewiesenen Identitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Typ der verwalteten Dienstidentität.

Name	Typ	Beschreibung
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

Object

OpenAuthenticationAccessPolicies

AuthenticationPolicy vom Typ Open.

Name	Typ	Beschreibung
policies	<string,  OpenAuthenticationAccessPolicy>	Öffnen Sie Authentifizierungsrichtlinien.

OpenAuthenticationAccessPolicy

Öffnen Sie die vom Benutzer definierte Authentifizierungszugriffsrichtlinie.

Name	Typ	Beschreibung
claims	OpenAuthenticationPolicyClaim[]	Die Zugriffsrichtlinie beansprucht.
type	OpenAuthenticationProviderType	Typ des Anbieters für OAuth.

OpenAuthenticationPolicyClaim

Öffnen Sie den Authentifizierungsrichtlinienanspruch.

Name	Typ	Beschreibung
name	string	Der Name des Anspruchs.
value	string	Der Wert des Anspruchs.

OpenAuthenticationProviderType

Öffnen Sie den Typ des Authentifizierungsrichtlinienanbieters.

Name	Typ	Beschreibung
AAD	string

ParameterType

Der Parametertyp.

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

ResourceReference

Der Ressourcenverweis.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID.
name	string	Ruft den Namen der Ressource ab.
type	string	Ruft den Ressourcentyp ab.

userAssignedIdentity

Vom Benutzer zugewiesene Identität.

Name	Typ	Beschreibung
clientId	string	Client-ID der vom Benutzer zugewiesenen Identität
principalId	string	Prinzipal-ID der vom Benutzer zugewiesenen Identität

Workflow

Der Workflowtyp.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID.
identity	ManagedServiceIdentity	Verwaltete Dienstidentität.
location	string	Der Ressourcenspeicherort.
name	string	Ruft den Namen der Ressource ab.
properties.accessControl	FlowAccessControlConfiguration	Die Konfiguration der Zugriffssteuerung.
properties.accessEndpoint	string	Ruft den Zugriffsendpunkt ab.
properties.changedTime	string	Ruft die geänderte Uhrzeit ab.
properties.createdTime	string	Ruft die Erstellungszeit ab.
properties.definition	Object	Die Definition.
properties.endpointsConfiguration	FlowEndpointsConfiguration	Die Endpunktkonfiguration.
properties.integrationAccount	ResourceReference	Das Integrationskonto.
properties.integrationServiceEnvironment	ResourceReference	Die Integrationsdienstumgebung.
properties.kind	Kind	Die Workflowart.
properties.parameters	<string,  WorkflowParameter>	Die Parameter.
properties.provisioningState	WorkflowProvisioningState	Ruft den Bereitstellungsstatus ab.
properties.sku	WorkflowSku	Die SKU.
properties.state	WorkflowState	Das Land/die Region.
properties.version	string	Ruft die Version ab.
tags	object	Die Ressourcentags.
type	string	Ruft den Ressourcentyp ab.

WorkflowParameter

Die Workflowparameter.

Name	Typ	Beschreibung
description	string	Die Beschreibung.
metadata	Object	Die Metadaten.
type	ParameterType	Der Typ.
value	Object	Der Wert.

WorkflowProvisioningState

Der Workflowbereitstellungsstatus.

Name	Typ	Beschreibung
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

Der SKU-Typ.

Name	Typ	Beschreibung
name	WorkflowSkuName	Der Name.
plan	ResourceReference	Der Verweis auf den Plan.

WorkflowSkuName

Der SKU-Name.

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

WorkflowState

Der Workflowszustand.

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