Workflow Trigger Histories - List

Szolgáltatás:

App Service

API-verzió:

2024-04-01

Lekéri a munkafolyamat-eseményindítók előzményeinek listáját.

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
name	path	True	string	Webhely neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Annak az erőforráscsoportnak a neve, amelyhez az erőforrás tartozik.
subscriptionId	path	True	string	Az Azure-előfizetés azonosítója. Ez egy GUID formátumú sztring (például 000000000-0000-0000-0000-0000000000).
triggerName	path	True	string	A munkafolyamat-eseményindító neve.
workflowName	path	True	string	A munkafolyamat neve.
api-version	query	True	string	API-verzió
$filter	query		string	A műveletre alkalmazandó szűrő. A szűrők beállításai a következők: Állapot, StartTime és ClientTrackingId.
$top	query		integer (int32)	Az eredményben szerepeltetni kívánt elemek száma.

Válaszok

Name	Típus	Description
200 OK	WorkflowTriggerHistoryListResult	OKÉ
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

List a workflow trigger history

Mintakérelem

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Web/sites/test-name/hostruntime/runtime/webhooks/workflow/api/management/workflows/testWorkflowName/triggers/testTriggerName/histories?api-version=2024-04-01

Java

/**
 * Samples for WorkflowTriggerHistories List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_List.json
     */
    /**
     * Sample code: List a workflow trigger history.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAWorkflowTriggerHistory(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWorkflowTriggerHistories().list("testResourceGroup", "test-name",
            "testWorkflowName", "testTriggerName", 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_trigger_histories_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_trigger_histories.list(
        resource_group_name="testResourceGroup",
        name="test-name",
        workflow_name="testWorkflowName",
        trigger_name="testTriggerName",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_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/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/WorkflowTriggerHistories_List.json
func ExampleWorkflowTriggerHistoriesClient_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.NewWorkflowTriggerHistoriesClient().NewListPager("testResourceGroup", "test-name", "testWorkflowName", "testTriggerName", &armappservice.WorkflowTriggerHistoriesClientListOptions{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.WorkflowTriggerHistoryListResult = armappservice.WorkflowTriggerHistoryListResult{
		// 	Value: []*armappservice.WorkflowTriggerHistory{
		// 		{
		// 			ID: to.Ptr("/workflows/testWorkflowName/triggers/testTriggerName/histories/08586676746934337772206998657CU22"),
		// 			Name: to.Ptr("08586676746934337772206998657CU22"),
		// 			Type: to.Ptr("/workflows/triggers/histories"),
		// 			Properties: &armappservice.WorkflowTriggerHistoryProperties{
		// 				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.298Z"); return t}()),
		// 				Fired: to.Ptr(true),
		// 				Run: &armappservice.ResourceReference{
		// 					Name: to.Ptr("08586676746934337772206998657CU22"),
		// 					Type: to.Ptr("/workflows/runs"),
		// 					ID: to.Ptr("/workflows/testWorkflowName/runs/08586676746934337772206998657CU22"),
		// 				},
		// 				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),
		// 			},
		// 	}},
		// }
	}
}

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 list of workflow trigger histories.
 *
 * @summary Gets a list of workflow trigger histories.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowTriggerHistories_List.json
 */
async function listAWorkflowTriggerHistory() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testResourceGroup";
  const name = "test-name";
  const workflowName = "testWorkflowName";
  const triggerName = "testTriggerName";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.workflowTriggerHistories.list(
    resourceGroupName,
    name,
    workflowName,
    triggerName,
  )) {
    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

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-04-01/examples/WorkflowTriggerHistories_List.json
// this example is just showing the usage of "WorkflowTriggerHistories_List" 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 WorkflowTriggerResource created on azure
// for more information of creating WorkflowTriggerResource, please refer to the document of WorkflowTriggerResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testResourceGroup";
string name = "test-name";
string workflowName = "testWorkflowName";
string triggerName = "testTriggerName";
ResourceIdentifier workflowTriggerResourceId = WorkflowTriggerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, workflowName, triggerName);
WorkflowTriggerResource workflowTrigger = client.GetWorkflowTriggerResource(workflowTriggerResourceId);

// get the collection of this WorkflowTriggerHistoryResource
WorkflowTriggerHistoryCollection collection = workflowTrigger.GetWorkflowTriggerHistories();

