Workflows - Validate

Служба:: App Service

Версия API:: 2025-05-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=2025-05-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
name	path	True	string	Имя сайта.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
workflowName	path	True	string	Имя рабочего процесса.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
identity	ManagedServiceIdentity	Управляемое удостоверение службы.
location	string	Расположение ресурса.
properties.accessControl	FlowAccessControlConfiguration	Конфигурация управления доступом.
properties.definition		Определение.
properties.endpointsConfiguration	FlowEndpointsConfiguration	Конфигурация конечных точек.
properties.integrationAccount	ResourceReference	Учетная запись интеграции.
properties.integrationServiceEnvironment	ResourceReference	Среда службы интеграции.
properties.kind	Kind	Вид рабочего процесса.
properties.parameters	<string, WorkflowParameter>	Параметры.
properties.state	WorkflowState	Государство.
tags	object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK		Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Validate a workflow

Образец запроса

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

Пример ответа

Код состояния:: 200

Определения

Имя	Описание
ErrorProperties	Свойства ошибки указывают на то, почему служба Logic не смогла обработать входящий запрос. Причина указана в сообщении об ошибке.
ErrorResponse	Ответ об ошибке указывает на то, что служба логики не может обработать входящий запрос. Свойство error содержит сведения об ошибке.
FlowAccessControlConfiguration	Конфигурация управления доступом.
FlowAccessControlConfigurationPolicy	Политика настройки управления доступом.
FlowEndpoints	Конфигурация конечных точек потока.
FlowEndpointsConfiguration	Конфигурация конечных точек.
IpAddress	IP-адрес.
IpAddressRange	Диапазон IP-адресов.
Kind	Вид рабочего процесса.
ManagedServiceIdentity	Управляемое удостоверение службы.
ManagedServiceIdentityType	Тип управляемого удостоверения службы.
OpenAuthenticationAccessPolicies	AuthenticationPolicy типа Open.
OpenAuthenticationAccessPolicy	Откройте политику доступа для проверки подлинности, определенную пользователем.
OpenAuthenticationPolicyClaim	Откройте утверждение политики проверки подлинности.
OpenAuthenticationProviderType	Откройте тип поставщика политики проверки подлинности.
ParameterType	Тип параметра.
ResourceReference	Ссылка на ресурсы.
UserAssignedIdentity	Удостоверение, назначенное пользователем.
Workflow	Тип рабочего процесса.
WorkflowParameter	Параметры рабочего процесса.
WorkflowProvisioningState	Состояние подготовки рабочего процесса.
WorkflowSku	Тип SKU.
WorkflowSkuName	Имя SKU.
WorkflowState	Состояние рабочего процесса.

ErrorProperties

Объект

Свойства ошибки указывают на то, почему служба Logic не смогла обработать входящий запрос. Причина указана в сообщении об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

ErrorResponse

Объект

Ответ об ошибке указывает на то, что служба логики не может обработать входящий запрос. Свойство error содержит сведения об ошибке.

Имя	Тип	Описание
error	ErrorProperties	Свойства ошибки.

FlowAccessControlConfiguration

Объект

Конфигурация управления доступом.

Имя	Тип	Описание
actions	FlowAccessControlConfigurationPolicy	Конфигурация управления доступом для действий рабочего процесса.
contents	FlowAccessControlConfigurationPolicy	Конфигурация управления доступом для доступа к содержимому запуска рабочего процесса.
triggers	FlowAccessControlConfigurationPolicy	Конфигурация управления доступом для вызова триггеров рабочего процесса.
workflowManagement	FlowAccessControlConfigurationPolicy	Конфигурация управления доступом для управления рабочими процессами.

FlowAccessControlConfigurationPolicy

Объект

Политика настройки управления доступом.

Имя	Тип	Описание
allowedCallerIpAddresses	IpAddressRange[]	Допустимые диапазоны IP-адресов вызывающего абонента.
openAuthenticationPolicies	OpenAuthenticationAccessPolicies	Политики проверки подлинности для рабочего процесса.

FlowEndpoints

Объект

Конфигурация конечных точек потока.

Имя	Тип	Описание
accessEndpointIpAddresses	IpAddress[]	IP-адрес конечной точки доступа.
outgoingIpAddresses	IpAddress[]	Исходящий IP-адрес.

FlowEndpointsConfiguration

Объект

Конфигурация конечных точек.

Имя	Тип	Описание
connector	FlowEndpoints	Конечные точки соединителя.
workflow	FlowEndpoints	Конечные точки рабочего процесса.

