Web Apps - List Workflows

Service:

App Service

API Version:

2023-12-01

Liste os fluxos de trabalho de um web site ou um bloco de implementação.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
name	path	True	string	Nome do site.
resourceGroupName	path	True	string	Nome do grupo de recursos ao qual o recurso pertence. Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	O seu ID de subscrição do Azure. Esta é uma cadeia formatada com GUID (por exemplo, 000000000-0000-0000-0000-000000000000).
api-version	query	True	string	Versão da API

Respostas

Name	Tipo	Description
200 OK	WorkflowEnvelopeCollection	Informações de fluxo de trabalho devolvidas.
Other Status Codes	DefaultErrorResponse	Serviço de Aplicações resposta de erro.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

List the workflows

Sample Request

HTTP

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

Sample Response

Status code:

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

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

DefaultErrorResponse

Serviço de Aplicações resposta de erro.

Name	Tipo	Description
error	Error	Modelo de erro.

Details

Name	Tipo	Description
code	string	Cadeia padronizada para identificar programaticamente o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

Error

Modelo de erro.

Name	Tipo	Description
code	string	Cadeia padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

ErrorEntity

Corpo da resposta de erro devolvida pela API.

Name	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	Quaisquer detalhes do erro.
messageTemplate	string	Modelo de mensagem.
parameters	string[]	Parâmetros para o modelo.
target	string	O destino do erro.

Properties

Propriedades de fluxo de trabalho adicionais.

Name	Tipo	Description
files	object	Obtém ou define os ficheiros.
flowState	WorkflowState	Obtém ou define o estado do fluxo de trabalho.
health	WorkflowHealth	Obtém ou define o estado de funcionamento do fluxo de trabalho.

WorkflowEnvelope

Definição de propriedades do fluxo de trabalho.

Name	Tipo	Description
id	string	O ID do recurso.
kind	string	O tipo de recurso.
location	string	A localização 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

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

Name	Tipo	Description
nextLink	string	Ligação para a página seguinte de recursos.
value	WorkflowEnvelope[]	Coleção de recursos.

WorkflowHealth

Representa o estado de funcionamento do fluxo de trabalho.

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

WorkflowHealthState

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

Name	Tipo	Description
Healthy	string
NotSpecified	string
Unhealthy	string
Unknown	string

WorkflowState

O estado do fluxo de trabalho.

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