Workflow Run Action Scope Repetitions - List

Usługa:

App Service

Wersja interfejsu API:

2024-11-01

Wyświetl listę powtórzeń w zakresie akcji przebiegu przepływu pracy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
actionName	path	True	string	Nazwa akcji przepływu pracy.
name	path	True	string	Nazwa witryny.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nazwa grupy zasobów, do której należy zasób.
runName	path	True	string	Nazwa przebiegu przepływu pracy.
subscriptionId	path	True	string	Twój identyfikator subskrypcji Azure. Jest to ciąg w formacie GUID (np. 0000000000-0000-0000-0000-0000000000000).
workflowName	path	True	string	Nazwa przepływu pracy.
api-version	query	True	string	Wersja interfejsu API

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WorkflowRunActionRepetitionDefinitionCollection	OK
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List the scoped repetitions

Przykładowe żądanie

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/testFlow/runs/08586776228332053161046300351/actions/for_each/scopeRepetitions?api-version=2024-11-01

Java

/**
 * Samples for WorkflowRunActionScopeRepetitions List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/
     * WorkflowRunActionScopeRepetitions_List.json
     */
    /**
     * Sample code: List the scoped repetitions.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listTheScopedRepetitions(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWorkflowRunActionScopeRepetitions().list("testResourceGroup",
            "test-name", "testFlow", "08586776228332053161046300351", "for_each", 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_action_scope_repetitions_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_action_scope_repetitions.list(
        resource_group_name="testResourceGroup",
        name="test-name",
        workflow_name="testFlow",
        run_name="08586776228332053161046300351",
        action_name="for_each",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/WorkflowRunActionScopeRepetitions_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/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/WorkflowRunActionScopeRepetitions_List.json
func ExampleWorkflowRunActionScopeRepetitionsClient_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.NewWorkflowRunActionScopeRepetitionsClient().NewListPager("testResourceGroup", "test-name", "testFlow", "08586776228332053161046300351", "for_each", 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.WorkflowRunActionRepetitionDefinitionCollection = armappservice.WorkflowRunActionRepetitionDefinitionCollection{
		// 	Value: []*armappservice.WorkflowRunActionRepetitionDefinition{
		// 		{
		// 			Name: to.Ptr("000000"),
		// 			Type: to.Ptr("/workflows/runs/actions/scopeRepetitions"),
		// 			ID: to.Ptr("/workflows/testFlow/runs/08586776228332053161046300351/actions/for_each/scopeRepetitions/000000"),
		// 			Properties: &armappservice.WorkflowRunActionRepetitionProperties{
		// 				Code: to.Ptr("NotSpecified"),
		// 				Correlation: &armappservice.RunActionCorrelation{
		// 					ClientTrackingID: to.Ptr("08586775357427610445444523191"),
		// 					ActionTrackingID: to.Ptr("5c0e7c24-4891-44e8-b631-8084c5531dd5"),
		// 				},
		// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-18T17:05:57.624Z"); return t}()),
		// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-18T17:05:57.209Z"); return t}()),
		// 				Status: to.Ptr(armappservice.WorkflowStatusSucceeded),
		// 				RepetitionIndexes: []*armappservice.RepetitionIndex{
		// 					{
		// 						ItemIndex: to.Ptr[int32](0),
		// 						ScopeName: to.Ptr("For_each"),
		// 				}},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("000001"),
		// 			Type: to.Ptr("/workflows/runs/actions/scopeRepetitions"),
		// 			ID: to.Ptr("/workflows/testFlow/runs/08586776228332053161046300351/actions/for_each/scopeRepetitions/000001"),
		// 			Properties: &armappservice.WorkflowRunActionRepetitionProperties{
		// 				Code: to.Ptr("NotSpecified"),
		// 				Correlation: &armappservice.RunActionCorrelation{
		// 					ClientTrackingID: to.Ptr("08586775357427610445444523191"),
		// 					ActionTrackingID: to.Ptr("1682d0bd-7189-4478-b333-fe364a80bd69"),
		// 				},
		// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-18T17:05:57.227Z"); return t}()),
		// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-18T17:05:57.068Z"); return t}()),
		// 				Status: to.Ptr(armappservice.WorkflowStatusSucceeded),
		// 				RepetitionIndexes: []*armappservice.RepetitionIndex{
		// 					{
		// 						ItemIndex: to.Ptr[int32](1),
		// 						ScopeName: to.Ptr("For_each"),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

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 List the workflow run action scoped repetitions.
 *
 * @summary List the workflow run action scoped repetitions.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/WorkflowRunActionScopeRepetitions_List.json
 */