IpAddress

Объект

IP-адрес.

Имя	Тип	Описание
address	string	Адрес.

IpAddressRange

Объект

Диапазон IP-адресов.

Имя	Тип	Описание
addressRange	string	Диапазон IP-адресов.

Kind

Перечисление

Вид рабочего процесса.

Значение	Описание
Stateful
Stateless

ManagedServiceIdentity

Объект

Управляемое удостоверение службы.

Имя	Тип	Описание
principalId	string	Идентификатор участника удостоверения управляемой службы.
tenantId	string	Клиент удостоверения управляемой службы.
type	ManagedServiceIdentityType	Тип управляемого удостоверения службы.
userAssignedIdentities	<string, UserAssignedIdentity>	Список назначенных пользователем удостоверений, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Перечисление

Тип управляемого удостоверения службы.

Значение	Описание
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

OpenAuthenticationAccessPolicies

Объект

AuthenticationPolicy типа Open.

Имя	Тип	Описание
policies	<string, OpenAuthenticationAccessPolicy>	Откройте политики проверки подлинности.

OpenAuthenticationAccessPolicy

Объект

Откройте политику доступа для проверки подлинности, определенную пользователем.

Имя	Тип	Описание
claims	OpenAuthenticationPolicyClaim[]	Утверждения политики доступа.
type	OpenAuthenticationProviderType	Тип поставщика для OAuth.

OpenAuthenticationPolicyClaim

Объект

Откройте утверждение политики проверки подлинности.

Имя	Тип	Описание
name	string	Имя утверждения.
value	string	Значение утверждения.

OpenAuthenticationProviderType

Перечисление

Откройте тип поставщика политики проверки подлинности.

Значение	Описание
AAD

ParameterType

Перечисление

Тип параметра.

Значение	Описание
NotSpecified
String
SecureString
Int
Float
Bool
Array
Object
SecureObject

ResourceReference

Объект

Ссылка на ресурсы.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Получает имя ресурса.
type	string	Получает тип ресурса.

UserAssignedIdentity

Объект

Удостоверение, назначенное пользователем.

Имя	Тип	Описание
clientId	string	Идентификатор клиента назначаемого пользователем удостоверения
principalId	string	Идентификатор участника назначаемого пользователем удостоверения

Workflow

Объект

Тип рабочего процесса.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
identity	ManagedServiceIdentity	Управляемое удостоверение службы.
location	string	Расположение ресурса.
name	string	Получает имя ресурса.
properties.accessControl	FlowAccessControlConfiguration	Конфигурация управления доступом.
properties.accessEndpoint	string	Получает конечную точку доступа.
properties.changedTime	string (date-time)	Получает измененное время.
properties.createdTime	string (date-time)	Получает созданное время.
properties.definition		Определение.
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

Объект

Параметры рабочего процесса.

Имя	Тип	Описание
description	string	Описание.
metadata		Метаданные.
type	ParameterType	Тип.
value		Значение.

WorkflowProvisioningState

Перечисление

Состояние подготовки рабочего процесса.

Значение	Описание
NotSpecified
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Moving
Updating
Registering
Registered
Unregistering
Unregistered
Completed
Renewing
Pending
Waiting
InProgress

WorkflowSku

Объект

Тип SKU.

Имя	Тип	Описание
name	WorkflowSkuName	Имя.
plan	ResourceReference	Ссылка на план.

WorkflowSkuName

Перечисление

Имя SKU.

Значение	Описание
NotSpecified
Free
Shared
Basic
Standard
Premium

WorkflowState

Перечисление

Состояние рабочего процесса.

Значение	Описание
NotSpecified
Completed
Enabled
Disabled
Deleted
Suspended

Поделиться через

Workflows - Validate

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

Validate a workflow

Образец запроса

Пример ответа

Определения

ErrorProperties

ErrorResponse

FlowAccessControlConfiguration

FlowAccessControlConfigurationPolicy

FlowEndpoints

FlowEndpointsConfiguration

IpAddress

IpAddressRange

Kind

ManagedServiceIdentity

ManagedServiceIdentityType

OpenAuthenticationAccessPolicies

OpenAuthenticationAccessPolicy

OpenAuthenticationPolicyClaim

OpenAuthenticationProviderType

ParameterType

ResourceReference

UserAssignedIdentity

Workflow

WorkflowParameter

WorkflowProvisioningState

WorkflowSku

WorkflowSkuName

WorkflowState