Workflow Run Actions - List

Service:

App Service

API Version:

2023-01-01

Obtém uma lista de ações de execução 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}/runs/{runName}/actions?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}/runs/{runName}/actions?api-version=2023-01-01&$top={$top}&$filter={$filter}

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\._\(\)]+[^\.]$
runName	path	True	string	O nome da execução do fluxo de trabalho.
subscriptionId	path	True	string	O seu ID de subscrição do Azure. Esta é uma cadeia formatada por GUID (por exemplo, 0000000000-0000-0000-0000-00000000000000).
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 aplicar na operação. As opções para filtros incluem: Estado.
$top	query		integer int32	O número de itens a incluir no resultado.

Respostas

Name	Tipo	Description
200 OK	WorkflowRunActionListResult	OK
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

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 a workflow run actions

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/runs/08586676746934337772206998657CU22/actions?api-version=2023-01-01

Java

/**
 * Samples for WorkflowRunActions List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/WorkflowRunActions_List.json
     */
    /**
     * Sample code: List a workflow run actions.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAWorkflowRunActions(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWorkflowRunActions().list("test-resource-group", "test-name",
            "test-workflow", "08586676746934337772206998657CU22", 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_run_actions_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_run_actions.list(
        resource_group_name="test-resource-group",
        name="test-name",
        workflow_name="test-workflow",
        run_name="08586676746934337772206998657CU22",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/WorkflowRunActions_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/WorkflowRunActions_List.json
func ExampleWorkflowRunActionsClient_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.NewWorkflowRunActionsClient().NewListPager("test-resource-group", "test-name", "test-workflow", "08586676746934337772206998657CU22", &armappservice.WorkflowRunActionsClientListOptions{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.WorkflowRunActionListResult = armappservice.WorkflowRunActionListResult{
		// 	Value: []*armappservice.WorkflowRunAction{
		// 		{
		// 			ID: to.Ptr("/workflows/test-workflow/runs/08586676746934337772206998657CU22/actions/HTTP"),
		// 			Name: to.Ptr("HTTP"),
		// 			Type: to.Ptr("/workflows/runs/actions"),
		// 			Properties: &armappservice.WorkflowRunActionProperties{
		// 				Code: to.Ptr("OK"),
		// 				Correlation: &armappservice.RunActionCorrelation{
		// 					ClientTrackingID: to.Ptr("08586676746934337772206998657CU22"),
		// 					ActionTrackingID: to.Ptr("56063357-45dd-4278-9be5-8220ce0cc9ca"),
		// 				},
		// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-10T20:16:32.545Z"); return t}()),
		// 				InputsLink: &armappservice.ContentLink{
		// 					ContentSize: to.Ptr[int64](138),
		// 					URI: to.Ptr("https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/000012345678900000000056a41a/runs/00000aaaabbbbccccddddeeeeffff/actions/HTTP/contents/ActionInputs?api-version=2018-11-01&code=examplecode=2022-04-13T03%3A00%3A00.0000000Z&sp=%2Fruns%2F00000aaaabbbbccccddddeeeeffff%2Factions%2FHTTP%2Fcontents%2FActionInputs%2Fread&sv=1.0&sig=dJ6F00000aaaabbbbccccddddeeeeffff78co"),
		// 				},
		// 				OutputsLink: &armappservice.ContentLink{
		// 					ContentSize: to.Ptr[int64](15660),
		// 					URI: to.Ptr("https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/000012345678900000000056a41a/runs/00000aaaabbbbccccddddeeeeffff/actions/HTTP/contents/ActionOutputs?api-version=2018-11-01&code=examplecode=2022-04-13T03%3A00%3A00.0000000Z&sp=%2Fruns%2F00000aaaabbbbccccddddeeeeffff%2Factions%2FHTTP%2Fcontents%2FActionOutputs%2Fread&sv=1.0&sig=fIIgF00000aaaabbbbccccddddeeeeffffWRU0"),
		// 				},
		// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-10T20:16:32.305Z"); return t}()),
		// 				Status: to.Ptr(armappservice.WorkflowStatusSucceeded),
		// 			},
		// 	}},
		// }
	}
}

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 run actions.
 *
 * @summary Gets a list of workflow run actions.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/WorkflowRunActions_List.json
 */