async function listTheScopedRepetitions() {
  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 = "testFlow";
  const runName = "08586776228332053161046300351";
  const actionName = "for_each";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.workflowRunActionScopeRepetitions.list(
    resourceGroupName,
    name,
    workflowName,
    runName,
    actionName,
  )) {
    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-11-01/examples/WorkflowRunActionScopeRepetitions_List.json
// this example is just showing the usage of "WorkflowRunActionScopeRepetitions_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 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 = "testResourceGroup";
string name = "test-name";
string workflowName = "testFlow";
string runName = "08586776228332053161046300351";
string actionName = "for_each";
ResourceIdentifier workflowRunActionResourceId = WorkflowRunActionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, workflowName, runName, actionName);
WorkflowRunActionResource workflowRunAction = client.GetWorkflowRunActionResource(workflowRunActionResourceId);

// get the collection of this WorkflowRunActionScopeRepetitionResource
WorkflowRunActionScopeRepetitionCollection collection = workflowRunAction.GetWorkflowRunActionScopeRepetitions();

// invoke the operation and iterate over the result
await foreach (WorkflowRunActionScopeRepetitionResource 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
    WorkflowRunActionRepetitionDefinitionData 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

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "properties": {
        "repetitionIndexes": [
          {
            "scopeName": "For_each",
            "itemIndex": 0
          }
        ],
        "startTime": "2018-04-18T17:05:57.209588Z",
        "endTime": "2018-04-18T17:05:57.6240967Z",
        "correlation": {
          "actionTrackingId": "5c0e7c24-4891-44e8-b631-8084c5531dd5",
          "clientTrackingId": "08586775357427610445444523191"
        },
        "status": "Succeeded",
        "code": "NotSpecified"
      },
      "id": "/workflows/testFlow/runs/08586776228332053161046300351/actions/for_each/scopeRepetitions/000000",
      "name": "000000",
      "type": "/workflows/runs/actions/scopeRepetitions"
    },
    {
      "properties": {
        "repetitionIndexes": [
          {
            "scopeName": "For_each",
            "itemIndex": 1
          }
        ],
        "startTime": "2018-04-18T17:05:57.0686808Z",
        "endTime": "2018-04-18T17:05:57.2272796Z",
        "correlation": {
          "actionTrackingId": "1682d0bd-7189-4478-b333-fe364a80bd69",
          "clientTrackingId": "08586775357427610445444523191"
        },
        "status": "Succeeded",
        "code": "NotSpecified"
      },
      "id": "/workflows/testFlow/runs/08586776228332053161046300351/actions/for_each/scopeRepetitions/000001",
      "name": "000001",
      "type": "/workflows/runs/actions/scopeRepetitions"
    }
  ]
}

Definicje

Nazwa	Opis
ContentHash	Skrót zawartości.
ContentLink	Link do zawartości.
ErrorProperties	Właściwości błędu wskazują, dlaczego usługa logiki nie mogła przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa logiki nie może przetworzyć przychodzącego żądania. Właściwość error zawiera szczegóły błędu.
Object
RepetitionIndex	Indeks powtórzeń akcji przebiegu przepływu pracy.
RetryHistory	Historia ponawiania prób.
RunActionCorrelation	Właściwości korelacji akcji przebiegu przepływu pracy.
WorkflowRunActionRepetitionDefinition	Definicja powtórzeń akcji przebiegu przepływu pracy.
WorkflowRunActionRepetitionDefinitionCollection	Kolekcja powtórzeń akcji uruchamiania przepływu pracy.
WorkflowStatus	Stan przepływu pracy.

