Web Apps - List Workflows

Servicio:: App Service

Versión de la API:: 2025-05-01

Enumere los flujos de trabajo de un sitio web o una ranura de implementación.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows?api-version=2025-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
name	path	True	string	Nombre del sitio.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	WorkflowEnvelopeCollection	La operación de Azure se completó correctamente.
Other Status Codes	DefaultErrorResponse	Una respuesta de error inesperada.

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	suplantar la cuenta de usuario

Ejemplos

List the workflows

Solicitud de ejemplo

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows?api-version=2025-05-01


/**
 * Samples for WebApps ListWorkflows.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/ListWorkflows.json
     */
    /**
     * Sample code: List the workflows.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void listTheWorkflows(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        manager.serviceClient().getWebApps().listWorkflows("testrg123", "testsite2", 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/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v6"
)

// Generated from example definition: 2025-05-01/ListWorkflows.json
func ExampleWebAppsClient_NewListWorkflowsPager() {
	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)
	}
	pager := clientFactory.NewWebAppsClient().NewListWorkflowsPager("testrg123", "testsite2", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armappservice.WebAppsClientListWorkflowsResponse{
		// 	WorkflowEnvelopeCollection: armappservice.WorkflowEnvelopeCollection{
		// 		Value: []*armappservice.WorkflowEnvelope{
		// 			{
		// 				Name: to.Ptr("testsite2/a1"),
		// 				Type: to.Ptr("Microsoft.Web/sites/workflows"),
		// 				ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows/a1"),
		// 				Kind: to.Ptr("Stateful"),
		// 				Location: to.Ptr("USAAnywhere"),
		// 				Properties: &armappservice.WorkflowEnvelopeProperties{
		// 					FlowState: to.Ptr(armappservice.WorkflowStateEnabled),
		// 					Health: &armappservice.WorkflowHealth{
		// 						State: to.Ptr(armappservice.WorkflowHealthStateHealthy),
		// 					},
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("testsite2/stateful2"),
		// 				Type: to.Ptr("Microsoft.Web/sites/workflows"),
		// 				ID: to.Ptr("/subscriptions/testsub/resourceGroups/testrg/providers/Microsoft.Web/sites/testsite2/workflows/stateful2"),
		// 				Kind: to.Ptr("Stateful"),
		// 				Location: to.Ptr("USAAnywhere"),
		// 				Properties: &armappservice.WorkflowEnvelopeProperties{
		// 					FlowState: to.Ptr(armappservice.WorkflowStateEnabled),
		// 					Health: &armappservice.WorkflowHealth{
		// 						Error: &armappservice.ErrorEntity{
		// 							Code: to.Ptr("InvalidWorkflowJson"),
		// 							Message: to.Ptr("Invalid character after parsing property name. Expected ':' but got: \". Path '', line 2, position 2."),
		// 						},
		// 						State: to.Ptr(armappservice.WorkflowHealthStateUnhealthy),
		// 					},
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

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

{
  "nextLink": null,
  "value": [
    {
      "name": "testsite2/a1",
      "type": "Microsoft.Web/sites/workflows",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows/a1",
      "kind": "Stateful",
      "location": "USAAnywhere",
      "properties": {
        "flowState": "Enabled",
        "health": {
          "state": "Healthy"
        }
      }
    },
    {
      "name": "testsite2/stateful2",
      "type": "Microsoft.Web/sites/workflows",
      "id": "/subscriptions/testsub/resourceGroups/testrg/providers/Microsoft.Web/sites/testsite2/workflows/stateful2",
      "kind": "Stateful",
      "location": "USAAnywhere",
      "properties": {
        "flowState": "Enabled",
        "health": {
          "error": {
            "code": "InvalidWorkflowJson",
            "message": "Invalid character after parsing property name. Expected ':' but got: \". Path '', line 2, position 2."
          },
          "state": "Unhealthy"
        }
      }
    }
  ]
}

Definiciones

Nombre	Description
createdByType	El tipo de identidad que creó el recurso.
DefaultErrorResponse	Respuesta de error de App Service.
DefaultErrorResponseError	Modelo de error.
DefaultErrorResponseErrorDetailsItem	Errores detallados.
ErrorEntity	Cuerpo de la respuesta de error devuelta desde la API.
systemData	Metadatos relativos a la creación y última modificación del recurso.
WorkflowEnvelope	Definición de propiedades de flujo de trabajo.
WorkflowEnvelopeCollection	Colección de elementos de información de flujo de trabajo de Kudu.
WorkflowEnvelopeProperties	Propiedades de flujo de trabajo adicionales.
WorkflowHealth	Representa el estado del flujo de trabajo.
WorkflowHealthState	Obtiene o establece el estado de mantenimiento del flujo de trabajo.
WorkflowState	Estado del flujo de trabajo.

createdByType

Enumeración

El tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Objeto

Respuesta de error de App Service.

Nombre	Tipo	Description
error	DefaultErrorResponseError	Modelo de error.

DefaultErrorResponseError

Objeto

Modelo de error.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar el error mediante programación.
details	DefaultErrorResponseErrorDetailsItem[]	Errores detallados.
innererror	string	Más información para depurar el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

DefaultErrorResponseErrorDetailsItem

Objeto

Errores detallados.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar el error mediante programación.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

ErrorEntity

Objeto

Cuerpo de la respuesta de error devuelta desde la API.

Nombre	Tipo	Description
code	string	Código de error básico.
details	ErrorEntity[]	Detalles del error.
extendedCode	string	Tipo de error.
innerErrors	ErrorEntity[]	Errores internos.
message	string	Cualquier detalle del error.
messageTemplate	string	Plantilla de mensaje.
parameters	string[]	Parámetros de la plantilla.
target	string	Destino del error.

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	La marca de tiempo de la creación de recursos (UTC).
createdBy	string	La identidad que creó el recurso.
createdByType	createdByType	El tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	La marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	La identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	El tipo de identidad que modificó por última vez el recurso.

WorkflowEnvelope

Objeto

Definición de propiedades de flujo de trabajo.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo de recurso.
location	string	Ubicación del recurso.
name	string	Nombre del recurso
properties	WorkflowEnvelopeProperties	Propiedades de flujo de trabajo adicionales.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WorkflowEnvelopeCollection

Objeto

Colección de elementos de información de flujo de trabajo de Kudu.

Nombre	Tipo	Description
nextLink	string (uri)	Vínculo a la página siguiente de elementos
value	WorkflowEnvelope[]	Los elementos de WorkflowEnvelope en esta página

WorkflowEnvelopeProperties

Objeto

Propiedades de flujo de trabajo adicionales.

Nombre	Tipo	Description
files		Obtiene o establece los archivos.
flowState	WorkflowState	Obtiene o establece el estado del flujo de trabajo.
health	WorkflowHealth	Obtiene o establece el estado del flujo de trabajo.

WorkflowHealth

Objeto

Representa el estado del flujo de trabajo.

Nombre	Tipo	Description
error	ErrorEntity	Obtiene o establece el error de flujo de trabajo.
state	WorkflowHealthState	Obtiene o establece el estado de mantenimiento del flujo de trabajo.

WorkflowHealthState

Enumeración

Obtiene o establece el estado de mantenimiento del flujo de trabajo.

Valor	Description
NotSpecified
Healthy
Unhealthy
Unknown

WorkflowState

Enumeración

Estado del flujo de trabajo.

Valor	Description
NotSpecified
Completed
Enabled
Disabled
Deleted
Suspended