Workflow Triggers - List

Service:

App Service

API Version:

2023-01-01

Obtém uma lista de gatilhos de fluxo de trabalho.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers?api-version=2023-01-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers?api-version=2023-01-01&$top={$top}&$filter={$filter}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
name	path	True	string	Nome do site.
resourceGroupName	path	True	string	Nome do grupo de recursos ao qual pertence o recurso. Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Sua ID da assinatura do Azure. Esta é uma cadeia de caracteres formatada em GUID (por exemplo, 00000000-0000-0000-0000-0000000000000000000000).
workflowName	path	True	string	O nome do fluxo de trabalho.
api-version	query	True	string	Versão da API
$filter	query		string	O filtro a ser aplicado na operação.
$top	query		integer int32	O número de itens a serem incluídos no resultado.

Respostas

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

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

List workflow triggers

Sample Request

HTTP

GET 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/triggers?api-version=2023-01-01

Java

/**
 * Samples for WorkflowTriggers List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/WorkflowTriggers_List.json
     */
    /**
     * Sample code: List workflow triggers.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listWorkflowTriggers(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWorkflowTriggers().list("test-resource-group", "test-name",
            "test-workflow", null, null, 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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python workflow_triggers_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.workflow_triggers.list(
        resource_group_name="test-resource-group",
        name="test-name",
        workflow_name="test-workflow",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/WorkflowTriggers_List.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/738ab25fe76324897f273645906d4a0415068a6c/specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/WorkflowTriggers_List.json
func ExampleWorkflowTriggersClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWorkflowTriggersClient().NewListPager("test-resource-group", "test-name", "test-workflow", &armappservice.WorkflowTriggersClientListOptions{Top: nil,
		Filter: 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.WorkflowTriggerListResult = armappservice.WorkflowTriggerListResult{
		// 	Value: []*armappservice.WorkflowTrigger{
		// 		{
		// 			ID: to.Ptr("/workflows/test-workflow/triggers/manual"),
		// 			Name: to.Ptr("manual"),
		// 			Type: to.Ptr("/workflows/triggers"),
		// 			Properties: &armappservice.WorkflowTriggerProperties{
		// 				ChangedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-10T18:47:49.528Z"); return t}()),
		// 				CreatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-10T17:32:30.249Z"); return t}()),
		// 				ProvisioningState: to.Ptr(armappservice.WorkflowTriggerProvisioningStateSucceeded),
		// 				State: to.Ptr(armappservice.WorkflowStateEnabled),
		// 				Workflow: &armappservice.ResourceReference{
		// 					Name: to.Ptr("08586676800160476478"),
		// 					Type: to.Ptr("/workflows/versions"),
		// 					ID: to.Ptr("/workflows/test-workflow/versions/08586676800160476478"),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a list of workflow triggers.
 *
 * @summary Gets a list of workflow triggers.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/WorkflowTriggers_List.json
 */
async function listWorkflowTriggers() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "test-resource-group";
  const name = "test-name";
  const workflowName = "test-workflow";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.workflowTriggers.list(resourceGroupName, name, workflowName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "properties": {
        "provisioningState": "Succeeded",
        "createdTime": "2018-08-10T17:32:30.2496336Z",
        "changedTime": "2018-08-10T18:47:49.5288666Z",
        "state": "Enabled",
        "workflow": {
          "id": "/workflows/test-workflow/versions/08586676800160476478",
          "name": "08586676800160476478",
          "type": "/workflows/versions"
        }
      },
      "id": "/workflows/test-workflow/triggers/manual",
      "name": "manual",
      "type": "/workflows/triggers"
    }
  ]
}

Definições

