Workflows - Validate

Referenz

Dienst:: App Service

API-Version:: 2024-11-01

Überprüft die Workflowdefinition.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Websitename.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Name der Ressourcengruppe, zu der die Ressource gehört.
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-000000000000).
workflowName	path	True	string	Der Workflowname.
api-version	query	True	string	API-Version

Anforderungstext

Name	Typ	Beschreibung
identity	ManagedServiceIdentity	Verwaltete Dienstidentität.
location	string	Der Ressourcenspeicherort.
properties.accessControl	FlowAccessControlConfiguration	Die Konfiguration der Zugriffssteuerung.
properties.definition	Object	Die Definition.
properties.endpointsConfiguration	FlowEndpointsConfiguration	Die Endpunktkonfiguration.
properties.integrationAccount	ResourceReference	Das Integrationskonto.
properties.integrationServiceEnvironment	ResourceReference	Die Integrationsdienstumgebung.
properties.kind	Kind	Die Workflowart.
properties.parameters	<string, WorkflowParameter>	Die Parameter.
properties.state	WorkflowState	Der Zustand.
tags	object	Die Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK		OKAY
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

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

Beispiel für eine Antwort

Statuscode:: 200

Definitionen

Name	Beschreibung
ErrorProperties	Fehlereigenschaften deuten darauf hin, warum der Logikdienst die eingehende Anforderung nicht verarbeiten konnte. Der Grund wird in der Fehlermeldung angegeben.
ErrorResponse	Fehlerantwort gibt an, dass der Logikdienst die eingehende Anforderung nicht verarbeiten kann. Die Fehlereigenschaft enthält die Fehlerdetails.
FlowAccessControlConfiguration	Die Konfiguration der Zugriffssteuerung.
FlowAccessControlConfigurationPolicy	Die Konfigurationsrichtlinie für die Zugriffssteuerung.
FlowEndpoints	Die Konfiguration der Ablaufendpunkte.
FlowEndpointsConfiguration	Die Endpunktkonfiguration.
IpAddress	Die IP-Adresse.
IpAddressRange	Der IP-Adressbereich.
Kind	Die Workflowart.
ManagedServiceIdentity	Verwaltete Dienstidentität.
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität.
Object
OpenAuthenticationAccessPolicies	AuthenticationPolicy vom Typ "Öffnen".
OpenAuthenticationAccessPolicy	Offene Authentifizierungszugriffsrichtlinie, die vom Benutzer definiert ist.
OpenAuthenticationPolicyClaim	Öffnen Sie den Anspruch auf Authentifizierungsrichtlinien.
OpenAuthenticationProviderType	Öffnen Sie den Authentifizierungsrichtlinienanbietertyp.
ParameterType	Der Parametertyp.
ResourceReference	Der Ressourcenverweis.
userAssignedIdentity	Vom Benutzer zugewiesene Identität.
Workflow	Der Workflowtyp.
WorkflowParameter	Die Workflowparameter.
WorkflowProvisioningState	Der Workflowbereitstellungsstatus.
WorkflowSku	Der Sku-Typ.
WorkflowSkuName	Der Sku-Name.
WorkflowState	Der Workflowstatus.

ErrorProperties

Objekt

Fehlereigenschaften deuten darauf hin, warum der Logikdienst die eingehende Anforderung nicht verarbeiten konnte. Der Grund wird in der Fehlermeldung angegeben.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Objekt

Fehlerantwort gibt an, dass der Logikdienst die eingehende Anforderung nicht verarbeiten kann. Die Fehlereigenschaft enthält die Fehlerdetails.

Name	Typ	Beschreibung
error	ErrorProperties	Die Fehlereigenschaften.

FlowAccessControlConfiguration

Objekt

Die Konfiguration der Zugriffssteuerung.

Name	Typ	Beschreibung
actions	FlowAccessControlConfigurationPolicy	Die Konfiguration der Zugriffssteuerung für Workflowaktionen.
contents	FlowAccessControlConfigurationPolicy	Die Konfiguration der Zugriffssteuerung für den Zugriff auf Workflowausführungsinhalte.
triggers	FlowAccessControlConfigurationPolicy	Die Konfiguration der Zugriffssteuerung für das Aufrufen von Workflowtriggern.
workflowManagement	FlowAccessControlConfigurationPolicy	Die Konfiguration der Zugriffssteuerung für die Workflowverwaltung.

FlowAccessControlConfigurationPolicy

Objekt

Die Konfigurationsrichtlinie für die Zugriffssteuerung.

Name	Typ	Beschreibung
allowedCallerIpAddresses	IpAddressRange[]	Die zulässigen IP-Adressbereiche des Anrufers.
openAuthenticationPolicies	OpenAuthenticationAccessPolicies	Die Authentifizierungsrichtlinien für Den Workflow.

FlowEndpoints

Objekt

Die Konfiguration der Ablaufendpunkte.

Name	Typ	Beschreibung
accessEndpointIpAddresses	IpAddress[]	Die IP-Adresse des Zugriffsendpunkts.
outgoingIpAddresses	IpAddress[]	Die ausgehende IP-Adresse.

FlowEndpointsConfiguration

Objekt

