Web Apps - List Workflows

Referência

Serviço:: App Service

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

Liste os fluxos de trabalho para um site ou um slot de implantação.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows?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).
api-version	query	True	string	Versão da API

Respostas

Nome	Tipo	Description
200 OK	WorkflowEnvelopeCollection	Informações de fluxo de trabalho retornadas.
Other Status Codes	DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.

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

List the workflows

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListWorkflows.json
// this example is just showing the usage of "WebApps_ListWorkflows" 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 = "testrg123";
string name = "testsite2";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);

// get the collection of this SiteWorkflowResource
SiteWorkflowCollection collection = webSite.GetSiteWorkflows();

// invoke the operation and iterate over the result
await foreach (SiteWorkflowResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    WorkflowEnvelopeData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

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

Definições

Nome	Description
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
Details
Error	Modelo de erro.
ErrorEntity	Corpo da resposta de erro retornada da API.
Properties	Propriedades de fluxo de trabalho adicionais.
WorkflowEnvelope	Definição de propriedades de fluxo de trabalho.
WorkflowEnvelopeCollection	Coleção de elementos de informações de fluxo de trabalho do Kudu.
WorkflowHealth	Representa a integridade do fluxo de trabalho.
WorkflowHealthState	Obtém ou define o estado de integridade do fluxo de trabalho.
WorkflowState	O estado do fluxo de trabalho.

DefaultErrorResponse

Objeto

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Objeto

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

Error

Objeto

Modelo de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

ErrorEntity

Objeto

Corpo da resposta de erro retornada da API.

Nome	Tipo	Description
code	string	Código de erro básico.
details	ErrorEntity[]	Detalhes do erro.
extendedCode	string	Tipo de erro.
innerErrors	ErrorEntity[]	Erros internos.
message	string	Todos os detalhes do erro.
messageTemplate	string	Modelo de mensagem.
parameters	string[]	Parâmetros para o modelo.
target	string	O destino do erro.

Properties

Objeto

Propriedades de fluxo de trabalho adicionais.

Nome	Tipo	Description
files	object	Obtém ou define os arquivos.
flowState	WorkflowState	Obtém ou define o estado do fluxo de trabalho.
health	WorkflowHealth	Obtém ou define a integridade do fluxo de trabalho.

WorkflowEnvelope

Objeto

Definição de propriedades de fluxo de trabalho.

Nome	Tipo	Description
id	string	A ID do recurso.
kind	string	O tipo de recurso.
location	string	O local do recurso.
name	string	Obtém o nome do recurso.
properties	Properties	Propriedades de fluxo de trabalho adicionais.
type	string	Obtém o tipo de recurso.

WorkflowEnvelopeCollection

Objeto

Coleção de elementos de informações de fluxo de trabalho do Kudu.

Nome	Tipo	Description
nextLink	string	Link para a próxima página de recursos.
value	WorkflowEnvelope[]	Coleção de recursos.

WorkflowHealth

Objeto

Representa a integridade do fluxo de trabalho.

Nome	Tipo	Description
error	ErrorEntity	Obtém ou define o erro de fluxo de trabalho.
state	WorkflowHealthState	Obtém ou define o estado de integridade do fluxo de trabalho.

WorkflowHealthState

Enumeração

Obtém ou define o estado de integridade do fluxo de trabalho.

Valor	Description
Healthy
NotSpecified
Unhealthy
Unknown

WorkflowState

Enumeração

O estado do fluxo de trabalho.

Valor	Description
Completed
Deleted
Disabled
Enabled
NotSpecified
Suspended

Compartilhar via

Web Apps - List Workflows

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

List the workflows

Solicitação de exemplo

Resposta de exemplo

Definições

DefaultErrorResponse

Details

Error

ErrorEntity

Properties

WorkflowEnvelope

WorkflowEnvelopeCollection

WorkflowHealth

WorkflowHealthState

WorkflowState