Workflow Run Actions - Get

Service:

App Service

API Version:

2023-01-01

Obtém uma ação 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/{actionName}?api-version=2023-01-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
actionName	path	True	string	O nome da ação do fluxo de trabalho.
name	path	True	string	Nome do site.
resourceGroupName	path	True	string	Nome do grupo de recursos ao qual pertence o recurso. Regex pattern: ^[-\w\._\(\)]+[^\.]$
runName	path	True	string	O nome da execução do fluxo de trabalho.
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

Respostas

Nome	Tipo	Description
200 OK	WorkflowRunAction	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

Get a workflow run action

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

Java

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


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/WorkflowRunActions_Get.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_Get.json
func ExampleWorkflowRunActionsClient_Get() {
	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)
	}
	res, err := clientFactory.NewWorkflowRunActionsClient().Get(ctx, "test-resource-group", "test-name", "test-workflow", "08586676746934337772206998657CU22", "HTTP", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WorkflowRunAction = 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 workflow run action.
 *
 * @summary Gets a workflow run action.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/WorkflowRunActions_Get.json
 */
async function getAWorkflowRunAction() {
  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 actionName = "HTTP";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.workflowRunActions.get(
    resourceGroupName,
    name,
    workflowName,
    runName,
    actionName
  );
  console.log(result);
}

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

{
  "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

Nome	Description
ContentHash	O hash de conteúdo.
ContentLink	O link de conteúdo.
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.
Object
RetryHistory	O histórico de repetição.
RunActionCorrelation	As propriedades de correlação de ação de execução de fluxo de trabalho.
WorkflowRunAction	A ação de execução do fluxo de trabalho.
WorkflowStatus	O fluxo de trabalho status.

ContentHash

O hash de conteúdo.

Nome	Tipo	Description
algorithm	string	O algoritmo do hash de conteúdo.
value	string	O valor do hash de conteúdo.

ContentLink

O link de conteúdo.

Nome	Tipo	Description
contentHash	ContentHash	O hash de conteúdo.
contentSize	integer	O tamanho do conteúdo.
contentVersion	string	A versão do conteúdo.
metadata	Object	Os metadados.
uri	string	O URI do link de conteúdo.

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.

Object

RetryHistory

O histórico de repetição.

Nome	Tipo	Description
clientRequestId	string	Obtém a ID da solicitação do cliente.
code	string	Obtém o código de status.
endTime	string	Obtém a hora de término.
error	ErrorResponse	Obtém a resposta de erro.
serviceRequestId	string	Obtém a ID da solicitação de serviço.
startTime	string	Obtém a hora de início.

RunActionCorrelation

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

Nome	Tipo	Description
actionTrackingId	string	O identificador de acompanhamento de ação.
clientKeywords	string[]	As palavras-chave do cliente.
clientTrackingId	string	O identificador de rastreamento do cliente.

WorkflowRunAction

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

Nome	Tipo	Description
id	string	A 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 término.
properties.error	Object	Obtém o erro.
properties.inputsLink	ContentLink	Obtém o link para entradas.
properties.outputsLink	ContentLink	Obtém o link para saídas.
properties.retryHistory	RetryHistory[]	Obtém os históricos de repetição.
properties.startTime	string	Obtém a hora de início.
properties.status	WorkflowStatus	Obtém o status.
properties.trackedProperties	Object	Obtém as propriedades controladas.
properties.trackingId	string	Obtém a ID de rastreamento.
type	string	Obtém o tipo de ação de execução de fluxo de trabalho.

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