Workflows - Validate

Odwołanie

Usługa:: App Service

Wersja interfejsu API:: 2023-12-01

Weryfikuje definicję przepływu pracy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa witryny.
resourceGroupName	path	True	string	Nazwa grupy zasobów, do której należy zasób. Wzorzec wyrażenia regularnego: `^[-\w\._\(\)]+[^\.]$`
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 00000000-0000-0000-0000-0000-000000000000).
workflowName	path	True	string	Nazwa przepływu pracy.
api-version	query	True	string	Wersja interfejsu API

Treść żądania

Nazwa	Typ	Opis
identity	ManagedServiceIdentity	Tożsamość usługi zarządzanej.
location	string	Lokalizacja zasobu.
properties.accessControl	FlowAccessControlConfiguration	Konfiguracja kontroli dostępu.
properties.definition	Object	Definicja.
properties.endpointsConfiguration	FlowEndpointsConfiguration	Konfiguracja punktów końcowych.
properties.integrationAccount	ResourceReference	Konto integracji.
properties.integrationServiceEnvironment	ResourceReference	Środowisko usługi integracji.
properties.kind	Kind	Rodzaj przepływu pracy.
properties.parameters	<string, WorkflowParameter>	Parametry.
properties.state	WorkflowState	Stan.
tags	object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK		OK
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Validate a workflow

Przykładowe żądanie

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"
  }
}


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

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

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

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

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

Przykładowa odpowiedź

Kod stanu:: 200

Definicje

Nazwa	Opis
ErrorProperties	Właściwości błędu wskazują, dlaczego usługa logiki nie mogła przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa logiki nie może przetworzyć żądania przychodzącego. Właściwość error zawiera szczegóły błędu.
FlowAccessControlConfiguration	Konfiguracja kontroli dostępu.
FlowAccessControlConfigurationPolicy	Zasady konfiguracji kontroli dostępu.
FlowEndpoints	Konfiguracja punktów końcowych przepływu.
FlowEndpointsConfiguration	Konfiguracja punktów końcowych.
IpAddress	Adres IP.
IpAddressRange	Zakres adresów IP.
Kind	Rodzaj przepływu pracy.
ManagedServiceIdentity	Tożsamość usługi zarządzanej.
ManagedServiceIdentityType	Typ tożsamości usługi zarządzanej.
Object
OpenAuthenticationAccessPolicies	AuthenticationPolicy typu Open.
OpenAuthenticationAccessPolicy	Otwórz zasady dostępu do uwierzytelniania zdefiniowane przez użytkownika.
OpenAuthenticationPolicyClaim	Otwórz oświadczenie zasad uwierzytelniania.
OpenAuthenticationProviderType	Otwórz typ dostawcy zasad uwierzytelniania.
ParameterType	Typ parametru.
ResourceReference	Odwołanie do zasobu.
userAssignedIdentity	Tożsamość przypisana przez użytkownika.
Workflow	Typ przepływu pracy.
WorkflowParameter	Parametry przepływu pracy.
WorkflowProvisioningState	Stan aprowizacji przepływu pracy.
WorkflowSku	Typ jednostki SKU.
WorkflowSkuName	Nazwa jednostki SKU.
WorkflowState	Stan przepływu pracy.

ErrorProperties

Właściwości błędu wskazują, dlaczego usługa logiki nie mogła przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa logiki nie może przetworzyć żądania przychodzącego. Właściwość error zawiera szczegóły błędu.

Nazwa	Typ	Opis
error	ErrorProperties	Właściwości błędu.

FlowAccessControlConfiguration

Konfiguracja kontroli dostępu.

Nazwa	Typ	Opis
actions	FlowAccessControlConfigurationPolicy	Konfiguracja kontroli dostępu dla akcji przepływu pracy.
contents	FlowAccessControlConfigurationPolicy	Konfiguracja kontroli dostępu do uzyskiwania dostępu do zawartości przebiegu przepływu pracy.
triggers	FlowAccessControlConfigurationPolicy	Konfiguracja kontroli dostępu na potrzeby wywoływania wyzwalaczy przepływu pracy.
workflowManagement	FlowAccessControlConfigurationPolicy	Konfiguracja kontroli dostępu do zarządzania przepływami pracy.

FlowAccessControlConfigurationPolicy

Zasady konfiguracji kontroli dostępu.

Nazwa	Typ	Opis
allowedCallerIpAddresses	IpAddressRange[]	Dozwolone zakresy adresów IP wywołującego.
openAuthenticationPolicies	OpenAuthenticationAccessPolicies	Zasady uwierzytelniania dla przepływu pracy.

FlowEndpoints

Konfiguracja punktów końcowych przepływu.

