Workflows - Validate

Usługa:: App Service

Wersja interfejsu API:: 2025-05-01

Sprawdza poprawność definicji 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=2025-05-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa witryny.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
workflowName	path	True	string	Nazwa przepływu pracy.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

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		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		Operacja platformy Azure została ukończona pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

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=2025-05-01

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


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: 2025-05-01/Workflows_Validate.json
     */
    /**
     * Sample code: Validate a workflow.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void validateAWorkflow(com.azure.resourcemanager.appservice.AppServiceManager manager)
        throws IOException {
        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

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/v6"
)

// Generated from example definition: 2025-05-01/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("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, 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)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armappservice.WorkflowsClientValidateResponse{
	// }
}

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ź o błędzie 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.
OpenAuthenticationAccessPolicies	AuthenticationPolicy typu Otwarte.
OpenAuthenticationAccessPolicy	Otwarta polityka dostępu do uwierzytelniania zdefiniowana przez użytkownika.
OpenAuthenticationPolicyClaim	Oświadczenie zasad uwierzytelniania otwartego.
OpenAuthenticationProviderType	Typ dostawcy zasad uwierzytelniania otwartego.
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 SKU.
WorkflowState	Stan przepływu pracy.

ErrorProperties

Objekt

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

Objekt

Odpowiedź o błędzie 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

Objekt

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

Objekt

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

Objekt

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

Objekt

Konfiguracja punktów końcowych.

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

IpAddress

Objekt

Adres IP.

Nazwa	Typ	Opis
address	string	Adres.

IpAddressRange

Objekt

Zakres adresów IP.

Nazwa	Typ	Opis
addressRange	string	Zakres adresów IP.

Kind

Wyliczenie

Rodzaj przepływu pracy.

Wartość	Opis
Stateful
Stateless

ManagedServiceIdentity

Objekt

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

Wyliczenie

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

Wartość	Opis
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

OpenAuthenticationAccessPolicies

Objekt

AuthenticationPolicy typu Otwarte.

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

OpenAuthenticationAccessPolicy

Objekt

Otwarta polityka dostępu do uwierzytelniania zdefiniowana przez użytkownika.

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

OpenAuthenticationPolicyClaim

Objekt

Oświadczenie zasad uwierzytelniania otwartego.

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

OpenAuthenticationProviderType

Wyliczenie

Typ dostawcy zasad uwierzytelniania otwartego.

Wartość	Opis
AAD

ParameterType

Wyliczenie

Typ parametru.

Wartość	Opis
NotSpecified
String
SecureString
Int
Float
Bool
Array
Object
SecureObject

ResourceReference

Objekt

Odwołanie do zasobu.

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

UserAssignedIdentity

Objekt

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

Objekt

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 (date-time)	Pobiera zmieniony czas.
properties.createdTime	string (date-time)	Pobiera czas utworzenia.
properties.definition		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 apryfikacji.
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

Objekt

Parametry przepływu pracy.

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

WorkflowProvisioningState

Wyliczenie

Stan aprowizacji przepływu pracy.

Wartość	Opis
NotSpecified
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Moving
Updating
Registering
Registered
Unregistering
Unregistered
Completed
Renewing
Pending
Waiting
InProgress

WorkflowSku

Objekt

Typ jednostki SKU.

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

WorkflowSkuName

Wyliczenie

Nazwa SKU.

Wartość	Opis
NotSpecified
Free
Shared
Basic
Standard
Premium

WorkflowState

Wyliczenie

Stan przepływu pracy.

Wartość	Opis
NotSpecified
Completed
Enabled
Disabled
Deleted
Suspended

Udostępnij za pośrednictwem

Workflows - Validate

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Validate a workflow

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ErrorProperties

ErrorResponse

FlowAccessControlConfiguration

FlowAccessControlConfigurationPolicy

FlowEndpoints

FlowEndpointsConfiguration

IpAddress

IpAddressRange

Kind

ManagedServiceIdentity

ManagedServiceIdentityType

OpenAuthenticationAccessPolicies

OpenAuthenticationAccessPolicy

OpenAuthenticationPolicyClaim

OpenAuthenticationProviderType

ParameterType

ResourceReference

UserAssignedIdentity

Workflow

WorkflowParameter

WorkflowProvisioningState

WorkflowSku

WorkflowSkuName

WorkflowState