Workflow Run Actions - Get

Service:

App Service

API Version:

2024-04-01

Gets a workflow run action.

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=2024-04-01

URI Parameters

Name	In	Required	Type	Description
actionName	path	True	string	The workflow action name.
name	path	True	string	Site name.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Name of the resource group to which the resource belongs.
runName	path	True	string	The workflow run name.
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
workflowName	path	True	string	The workflow name.
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	WorkflowRunAction	OK
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

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=2024-04-01

Java

/**
 * Samples for WorkflowRunActions Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-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/2024-04-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/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-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");
require("dotenv/config");

/**
 * 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/2024-04-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

dotnet

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

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActions_Get.json
// this example is just showing the usage of "WorkflowRunActions_Get" 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 WorkflowRunActionResource created on azure
// for more information of creating WorkflowRunActionResource, please refer to the document of WorkflowRunActionResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "test-resource-group";
string name = "test-name";
string workflowName = "test-workflow";
string runName = "08586676746934337772206998657CU22";
string actionName = "HTTP";
ResourceIdentifier workflowRunActionResourceId = WorkflowRunActionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, workflowName, runName, actionName);
WorkflowRunActionResource workflowRunAction = client.GetWorkflowRunActionResource(workflowRunActionResourceId);

// invoke the operation
WorkflowRunActionResource result = await workflowRunAction.GetAsync();

// the variable result 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
WorkflowRunActionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Definitions

Name	Description
ContentHash	The content hash.
ContentLink	The content link.
ErrorProperties	Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.
ErrorResponse	Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.
Object
RetryHistory	The retry history.
RunActionCorrelation	The workflow run action correlation properties.
WorkflowRunAction	The workflow run action.
WorkflowStatus	The workflow status.

ContentHash

Object

The content hash.

Name	Type	Description
algorithm	string	The algorithm of the content hash.
value	string	The value of the content hash.

ContentLink

Object

The content link.

Name	Type	Description
contentHash	ContentHash	The content hash.
contentSize	integer (int64)	The content size.
contentVersion	string	The content version.
metadata	Object	The metadata.
uri	string	The content link URI.

ErrorProperties

Object

Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

ErrorResponse

Object

Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.

Name	Type	Description
error	ErrorProperties	The error properties.

Object

Object

RetryHistory

Object

The retry history.

Name	Type	Description
clientRequestId	string	Gets the client request Id.
code	string	Gets the status code.
endTime	string (date-time)	Gets the end time.
error	ErrorResponse	Gets the error response.
serviceRequestId	string	Gets the service request Id.
startTime	string (date-time)	Gets the start time.

RunActionCorrelation

Object

The workflow run action correlation properties.

Name	Type	Description
actionTrackingId	string	The action tracking identifier.
clientKeywords	string[]	The client keywords.
clientTrackingId	string	The client tracking identifier.

WorkflowRunAction

Object

The workflow run action.

Name	Type	Description
id	string	The resource id.
name	string	Gets the workflow run action name.
properties.code	string	Gets the code.
properties.correlation	RunActionCorrelation	The correlation properties.
properties.endTime	string (date-time)	Gets the end time.
properties.error	Object	Gets the error.
properties.inputsLink	ContentLink	Gets the link to inputs.
properties.outputsLink	ContentLink	Gets the link to outputs.
properties.retryHistory	RetryHistory[]	Gets the retry histories.
properties.startTime	string (date-time)	Gets the start time.
properties.status	WorkflowStatus	Gets the status.
properties.trackedProperties	Object	Gets the tracked properties.
properties.trackingId	string	Gets the tracking id.
type	string	Gets the workflow run action type.

WorkflowStatus

Enumeration

The workflow status.

Value	Description
NotSpecified
Paused
Running
Waiting
Succeeded
Skipped
Suspended
Cancelled
Failed
Faulted
TimedOut
Aborted
Ignored