Nazwa	Typ	Opis
accessEndpointIpAddresses	IpAddress[]	Adres IP punktu końcowego dostępu.
outgoingIpAddresses	IpAddress[]	Wychodzący adres IP.

FlowEndpointsConfiguration

Konfiguracja punktów końcowych.

Nazwa	Typ	Opis
connector	FlowEndpoints	Punkty końcowe łącznika.
workflow	FlowEndpoints	Punkty końcowe przepływu pracy.

IpAddress

Adres IP.

Nazwa	Typ	Opis
address	string	Adres.

IpAddressRange

Zakres adresów IP.

Nazwa	Typ	Opis
addressRange	string	Zakres adresów IP.

Kind

Rodzaj przepływu pracy.

Nazwa	Typ	Opis
Stateful	string
Stateless	string

ManagedServiceIdentity

Tożsamość usługi zarządzanej.

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości usługi zarządzanej.
tenantId	string	Dzierżawa tożsamości usługi zarządzanej.
type	ManagedServiceIdentityType	Typ tożsamości usługi zarządzanej.
userAssignedIdentities	<string, userAssignedIdentity>	Lista tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Typ tożsamości usługi zarządzanej.

Nazwa	Typ	Opis
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

Object

OpenAuthenticationAccessPolicies

AuthenticationPolicy typu Open.

Nazwa	Typ	Opis
policies	<string, OpenAuthenticationAccessPolicy>	Otwórz zasady uwierzytelniania.

OpenAuthenticationAccessPolicy

Otwórz zasady dostępu do uwierzytelniania zdefiniowane przez użytkownika.

Nazwa	Typ	Opis
claims	OpenAuthenticationPolicyClaim[]	Oświadczenia zasad dostępu.
type	OpenAuthenticationProviderType	Typ dostawcy dla protokołu OAuth.

OpenAuthenticationPolicyClaim

Otwórz oświadczenie zasad uwierzytelniania.

Nazwa	Typ	Opis
name	string	Nazwa oświadczenia.
value	string	Wartość oświadczenia.

OpenAuthenticationProviderType

Otwórz typ dostawcy zasad uwierzytelniania.

Nazwa	Typ	Opis
AAD	string

ParameterType

Typ parametru.

Nazwa	Typ	Opis
Array	string
Bool	string
Float	string
Int	string
NotSpecified	string
Object	string
SecureObject	string
SecureString	string
String	string

ResourceReference

Odwołanie do zasobu.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Pobiera nazwę zasobu.
type	string	Pobiera typ zasobu.

userAssignedIdentity

Tożsamość przypisana przez użytkownika.

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta tożsamości przypisanej przez użytkownika
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika

Workflow

Typ przepływu pracy.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
identity	ManagedServiceIdentity	Tożsamość usługi zarządzanej.
location	string	Lokalizacja zasobu.
name	string	Pobiera nazwę zasobu.
properties.accessControl	FlowAccessControlConfiguration	Konfiguracja kontroli dostępu.
properties.accessEndpoint	string	Pobiera punkt końcowy dostępu.
properties.changedTime	string	Pobiera zmieniony czas.
properties.createdTime	string	Pobiera czas utworzenia.
properties.definition	Object	Definicja.
properties.endpointsConfiguration	FlowEndpointsConfiguration	Konfiguracja punktów końcowych.
properties.integrationAccount	ResourceReference	Konto integracji.
properties.integrationServiceEnvironment	ResourceReference	Środowisko usługi integracji.
properties.kind	Kind	Rodzaj przepływu pracy.
properties.parameters	<string, WorkflowParameter>	Parametry.
properties.provisioningState	WorkflowProvisioningState	Pobiera stan aprowizacji.
properties.sku	WorkflowSku	Jednostka SKU.
properties.state	WorkflowState	Stan.
properties.version	string	Pobiera wersję.
tags	object	Tagi zasobów.
type	string	Pobiera typ zasobu.

WorkflowParameter

Parametry przepływu pracy.

Nazwa	Typ	Opis
description	string	Opis.
metadata	Object	Metadane.
type	ParameterType	Typ.
value	Object	Wartość.

WorkflowProvisioningState

Stan aprowizacji przepływu pracy.

Nazwa	Typ	Opis
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

Typ jednostki SKU.

Nazwa	Typ	Opis
name	WorkflowSkuName	Nazwa.
plan	ResourceReference	Odwołanie do planu.

WorkflowSkuName

Nazwa jednostki SKU.

Nazwa	Typ	Opis
Basic	string
Free	string
NotSpecified	string
Premium	string
Shared	string
Standard	string

WorkflowState

Stan przepływu pracy.

Nazwa	Typ	Opis
Completed	string
Deleted	string
Disabled	string
Enabled	string
NotSpecified	string
Suspended	string