async function listAWorkflowRunActions() {
  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 runName = "08586676746934337772206998657CU22";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.workflowRunActions.list(
    resourceGroupName,
    name,
    workflowName,
    runName
  )) {
    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": {
        "inputsLink": {
          "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/000012345678900000000056a41a/runs/00000aaaabbbbccccddddeeeeffff/actions/HTTP/contents/ActionInputs?api-version=2018-11-01&code=examplecode=2022-04-13T03%3A00%3A00.0000000Z&sp=%2Fruns%2F00000aaaabbbbccccddddeeeeffff%2Factions%2FHTTP%2Fcontents%2FActionInputs%2Fread&sv=1.0&sig=dJ6F00000aaaabbbbccccddddeeeeffff78co",
          "contentSize": 138
        },
        "outputsLink": {
          "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/000012345678900000000056a41a/runs/00000aaaabbbbccccddddeeeeffff/actions/HTTP/contents/ActionOutputs?api-version=2018-11-01&code=examplecode=2022-04-13T03%3A00%3A00.0000000Z&sp=%2Fruns%2F00000aaaabbbbccccddddeeeeffff%2Factions%2FHTTP%2Fcontents%2FActionOutputs%2Fread&sv=1.0&sig=fIIgF00000aaaabbbbccccddddeeeeffffWRU0",
          "contentSize": 15660
        },
        "startTime": "2018-08-10T20:16:32.305236Z",
        "endTime": "2018-08-10T20:16:32.5450625Z",
        "correlation": {
          "actionTrackingId": "56063357-45dd-4278-9be5-8220ce0cc9ca",
          "clientTrackingId": "08586676746934337772206998657CU22"
        },
        "status": "Succeeded",
        "code": "OK"
      },
      "id": "/workflows/test-workflow/runs/08586676746934337772206998657CU22/actions/HTTP",
      "name": "HTTP",
      "type": "/workflows/runs/actions"
    }
  ]
}

Definições

Name	Description
ContentHash	O conteúdo Hash.
ContentLink	A ligação de conteúdo.
ErrorProperties	As propriedades do erro indicam o motivo pelo qual o serviço Logic não conseguiu processar o pedido recebido. O motivo é fornecido na mensagem de erro.
ErrorResponse	A resposta a erros indica que o Serviço de lógica não consegue processar o pedido recebido. A propriedade de erro contém os detalhes do erro.
Object
RetryHistory	O histórico de repetições.
RunActionCorrelation	As propriedades de correlação da ação de execução do fluxo de trabalho.
WorkflowRunAction	A ação de execução do fluxo de trabalho.
WorkflowRunActionListResult	A lista de ações de execução de fluxo de trabalho.
WorkflowStatus	O estado do fluxo de trabalho.

ContentHash

O conteúdo Hash.

Name	Tipo	Description
algorithm	string	O algoritmo do Hash de conteúdo.
value	string	O valor do conteúdo Hash.

ContentLink

A ligação de conteúdo.

Name	Tipo	Description
contentHash	ContentHash	O conteúdo Hash.
contentSize	integer	O tamanho do conteúdo.
contentVersion	string	A versão de conteúdo.
metadata	Object	Os metadados.
uri	string	O URI da ligação de conteúdo.

ErrorProperties

As propriedades do erro indicam o motivo pelo qual o serviço Logic não conseguiu processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro a indicar por que motivo a operação falhou.

ErrorResponse

A resposta a erros indica que o Serviço de lógica não consegue processar o pedido recebido. A propriedade de erro contém os detalhes do erro.

Name	Tipo	Description
error	ErrorProperties	As propriedades do erro.

Object

RetryHistory

O histórico de repetições.

Name	Tipo	Description
clientRequestId	string	Obtém o ID do pedido de cliente.
code	string	Obtém o código de estado.
endTime	string	Obtém a hora de fim.
error	ErrorResponse	Obtém a resposta de erro.
serviceRequestId	string	Obtém o ID do pedido de serviço.
startTime	string	Obtém a hora de início.

RunActionCorrelation

As propriedades de correlação da ação de execução do fluxo de trabalho.

Name	Tipo	Description
actionTrackingId	string	O identificador de controlo de ações.
clientKeywords	string[]	As palavras-chave do cliente.
clientTrackingId	string	O identificador de controlo de cliente.

WorkflowRunAction

A ação de execução do fluxo de trabalho.

Name	Tipo	Description
id	string	O ID do recurso.
name	string	Obtém o nome da ação de execução do fluxo de trabalho.
properties.code	string	Obtém o código.
properties.correlation	RunActionCorrelation	As propriedades de correlação.
properties.endTime	string	Obtém a hora de fim.
properties.error	Object	Obtém o erro.
properties.inputsLink	ContentLink	Obtém a ligação para entradas.
properties.outputsLink	ContentLink	Obtém a ligação para saídas.
properties.retryHistory	RetryHistory[]	Obtém as histórias de repetição.
properties.startTime	string	Obtém a hora de início.
properties.status	WorkflowStatus	Obtém o estado.
properties.trackedProperties	Object	Obtém as propriedades registadas.
properties.trackingId	string	Obtém o ID de controlo.
type	string	Obtém o tipo de ação de execução do fluxo de trabalho.

WorkflowRunActionListResult

A lista de ações de execução de fluxo de trabalho.

Name	Tipo	Description
nextLink	string	O URL para obter o próximo conjunto de resultados.
value	WorkflowRunAction[]	Uma lista de ações de execução de fluxo de trabalho.

WorkflowStatus

O estado do fluxo de trabalho.

Name	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