Workflows - Validate

Referencia

Servicio:: App Service

Versión de la API:: 2023-12-01

Valida la definición del flujo de trabajo.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
name	path	True	string	Nombre del sitio.
resourceGroupName	path	True	string	Nombre del grupo de recursos al que pertenece el recurso. Patrón de Regex: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-0000-0000-0000-00000000000000).
workflowName	path	True	string	El nombre del flujo de trabajo.
api-version	query	True	string	Versión de la API

Cuerpo de la solicitud

Nombre	Tipo	Description
identity	ManagedServiceIdentity	Identidad de servicio administrada.
location	string	Ubicación del recurso.
properties.accessControl	FlowAccessControlConfiguration	Configuración del control de acceso.
properties.definition	Object	Definición.
properties.endpointsConfiguration	FlowEndpointsConfiguration	Configuración de los puntos de conexión.
properties.integrationAccount	ResourceReference	La cuenta de integración.
properties.integrationServiceEnvironment	ResourceReference	Entorno del servicio de integración.
properties.kind	Kind	Tipo de flujo de trabajo.
properties.parameters	<string, WorkflowParameter>	Los parámetros.
properties.state	WorkflowState	Estado.
tags	object	Etiquetas del recurso.

Respuestas

Nombre	Tipo	Description
200 OK		Aceptar
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Validate a workflow

Solicitud de ejemplo

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/de1f3772629b6f4d3ac01548a5f6d719bfb97c9e/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

Respuesta de muestra

status code:: 200

Definiciones

Nombre	Description
ErrorProperties	Las propiedades de error indican por qué el servicio logic no pudo procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
ErrorResponse	La respuesta de error indica que logic service no puede procesar la solicitud entrante. La propiedad error contiene los detalles del error.
FlowAccessControlConfiguration	Configuración del control de acceso.
FlowAccessControlConfigurationPolicy	La directiva de configuración de control de acceso.
FlowEndpoints	Configuración de los puntos de conexión de flujo.
FlowEndpointsConfiguration	Configuración de los puntos de conexión.
IpAddress	La dirección IP.
IpAddressRange	Intervalo de direcciones IP.
Kind	Tipo de flujo de trabajo.
ManagedServiceIdentity	Identidad de servicio administrada.
ManagedServiceIdentityType	Tipo de identidad de servicio administrada.
Object
OpenAuthenticationAccessPolicies	AuthenticationPolicy de tipo Open.
OpenAuthenticationAccessPolicy	Abra la directiva de acceso de autenticación definida por el usuario.
OpenAuthenticationPolicyClaim	Abra la notificación de directiva de autenticación.
OpenAuthenticationProviderType	Abra el tipo de proveedor de directivas de autenticación.
ParameterType	El tipo de parámetro.
ResourceReference	Referencia de recursos.
userAssignedIdentity	Identidad asignada por el usuario.
Workflow	Tipo de flujo de trabajo.
WorkflowParameter	Parámetros de flujo de trabajo.
WorkflowProvisioningState	Estado de aprovisionamiento del flujo de trabajo.
WorkflowSku	Tipo de SKU.
WorkflowSkuName	Nombre de la SKU.
WorkflowState	El estado del flujo de trabajo.

ErrorProperties

Las propiedades de error indican por qué el servicio logic no pudo procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

ErrorResponse

La respuesta de error indica que logic service no puede procesar la solicitud entrante. La propiedad error contiene los detalles del error.

Nombre	Tipo	Description
error	ErrorProperties	Propiedades de error.

FlowAccessControlConfiguration

Configuración del control de acceso.

Nombre	Tipo	Description
actions	FlowAccessControlConfigurationPolicy	Configuración del control de acceso para las acciones de flujo de trabajo.
contents	FlowAccessControlConfigurationPolicy	La configuración del control de acceso para acceder al contenido de la ejecución del flujo de trabajo.
triggers	FlowAccessControlConfigurationPolicy	Configuración del control de acceso para invocar desencadenadores de flujo de trabajo.
workflowManagement	FlowAccessControlConfigurationPolicy	Configuración del control de acceso para la administración de flujos de trabajo.

FlowAccessControlConfigurationPolicy

La directiva de configuración de control de acceso.

Nombre	Tipo	Description
allowedCallerIpAddresses	IpAddressRange[]	Intervalos de direcciones IP del autor de la llamada permitidos.
openAuthenticationPolicies	OpenAuthenticationAccessPolicies	Las directivas de autenticación para el flujo de trabajo.

FlowEndpoints

Configuración de los puntos de conexión de flujo.

Nombre	Tipo	Description
accessEndpointIpAddresses	IpAddress[]	Dirección IP del punto de conexión de acceso.
outgoingIpAddresses	IpAddress[]	Dirección IP saliente.

FlowEndpointsConfiguration

Configuración de los puntos de conexión.

Nombre	Tipo	Description
connector	FlowEndpoints	Los puntos de conexión del conector.
workflow	FlowEndpoints	Puntos de conexión de flujo de trabajo.

IpAddress

La dirección IP.