// invoke the operation and iterate over the result
await foreach (WorkflowTriggerHistoryResource item in collection.GetAllAsync())
{
    // the variable item 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
    WorkflowTriggerHistoryData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Mintaválasz

Állapotkód:

200

{
  "value": [
    {
      "properties": {
        "startTime": "2018-08-10T20:16:32.0387927Z",
        "endTime": "2018-08-10T20:16:32.2987996Z",
        "scheduledTime": "2018-08-10T20:16:31.6344174Z",
        "status": "Succeeded",
        "code": "OK",
        "correlation": {
          "clientTrackingId": "08586676746934337772206998657CU22"
        },
        "fired": true,
        "run": {
          "name": "08586676746934337772206998657CU22",
          "id": "/workflows/testWorkflowName/runs/08586676746934337772206998657CU22",
          "type": "/workflows/runs"
        }
      },
      "id": "/workflows/testWorkflowName/triggers/testTriggerName/histories/08586676746934337772206998657CU22",
      "name": "08586676746934337772206998657CU22",
      "type": "/workflows/triggers/histories"
    }
  ]
}

Definíciók

Name	Description
ContentHash	A tartalomkivonat.
ContentLink	A tartalom hivatkozása.
Correlation	A korrelációs tulajdonság.
ErrorProperties	A hibatulajdonságok azt jelzik, hogy a Logikai szolgáltatás miért nem tudta feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.
ErrorResponse	A hibaválasz azt jelzi, hogy a Logikai szolgáltatás nem tudja feldolgozni a bejövő kérést. A hibatulajdonság tartalmazza a hiba részleteit.
Object
ResourceReference	Az erőforrás-referencia.
WorkflowStatus	A munkafolyamat állapota.
WorkflowTriggerHistory	A munkafolyamat eseményindítójának előzményei.
WorkflowTriggerHistoryListResult	A munkafolyamat-eseményindítók előzményeinek listája.

ContentHash

Objektum

A tartalomkivonat.

Name	Típus	Description
algorithm	string	A tartalomkivonat algoritmusa.
value	string	A tartalomkivonat értéke.

ContentLink

Objektum

A tartalom hivatkozása.

Name	Típus	Description
contentHash	ContentHash	A tartalomkivonat.
contentSize	integer (int64)	A tartalom mérete.
contentVersion	string	A tartalom verziója.
metadata	Object	A metaadatok.
uri	string	A tartalomhivatkozás URI-ja.

Correlation

Objektum

A korrelációs tulajdonság.

Name	Típus	Description
clientTrackingId	string	Az ügyfélkövetés azonosítója.

ErrorProperties

Objektum

A hibatulajdonságok azt jelzik, hogy a Logikai szolgáltatás miért nem tudta feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Name	Típus	Description
code	string	Hibakód.
message	string	A művelet sikertelen voltát jelző hibaüzenet.

ErrorResponse

Objektum

A hibaválasz azt jelzi, hogy a Logikai szolgáltatás nem tudja feldolgozni a bejövő kérést. A hibatulajdonság tartalmazza a hiba részleteit.

Name	Típus	Description
error	ErrorProperties	A hiba tulajdonságai.

Object

Objektum

ResourceReference

Objektum

Az erőforrás-referencia.

Name	Típus	Description
id	string	Az erőforrás azonosítója.
name	string	Lekéri az erőforrás nevét.
type	string	Lekéri az erőforrás típusát.

WorkflowStatus

Enumerálás

A munkafolyamat állapota.

Érték	Description
Aborted
Cancelled
Failed
Faulted
Ignored
NotSpecified
Paused
Running
Skipped
Succeeded
Suspended
TimedOut
Waiting

WorkflowTriggerHistory

Objektum

A munkafolyamat eseményindítójának előzményei.

Name	Típus	Description
id	string	Az erőforrás azonosítója.
name	string	Lekéri a munkafolyamat-eseményindító előzményeinek nevét.
properties.code	string	Lekéri a kódot.
properties.correlation	Correlation	A futtatási korreláció.
properties.endTime	string (date-time)	Megkapja a befejezési időt.
properties.error	Object	Lekéri a hibát.
properties.fired	boolean	Az az érték, amely azt jelzi, hogy az eseményindító aktiválódott-e.
properties.inputsLink	ContentLink	Lekéri a bemeneti paraméterekre mutató hivatkozást.
properties.outputsLink	ContentLink	Lekéri a kimeneti paraméterekre mutató hivatkozást.
properties.run	ResourceReference	Lekéri a munkafolyamat-futtatásra mutató hivatkozást.
properties.scheduledTime	string (date-time)	Az ütemezett időpont.
properties.startTime	string (date-time)	Megkapja a kezdési időpontot.
properties.status	WorkflowStatus	Lekéri az állapotot.
properties.trackingId	string	Lekéri a nyomkövetési azonosítót.
type	string	Lekéri a munkafolyamat-eseményindító előzménytípusát.

WorkflowTriggerHistoryListResult

Objektum

A munkafolyamat-eseményindítók előzményeinek listája.

Name	Típus	Description
nextLink	string	A következő találatkészlet lekéréséhez tartozó URL-cím.
value	WorkflowTriggerHistory[]	A munkafolyamat-eseményindítók előzményeinek listája.