Nome	Description
DayOfWeek	O dia da semana.
DaysOfWeek	Os dias da semana.
ErrorProperties	As propriedades de erro indicam por que o serviço lógico não pô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 error contém os detalhes do erro.
RecurrenceFrequency	A frequência de recorrência.
RecurrenceSchedule	O agendamento de recorrência.
RecurrenceScheduleOccurrence	A ocorrência de agendamento de recorrência.
ResourceReference	A referência de recurso.
WorkflowState	O estado do fluxo de trabalho.
WorkflowStatus	O fluxo de trabalho status.
WorkflowTrigger	O gatilho de fluxo de trabalho.
WorkflowTriggerListResult	A lista de gatilhos de fluxo de trabalho.
WorkflowTriggerProvisioningState	O estado de provisionamento do gatilho de fluxo de trabalho.
WorkflowTriggerRecurrence	A recorrência do gatilho de fluxo de trabalho.

DayOfWeek

O dia da semana.

Nome	Tipo	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

DaysOfWeek

Os dias da semana.

Nome	Tipo	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ErrorProperties

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

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

ErrorResponse

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

Nome	Tipo	Description
error	ErrorProperties	As propriedades de erro.

RecurrenceFrequency

A frequência de recorrência.

Nome	Tipo	Description
Day	string
Hour	string
Minute	string
Month	string
NotSpecified	string
Second	string
Week	string
Year	string

RecurrenceSchedule

O agendamento de recorrência.

Nome	Tipo	Description
hours	integer[]	As horas.
minutes	integer[]	Os minutos.
monthDays	integer[]	Os dias do mês.
monthlyOccurrences	RecurrenceScheduleOccurrence[]	As ocorrências mensais.
weekDays	DaysOfWeek[]	Os dias da semana.

RecurrenceScheduleOccurrence

A ocorrência de agendamento de recorrência.

Nome	Tipo	Description
day	DayOfWeek	O dia da semana.
occurrence	integer	A ocorrência.

ResourceReference

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.

WorkflowState

O estado do fluxo de trabalho.

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

WorkflowStatus

O fluxo de trabalho status.

Nome	Tipo	Description
Aborted	string
Cancelled	string
Failed	string
Faulted	string
Ignored	string
NotSpecified	string
Paused	string
Running	string
Skipped	string
Succeeded	string
Suspended	string
TimedOut	string
Waiting	string

WorkflowTrigger

O gatilho de fluxo de trabalho.

Nome	Tipo	Description
id	string	A ID do recurso.
name	string	Obtém o nome do gatilho de fluxo de trabalho.
properties.changedTime	string	Obtém o tempo alterado.
properties.createdTime	string	Obtém a hora criada.
properties.lastExecutionTime	string	Obtém o último tempo de execução.
properties.nextExecutionTime	string	Obtém o próximo tempo de execução.
properties.provisioningState	WorkflowTriggerProvisioningState	Obtém o estado de provisionamento.
properties.recurrence	WorkflowTriggerRecurrence	Obtém a recorrência do gatilho de fluxo de trabalho.
properties.state	WorkflowState	Obtém o estado.
properties.status	WorkflowStatus	Obtém o status.
properties.workflow	ResourceReference	Obtém a referência ao fluxo de trabalho.
type	string	Obtém o tipo de gatilho de fluxo de trabalho.

WorkflowTriggerListResult

A lista de gatilhos de fluxo de trabalho.

Nome	Tipo	Description
nextLink	string	A URL para obter o próximo conjunto de resultados.
value	WorkflowTrigger[]	Uma lista de gatilhos de fluxo de trabalho.

WorkflowTriggerProvisioningState

O estado de provisionamento do gatilho de fluxo de trabalho.

Nome	Tipo	Description
Accepted	string
Canceled	string
Completed	string
Created	string
Creating	string
Deleted	string
Deleting	string
Failed	string
Moving	string
NotSpecified	string
Ready	string
Registered	string
Registering	string
Running	string
Succeeded	string
Unregistered	string
Unregistering	string
Updating	string

WorkflowTriggerRecurrence

A recorrência do gatilho de fluxo de trabalho.

Nome	Tipo	Description
endTime	string	A hora de término.
frequency	RecurrenceFrequency	A frequência.
interval	integer	O intervalo.
schedule	RecurrenceSchedule	O agendamento de recorrência.
startTime	string	A hora de início.
timeZone	string	O fuso horário.