Die Endpunktkonfiguration.

Name	Typ	Beschreibung
connector	FlowEndpoints	Die Connectorendpunkte.
workflow	FlowEndpoints	Die Workflowendpunkte.

IpAddress

Objekt

Die IP-Adresse.

Name	Typ	Beschreibung
address	string	Die Adresse.

IpAddressRange

Objekt

Der IP-Adressbereich.

Name	Typ	Beschreibung
addressRange	string	Der IP-Adressbereich.

Kind

Enumeration

Die Workflowart.

Wert	Beschreibung
Stateful
Stateless

ManagedServiceIdentity

Objekt

Verwaltete Dienstidentität.

Name	Typ	Beschreibung
principalId	string	Prinzipal-ID der verwalteten Dienstidentität.
tenantId	string	Mandant der verwalteten Dienstidentität.
type	ManagedServiceIdentityType	Typ der verwalteten Dienstidentität.
userAssignedIdentities	<string, userAssignedIdentity>	Die Liste der benutzer zugewiesenen Identitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Enumeration

Typ der verwalteten Dienstidentität.

Wert	Beschreibung
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

Object

Objekt

OpenAuthenticationAccessPolicies

Objekt

AuthenticationPolicy vom Typ "Öffnen".

Name	Typ	Beschreibung
policies	<string, OpenAuthenticationAccessPolicy>	Öffnen Sie Authentifizierungsrichtlinien.

OpenAuthenticationAccessPolicy

Objekt

Offene Authentifizierungszugriffsrichtlinie, die vom Benutzer definiert ist.

Name	Typ	Beschreibung
claims	OpenAuthenticationPolicyClaim[]	Die Zugriffsrichtlinienansprüche.
type	OpenAuthenticationProviderType	Anbietertyp für OAuth.

OpenAuthenticationPolicyClaim

Objekt

Öffnen Sie den Anspruch auf Authentifizierungsrichtlinien.

Name	Typ	Beschreibung
name	string	Der Name des Anspruchs.
value	string	Der Wert des Anspruchs.

OpenAuthenticationProviderType

Enumeration

Öffnen Sie den Authentifizierungsrichtlinienanbietertyp.

Wert	Beschreibung
AAD

ParameterType

Enumeration

Der Parametertyp.

Wert	Beschreibung
Array
Bool
Float
Int
NotSpecified
Object
SecureObject
SecureString
String

ResourceReference

Objekt

Der Ressourcenverweis.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID.
name	string	Ruft den Ressourcennamen ab.
type	string	Ruft den Ressourcentyp ab.

userAssignedIdentity

Objekt

Vom Benutzer zugewiesene Identität.

Name	Typ	Beschreibung
clientId	string	Client-ID der vom Benutzer zugewiesenen Identität
principalId	string	Prinzipal-ID der vom Benutzer zugewiesenen Identität

Workflow

Objekt

Der Workflowtyp.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID.
identity	ManagedServiceIdentity	Verwaltete Dienstidentität.
location	string	Der Ressourcenspeicherort.
name	string	Ruft den Ressourcennamen ab.
properties.accessControl	FlowAccessControlConfiguration	Die Konfiguration der Zugriffssteuerung.
properties.accessEndpoint	string	Ruft den Zugriffsendpunkt ab.
properties.changedTime	string (date-time)	Ruft die geänderte Zeit ab.
properties.createdTime	string (date-time)	Ruft die erstellte Zeit ab.
properties.definition	Object	Die Definition.
properties.endpointsConfiguration	FlowEndpointsConfiguration	Die Endpunktkonfiguration.
properties.integrationAccount	ResourceReference	Das Integrationskonto.
properties.integrationServiceEnvironment	ResourceReference	Die Integrationsdienstumgebung.
properties.kind	Kind	Die Workflowart.
properties.parameters	<string, WorkflowParameter>	Die Parameter.
properties.provisioningState	WorkflowProvisioningState	Ruft den Bereitstellungsstatus ab.
properties.sku	WorkflowSku	Die Sku.
properties.state	WorkflowState	Der Zustand.
properties.version	string	Ruft die Version ab.
tags	object	Die Ressourcentags.
type	string	Ruft den Ressourcentyp ab.

WorkflowParameter

Objekt

Die Workflowparameter.

Name	Typ	Beschreibung
description	string	Die Beschreibung.
metadata	Object	Die Metadaten.
type	ParameterType	Der Typ.
value	Object	Der Wert.

WorkflowProvisioningState

Enumeration

Der Workflowbereitstellungsstatus.

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

WorkflowSku

Objekt

Der Sku-Typ.

Name	Typ	Beschreibung
name	WorkflowSkuName	Der Name.
plan	ResourceReference	Der Verweis auf den Plan.

WorkflowSkuName

Enumeration

Der Sku-Name.

Wert	Beschreibung
Basic
Free
NotSpecified
Premium
Shared
Standard

WorkflowState

Enumeration

Der Workflowstatus.

Wert	Beschreibung
Completed
Deleted
Disabled
Enabled
NotSpecified
Suspended

Freigeben über

Workflows - Validate

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Validate a workflow

Beispielanforderung

Beispiel für eine Antwort

Definitionen

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