Workflow Runs - Get

Layanan:

App Service

Versi API:

2024-11-01

Mendapatkan eksekusi alur kerja.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
name	path	True	string	Nama situs.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nama grup sumber daya tempat sumber daya berada.
runName	path	True	string	Nama eksekusi alur kerja.
subscriptionId	path	True	string	ID langganan Azure Anda. Ini adalah string berformat GUID (misalnya 000000000-0000-0000-0000-000000000000).
workflowName	path	True	string	Nama alur kerja.
api-version	query	True	string	Versi API

Respons

Nama	Jenis	Deskripsi
200 OK	WorkflowRun	OKE
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Get a run for a workflow

Permintaan sampel

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?api-version=2024-11-01

Java

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


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/WorkflowRuns_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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/WorkflowRuns_Get.json
func ExampleWorkflowRunsClient_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.NewWorkflowRunsClient().Get(ctx, "test-resource-group", "test-name", "test-workflow", "08586676746934337772206998657CU22", 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.WorkflowRun = armappservice.WorkflowRun{
	// 	ID: to.Ptr("/workflows/test-workflow/runs/08586676746934337772206998657CU22"),
	// 	Name: to.Ptr("08586676746934337772206998657CU22"),
	// 	Type: to.Ptr("workflows/runs"),
	// 	Properties: &armappservice.WorkflowRunProperties{
	// 		Correlation: &armappservice.Correlation{
	// 			ClientTrackingID: to.Ptr("08586676746934337772206998657CU22"),
	// 		},
	// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-10T20:16:32.577Z"); return t}()),
	// 		Outputs: map[string]*armappservice.WorkflowOutputParameter{
	// 		},
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-10T20:16:32.044Z"); return t}()),
	// 		Status: to.Ptr(armappservice.WorkflowStatusSucceeded),
	// 		Trigger: &armappservice.WorkflowRunTrigger{
	// 			Name: to.Ptr("Recurrence"),
	// 			Code: to.Ptr("OK"),
	// 			Correlation: &armappservice.Correlation{
	// 				ClientTrackingID: to.Ptr("08586676746934337772206998657CU22"),
	// 			},
	// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-10T20:16:32.038Z"); return t}()),
	// 			ScheduledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-10T20:16:31.634Z"); return t}()),
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-10T20:16:32.038Z"); return t}()),
	// 			Status: to.Ptr(armappservice.WorkflowStatusSucceeded),
	// 		},
	// 		WaitEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-10T20:16:32.044Z"); return t}()),
	// 		Workflow: &armappservice.ResourceReference{
	// 			Name: to.Ptr("08586676754160363885"),
	// 			Type: to.Ptr("workflows/versions"),
	// 			ID: to.Ptr("/workflows/test-workflow/versions/08586676754160363885"),
	// 		},
	// 	},
	// }
}

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.
 *
 * @summary Gets a workflow run.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/WorkflowRuns_Get.json
 */
async function getARunForAWorkflow() {
  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 result = await client.workflowRuns.get(resourceGroupName, name, workflowName, runName);
  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;

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

// invoke the operation
WorkflowRunResource result = await workflowRun.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
WorkflowRunData 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

Respon sampel

Kode status:

200

{
  "properties": {
    "waitEndTime": "2018-08-10T20:16:32.044238Z",
    "startTime": "2018-08-10T20:16:32.044238Z",
    "endTime": "2018-08-10T20:16:32.5779999Z",
    "status": "Succeeded",
    "correlation": {
      "clientTrackingId": "08586676746934337772206998657CU22"
    },
    "workflow": {
      "id": "/workflows/test-workflow/versions/08586676754160363885",
      "name": "08586676754160363885",
      "type": "workflows/versions"
    },
    "trigger": {
      "name": "Recurrence",
      "startTime": "2018-08-10T20:16:32.0387927Z",
      "endTime": "2018-08-10T20:16:32.0387927Z",
      "scheduledTime": "2018-08-10T20:16:31.6344174Z",
      "correlation": {
        "clientTrackingId": "08586676746934337772206998657CU22"
      },
      "code": "OK",
      "status": "Succeeded"
    },
    "outputs": {}
  },
  "id": "/workflows/test-workflow/runs/08586676746934337772206998657CU22",
  "name": "08586676746934337772206998657CU22",
  "type": "workflows/runs"
}

Definisi

Nama	Deskripsi
ContentHash	Hash konten.
ContentLink	Tautan konten.
Correlation	Properti korelasi.
ErrorProperties	Properti kesalahan menunjukkan mengapa layanan Logika tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.
ErrorResponse	Respons kesalahan menunjukkan layanan Logika tidak dapat memproses permintaan masuk. Properti kesalahan berisi detail kesalahan.
Object
ParameterType	Jenis parameter.
ResourceReference	Referensi sumber daya.
WorkflowOutputParameter	Parameter output alur kerja.
WorkflowRun	Alur kerja berjalan.
WorkflowRunTrigger	Pemicu eksekusi alur kerja.
WorkflowStatus	Status alur kerja.

ContentHash

Objek

Hash konten.

Nama	Jenis	Deskripsi
algorithm	string	Algoritma hash konten.
value	string	Nilai hash konten.

ContentLink

Objek

Tautan konten.

Nama	Jenis	Deskripsi
contentHash	ContentHash	Hash konten.
contentSize	integer (int64)	Ukuran konten.
contentVersion	string	Versi konten.
metadata	Object	Metadata.
uri	string	URI tautan konten.

Correlation

Objek

Properti korelasi.

Nama	Jenis	Deskripsi
clientTrackingId	string	Id pelacakan klien.

ErrorProperties

Objek

Properti kesalahan menunjukkan mengapa layanan Logika tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

ErrorResponse

Objek

Respons kesalahan menunjukkan layanan Logika tidak dapat memproses permintaan masuk. Properti kesalahan berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	ErrorProperties	Properti kesalahan.

Object

Objek

ParameterType

Enumeration

Jenis parameter.

Nilai	Deskripsi
Array
Bool
Float
Int
NotSpecified
Object
SecureObject
SecureString
String

ResourceReference

Objek

Referensi sumber daya.

Nama	Jenis	Deskripsi
id	string	Id sumber daya.
name	string	Mendapatkan nama sumber daya.
type	string	Mendapatkan jenis sumber daya.

WorkflowOutputParameter

Objek

Parameter output alur kerja.

Nama	Jenis	Deskripsi
description	string	Deskripsinya.
error	Object	Mendapatkan kesalahan.
metadata	Object	Metadata.
type	ParameterType	Jenisnya.
value	Object	Nilainya.

WorkflowRun

Objek

Alur kerja berjalan.

Nama	Jenis	Deskripsi
id	string	Id sumber daya.
name	string	Mendapatkan nama eksekusi alur kerja.
properties.code	string	Mendapatkan kodenya.
properties.correlation	Correlation	Korelasi eksekusi.
properties.correlationId	string	Mendapatkan id korelasi.
properties.endTime	string (date-time)	Mendapatkan waktu akhir.
properties.error	Object	Mendapatkan kesalahan.
properties.outputs	<string,  WorkflowOutputParameter>	Mendapatkan output.
properties.response	WorkflowRunTrigger	Mendapatkan respons eksekusi alur.
properties.startTime	string (date-time)	Mendapatkan waktu mulai.
properties.status	WorkflowStatus	Mendapatkan status.
properties.trigger	WorkflowRunTrigger	Mendapatkan pemicu yang diaktifkan.
properties.waitEndTime	string (date-time)	Mendapatkan waktu tunggu berakhir.
properties.workflow	ResourceReference	Mendapatkan referensi ke versi alur kerja.
type	string	Mendapatkan jenis eksekusi alur kerja.

WorkflowRunTrigger

Objek

Pemicu eksekusi alur kerja.

Nama	Jenis	Deskripsi
code	string	Mendapatkan kodenya.
correlation	Correlation	Korelasi eksekusi.
endTime	string (date-time)	Mendapatkan waktu akhir.
error	Object	Mendapatkan kesalahan.
inputs	Object	Mendapatkan input.
inputsLink	ContentLink	Mendapatkan tautan ke input.
name	string	Mendapatkan nama.
outputs	Object	Mendapatkan output.
outputsLink	ContentLink	Mendapatkan tautan ke output.
scheduledTime	string (date-time)	Mendapatkan waktu terjadwal.
startTime	string (date-time)	Mendapatkan waktu mulai.
status	WorkflowStatus	Mendapatkan status.
trackedProperties	Object	Mendapatkan properti yang dilacak.
trackingId	string	Mendapatkan id pelacakan.

WorkflowStatus

Enumeration

Status alur kerja.

Nilai	Deskripsi
Aborted
Cancelled
Failed
Faulted
Ignored
NotSpecified
Paused
Running
Skipped
Succeeded
Suspended
TimedOut
Waiting