Nombre	Tipo	Description
address	string	La dirección.

IpAddressRange

Intervalo de direcciones IP.

Nombre	Tipo	Description
addressRange	string	Intervalo de direcciones IP.

Kind

Tipo de flujo de trabajo.

Nombre	Tipo	Description
Stateful	string
Stateless	string

ManagedServiceIdentity

Identidad de servicio administrada.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad de servicio administrada.
tenantId	string	Inquilino de la identidad de servicio administrada.
type	ManagedServiceIdentityType	Tipo de identidad de servicio administrada.
userAssignedIdentities	<string, userAssignedIdentity>	Lista de identidades asignadas por el usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Tipo de identidad de servicio administrada.

Nombre	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

Object

OpenAuthenticationAccessPolicies

AuthenticationPolicy de tipo Open.

Nombre	Tipo	Description
policies	<string, OpenAuthenticationAccessPolicy>	Abra directivas de autenticación.

OpenAuthenticationAccessPolicy

Abra la directiva de acceso de autenticación definida por el usuario.

Nombre	Tipo	Description
claims	OpenAuthenticationPolicyClaim[]	Las notificaciones de la directiva de acceso.
type	OpenAuthenticationProviderType	Tipo de proveedor para OAuth.

OpenAuthenticationPolicyClaim

Abra la notificación de directiva de autenticación.

Nombre	Tipo	Description
name	string	El nombre de la notificación.
value	string	Valor de la reclamación.

OpenAuthenticationProviderType

Abra el tipo de proveedor de directivas de autenticación.

Nombre	Tipo	Description
AAD	string

ParameterType

El tipo de parámetro.

Nombre	Tipo	Description
Array	string
Bool	string
Float	string
Int	string
NotSpecified	string
Object	string
SecureObject	string
SecureString	string
String	string

ResourceReference

Referencia de recursos.

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Obtiene el nombre del recurso.
type	string	Obtiene el tipo de recurso.

userAssignedIdentity

Identidad asignada por el usuario.

Nombre	Tipo	Description
clientId	string	Identificador de cliente de la identidad asignada por el usuario
principalId	string	Identificador de entidad de seguridad de la identidad asignada por el usuario

Workflow

Tipo de flujo de trabajo.

Nombre	Tipo	Description
id	string	Identificador del recurso.
identity	ManagedServiceIdentity	Identidad de servicio administrada.
location	string	Ubicación del recurso.
name	string	Obtiene el nombre del recurso.
properties.accessControl	FlowAccessControlConfiguration	Configuración del control de acceso.
properties.accessEndpoint	string	Obtiene el punto de conexión de acceso.
properties.changedTime	string	Obtiene la hora cambiada.
properties.createdTime	string	Obtiene la hora de creación.
properties.definition	Object	Definición.
properties.endpointsConfiguration	FlowEndpointsConfiguration	Configuración de los puntos de conexión.
properties.integrationAccount	ResourceReference	La cuenta de integración.
properties.integrationServiceEnvironment	ResourceReference	Entorno del servicio de integración.
properties.kind	Kind	Tipo de flujo de trabajo.
properties.parameters	<string, WorkflowParameter>	Los parámetros.
properties.provisioningState	WorkflowProvisioningState	Obtiene el estado de aprovisionamiento.
properties.sku	WorkflowSku	SKU.
properties.state	WorkflowState	Estado.
properties.version	string	Obtiene la versión.
tags	object	Etiquetas del recurso.
type	string	Obtiene el tipo de recurso.

WorkflowParameter

Parámetros de flujo de trabajo.

Nombre	Tipo	Description
description	string	La descripción.
metadata	Object	Los metadatos.
type	ParameterType	Tipo.
value	Object	Valor.

WorkflowProvisioningState

Estado de aprovisionamiento del flujo de trabajo.

Nombre	Tipo	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

Tipo de SKU.

Nombre	Tipo	Description
name	WorkflowSkuName	Nombre.
plan	ResourceReference	Referencia al plan.

WorkflowSkuName

Nombre de la SKU.

Nombre	Tipo	Description
Basic	string
Free	string
NotSpecified	string
Premium	string
Shared	string
Standard	string

WorkflowState

El estado del flujo de trabajo.

Nombre	Tipo	Description
Completed	string
Deleted	string
Disabled	string
Enabled	string
NotSpecified	string
Suspended	string

Compartir a través de

Workflows - Validate

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Validate a workflow

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorProperties

ErrorResponse

FlowAccessControlConfiguration

FlowAccessControlConfigurationPolicy

FlowEndpoints

FlowEndpointsConfiguration

IpAddress

IpAddressRange

Kind

ManagedServiceIdentity

ManagedServiceIdentityType

Object

OpenAuthenticationAccessPolicies

OpenAuthenticationAccessPolicy

OpenAuthenticationPolicyClaim

OpenAuthenticationProviderType

ParameterType

ResourceReference

userAssignedIdentity

Workflow

WorkflowParameter

WorkflowProvisioningState

WorkflowSku

WorkflowSkuName

WorkflowState

Recursos adicionales