ContentHash

Objekt

Skrót zawartości.

Nazwa	Typ	Opis
algorithm	string	Algorytm skrótu zawartości.
value	string	Wartość skrótu zawartości.

ContentLink

Objekt

Link do zawartości.

Nazwa	Typ	Opis
contentHash	ContentHash	Skrót zawartości.
contentSize	integer (int64)	Rozmiar zawartości.
contentVersion	string	Wersja zawartości.
metadata	Object	Metadane.
uri	string	Identyfikator URI łącza zawartości.

ErrorProperties

Objekt

Właściwości błędu wskazują, dlaczego usługa logiki nie mogła przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponse

Objekt

Odpowiedź na błąd wskazuje, że usługa logiki nie może przetworzyć przychodzącego żądania. Właściwość error zawiera szczegóły błędu.

Nazwa	Typ	Opis
error	ErrorProperties	Właściwości błędu.

Object

Objekt

RepetitionIndex

Objekt

Indeks powtórzeń akcji przebiegu przepływu pracy.

Nazwa	Typ	Opis
itemIndex	integer (int32)	Indeks.
scopeName	string	Zakres.

RetryHistory

Objekt

Historia ponawiania prób.

Nazwa	Typ	Opis
clientRequestId	string	Pobiera identyfikator żądania klienta.
code	string	Pobiera kod stanu.
endTime	string (date-time)	Pobiera godzinę zakończenia.
error	ErrorResponse	Pobiera odpowiedź na błąd.
serviceRequestId	string	Pobiera identyfikator żądania obsługi.
startTime	string (date-time)	Pobiera godzinę rozpoczęcia.

RunActionCorrelation

Objekt

Właściwości korelacji akcji przebiegu przepływu pracy.

Nazwa	Typ	Opis
actionTrackingId	string	Identyfikator śledzenia akcji.
clientKeywords	string[]	Słowa kluczowe klienta.
clientTrackingId	string	Identyfikator śledzenia klienta.

WorkflowRunActionRepetitionDefinition

Objekt

Definicja powtórzeń akcji przebiegu przepływu pracy.

Nazwa	Typ	Opis
code	string	Kod powtórzenia zakresu przepływu pracy.
correlation	RunActionCorrelation	Właściwości korelacji.
endTime	string (date-time)	Godzina zakończenia powtórzenia zakresu przepływu pracy.
error
id	string	Identyfikator zasobu.
location	string	Lokalizacja zasobu.
name	string	Pobiera nazwę zasobu.
properties.inputs	Object	Pobiera dane wejściowe.
properties.inputsLink	ContentLink	Pobiera link do danych wejściowych.
properties.iterationCount	integer (int32)
properties.outputs	Object	Pobiera dane wyjściowe.
properties.outputsLink	ContentLink	Pobiera link do danych wyjściowych.
properties.repetitionIndexes	RepetitionIndex[]	Indeksy powtórzeń.
properties.retryHistory	RetryHistory[]	Pobiera historie ponawiania prób.
properties.trackedProperties	Object	Pobiera śledzone właściwości.
properties.trackingId	string	Pobiera identyfikator śledzenia.
startTime	string (date-time)	Godzina rozpoczęcia powtórzenia zakresu przepływu pracy.
status	WorkflowStatus	Stan powtórzenia zakresu przepływu pracy.
tags	object	Tagi zasobów.
type	string	Pobiera typ zasobu.

WorkflowRunActionRepetitionDefinitionCollection

Objekt

Kolekcja powtórzeń akcji uruchamiania przepływu pracy.

Nazwa	Typ	Opis
nextLink	string	Link użyty do pobrania następnej strony zaleceń.
value	WorkflowRunActionRepetitionDefinition[]	Definicja powtórzeń akcji przebiegu przepływu pracy.

WorkflowStatus

Wyliczanie

Stan przepływu pracy.

Wartość	Opis
Aborted
Cancelled
Failed
Faulted
Ignored
NotSpecified
Paused
Running
Skipped
Succeeded
Suspended
TimedOut
Waiting