Workflows - Validate

Referência

Serviço:: App Service

Versão da API:: 2024-11-01

Valida a definição do fluxo de trabalho.

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=2024-11-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
name	path	True	string	Nome do site.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Nome do grupo de recursos ao qual o recurso pertence.
subscriptionId	path	True	string	Sua ID da assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-000000000000000).
workflowName	path	True	string	O nome do fluxo de trabalho.
api-version	query	True	string	Versão da API

Corpo da solicitação

Nome	Tipo	Description
identity	ManagedServiceIdentity	Identidade de serviço gerenciada.
location	string	O local do recurso.
properties.accessControl	FlowAccessControlConfiguration	A configuração de controle de acesso.
properties.definition	Object	A definição.
properties.endpointsConfiguration	FlowEndpointsConfiguration	A configuração de pontos de extremidade.
properties.integrationAccount	ResourceReference	A conta de integração.
properties.integrationServiceEnvironment	ResourceReference	O ambiente do serviço de integração.
properties.kind	Kind	O tipo de fluxo de trabalho.
properties.parameters	<string, WorkflowParameter>	Os parâmetros.
properties.state	WorkflowState	O estado.
tags	object	As marcas de recurso.

Respostas

Nome	Tipo	Description
200 OK		OKEY
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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=2024-11-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"
  }
}

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.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-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(default)
{
    Definition = BinaryData.FromObjectAsJson(new Dictionary<string, object>
    {
        ["$schema"] = "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
        ["actions"] = new object(),
        ["contentVersion"] = "1.0.0.0",
        ["outputs"] = new object(),
        ["parameters"] = new object(),
        ["triggers"] = new 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

Resposta de exemplo

Código de status:: 200

Definições

Nome	Description
ErrorProperties	As propriedades de erro indicam por que o serviço lógico não foi capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
ErrorResponse	A resposta de erro indica que o serviço lógico não é capaz de processar a solicitação de entrada. A propriedade de erro contém os detalhes do erro.
FlowAccessControlConfiguration	A configuração de controle de acesso.
FlowAccessControlConfigurationPolicy	A política de configuração de controle de acesso.
FlowEndpoints	A configuração de pontos de extremidade de fluxo.
FlowEndpointsConfiguration	A configuração de pontos de extremidade.
IpAddress	O endereço ip.
IpAddressRange	O intervalo de endereços ip.
Kind	O tipo de fluxo de trabalho.
ManagedServiceIdentity	Identidade de serviço gerenciada.
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado.
Object
OpenAuthenticationAccessPolicies	AuthenticationPolicy do tipo Open.
OpenAuthenticationAccessPolicy	Abra a política de acesso à autenticação definida pelo usuário.
OpenAuthenticationPolicyClaim	Abra a declaração de política de autenticação.
OpenAuthenticationProviderType	Abra o tipo de provedor de política de autenticação.
ParameterType	O tipo de parâmetro.
ResourceReference	A referência de recurso.
userAssignedIdentity	Identidade atribuída pelo usuário.
Workflow	O tipo de fluxo de trabalho.
WorkflowParameter	Os parâmetros de fluxo de trabalho.
WorkflowProvisioningState	O estado de provisionamento do fluxo de trabalho.
WorkflowSku	O tipo de sku.
WorkflowSkuName	O nome do sku.
WorkflowState	O estado do fluxo de trabalho.

ErrorProperties

Objeto

As propriedades de erro indicam por que o serviço lógico não foi capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Nome	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

ErrorResponse

Objeto

A resposta de erro indica que o serviço lógico não é capaz de processar a solicitação de entrada. A propriedade de erro contém os detalhes do erro.

Nome	Tipo	Description
error	ErrorProperties	As propriedades de erro.

FlowAccessControlConfiguration

Objeto

A configuração de controle de acesso.

Nome	Tipo	Description
actions	FlowAccessControlConfigurationPolicy	A configuração de controle de acesso para ações de fluxo de trabalho.
contents	FlowAccessControlConfigurationPolicy	A configuração de controle de acesso para acessar o conteúdo da execução do fluxo de trabalho.
triggers	FlowAccessControlConfigurationPolicy	A configuração de controle de acesso para invocar gatilhos de fluxo de trabalho.
workflowManagement	FlowAccessControlConfigurationPolicy	A configuração de controle de acesso para gerenciamento de fluxo de trabalho.

FlowAccessControlConfigurationPolicy

Objeto

A política de configuração de controle de acesso.

Nome	Tipo	Description
allowedCallerIpAddresses	IpAddressRange[]	Os intervalos de endereços IP de chamador permitidos.
openAuthenticationPolicies	OpenAuthenticationAccessPolicies	As políticas de autenticação para fluxo de trabalho.

FlowEndpoints

Objeto

A configuração de pontos de extremidade de fluxo.

Nome	Tipo	Description
accessEndpointIpAddresses	IpAddress[]	O endereço ip do ponto de extremidade de acesso.
outgoingIpAddresses	IpAddress[]	O endereço ip de saída.

FlowEndpointsConfiguration

Objeto

A configuração de pontos de extremidade.

Nome	Tipo	Description
connector	FlowEndpoints	Os pontos de extremidade do conector.
workflow	FlowEndpoints	Os pontos de extremidade de fluxo de trabalho.

IpAddress

Objeto

O endereço ip.

Nome	Tipo	Description
address	string	O endereço.

IpAddressRange

Objeto

O intervalo de endereços ip.

Nome	Tipo	Description
addressRange	string	O intervalo de endereços IP.

Kind

Enumeração

O tipo de fluxo de trabalho.

Valor	Description
Stateful
Stateless

ManagedServiceIdentity

Objeto

Identidade de serviço gerenciada.

Nome	Tipo	Description
principalId	string	ID da entidade de segurança da identidade do serviço gerenciado.
tenantId	string	Locatário da identidade do serviço gerenciado.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado.
userAssignedIdentities	<string, userAssignedIdentity>	A lista de identidades atribuídas pelo usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Enumeração

Tipo de identidade de serviço gerenciado.

Valor	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

Object

Objeto

OpenAuthenticationAccessPolicies

Objeto

AuthenticationPolicy do tipo Open.

Nome	Tipo	Description
policies	<string, OpenAuthenticationAccessPolicy>	Abra políticas de autenticação.

OpenAuthenticationAccessPolicy

Objeto

Abra a política de acesso à autenticação definida pelo usuário.

Nome	Tipo	Description
claims	OpenAuthenticationPolicyClaim[]	As declarações de política de acesso.
type	OpenAuthenticationProviderType	Tipo de provedor para OAuth.

OpenAuthenticationPolicyClaim

Objeto

Abra a declaração de política de autenticação.

Nome	Tipo	Description
name	string	O nome da declaração.
value	string	O valor da reivindicação.

OpenAuthenticationProviderType

Enumeração

Abra o tipo de provedor de política de autenticação.

Valor	Description
AAD

ParameterType

Enumeração

O tipo de parâmetro.

Valor	Description
Array
Bool
Float
Int
NotSpecified
Object
SecureObject
SecureString
String

ResourceReference

Objeto

A referência de recurso.

Nome	Tipo	Description
id	string	A ID do recurso.
name	string	Obtém o nome do recurso.
type	string	Obtém o tipo de recurso.

userAssignedIdentity

Objeto

Identidade atribuída pelo usuário.

Nome	Tipo	Description
clientId	string	ID do cliente da identidade atribuída pelo usuário
principalId	string	ID da entidade de segurança da identidade atribuída pelo usuário

Workflow

Objeto

O tipo de fluxo de trabalho.

Nome	Tipo	Description
id	string	A ID do recurso.
identity	ManagedServiceIdentity	Identidade de serviço gerenciada.
location	string	O local do recurso.
name	string	Obtém o nome do recurso.
properties.accessControl	FlowAccessControlConfiguration	A configuração de controle de acesso.
properties.accessEndpoint	string	Obtém o ponto de extremidade de acesso.
properties.changedTime	string (date-time)	Obtém o tempo alterado.
properties.createdTime	string (date-time)	Obtém o tempo de criação.
properties.definition	Object	A definição.
properties.endpointsConfiguration	FlowEndpointsConfiguration	A configuração de pontos de extremidade.
properties.integrationAccount	ResourceReference	A conta de integração.
properties.integrationServiceEnvironment	ResourceReference	O ambiente do serviço de integração.
properties.kind	Kind	O tipo de fluxo de trabalho.
properties.parameters	<string, WorkflowParameter>	Os parâmetros.
properties.provisioningState	WorkflowProvisioningState	Obtém o estado de provisionamento.
properties.sku	WorkflowSku	O sku.
properties.state	WorkflowState	O estado.
properties.version	string	Obtém a versão.
tags	object	As marcas de recurso.
type	string	Obtém o tipo de recurso.

WorkflowParameter

Objeto

Os parâmetros de fluxo de trabalho.

Nome	Tipo	Description
description	string	A descrição.
metadata	Object	Os metadados.
type	ParameterType	O tipo.
value	Object	O valor.

WorkflowProvisioningState

Enumeração

O estado de provisionamento do fluxo de trabalho.

Valor	Description
Accepted
Canceled
Completed
Created
Creating
Deleted
Deleting
Failed
InProgress
Moving
NotSpecified
Pending
Ready
Registered
Registering
Renewing
Running
Succeeded
Unregistered
Unregistering
Updating
Waiting

WorkflowSku

Objeto

O tipo de sku.

Nome	Tipo	Description
name	WorkflowSkuName	O nome.
plan	ResourceReference	A referência ao plano.

WorkflowSkuName

Enumeração

O nome do sku.

Valor	Description
Basic
Free
NotSpecified
Premium
Shared
Standard

WorkflowState

Enumeração

O estado do fluxo de trabalho.

Valor	Description
Completed
Deleted
Disabled
Enabled
NotSpecified
Suspended

Compartilhar via

Workflows - Validate

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

Validate a workflow

Solicitação de exemplo

Resposta de exemplo

Definições

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