Workflow Run Action Repetitions - Get

Serviço:

App Service

Versão da API:

2024-04-01

Obter uma repetição de 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}/repetitions/{repetitionName}?api-version=2024-04-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.
repetitionName	path	True	string	A repetição do fluxo de trabalho.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nome do grupo de recursos ao qual o recurso pertence.
runName	path	True	string	O nome da execução do fluxo de trabalho.
subscriptionId	path	True	string	Sua ID de assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-000000000000000).
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	WorkflowRunActionRepetitionDefinition	OKEY
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get a repetition

Solicitação de exemplo

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/testAction/repetitions/000001?api-version=2024-04-01

Java

/**
 * Samples for WorkflowRunActionRepetitions Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_Get.json
     */
    /**
     * Sample code: Get a repetition.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getARepetition(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWorkflowRunActionRepetitions().getWithResponse("testResourceGroup",
            "test-name", "testFlow", "08586776228332053161046300351", "testAction", "000001",
            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_repetitions_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_action_repetitions.get(
        resource_group_name="testResourceGroup",
        name="test-name",
        workflow_name="testFlow",
        run_name="08586776228332053161046300351",
        action_name="testAction",
        repetition_name="000001",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_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/WorkflowRunActionRepetitions_Get.json
func ExampleWorkflowRunActionRepetitionsClient_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.NewWorkflowRunActionRepetitionsClient().Get(ctx, "testResourceGroup", "test-name", "testFlow", "08586776228332053161046300351", "testAction", "000001", 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.WorkflowRunActionRepetitionDefinition = armappservice.WorkflowRunActionRepetitionDefinition{
	// 	Name: to.Ptr("000001"),
	// 	Type: to.Ptr("/workflows/runs/actions/repetitions"),
	// 	ID: to.Ptr("/workflows/testFlow/runs/08586776228332053161046300351/actions/testAction/repetitions/000001"),
	// 	Properties: &armappservice.WorkflowRunActionRepetitionProperties{
	// 		Code: to.Ptr("OK"),
	// 		Correlation: &armappservice.RunActionCorrelation{
	// 			ClientTrackingID: to.Ptr("08586775357427610445444523191"),
	// 			ActionTrackingID: to.Ptr("f84f23eb-b331-4772-9f39-cc307fa83bc3"),
	// 		},
	// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-18T17:05:57.101Z"); return t}()),
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-18T17:05:57.092Z"); return t}()),
	// 		Status: to.Ptr(armappservice.WorkflowStatusSucceeded),
	// 		InputsLink: &armappservice.ContentLink{
	// 			ContentHash: &armappservice.ContentHash{
	// 				Algorithm: to.Ptr("md5"),
	// 				Value: to.Ptr("OA3i83YHGYVch+N8BQJIRQ=="),
	// 			},
	// 			ContentSize: to.Ptr[int64](6),
	// 			ContentVersion: to.Ptr("OA3i83YHGYVch+N8BQJIRQ=="),
	// 			URI: to.Ptr("https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000001/contents/ActionInputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000001%2Fcontents%2FActionInputs%2Fread&sv=1.0&sig=dLmnt50joimEMK4k9rR6njHQh94iSFJ9rrDxFbkEg5M"),
	// 		},
	// 		OutputsLink: &armappservice.ContentLink{
	// 			ContentHash: &armappservice.ContentHash{
	// 				Algorithm: to.Ptr("md5"),
	// 				Value: to.Ptr("OA3i83YHGYVch+N8BQJIRQ=="),
	// 			},
	// 			ContentSize: to.Ptr[int64](6),
	// 			ContentVersion: to.Ptr("OA3i83YHGYVch+N8BQJIRQ=="),
	// 			URI: to.Ptr("https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000001/contents/ActionOutputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000001%2Fcontents%2FActionOutputs%2Fread&sv=1.0&sig=B3-X5sqIAv1Lb31GOD34ZgIRUXGuiM2QllWiNwXFYAw"),
	// 		},
	// 		TrackingID: to.Ptr("f84f23eb-b331-4772-9f39-cc307fa83bc3"),
	// 		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 Get a workflow run action repetition.
 *
 * @summary Get a workflow run action repetition.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitions_Get.json
 */
async function getARepetition() {
  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 = "testAction";
  const repetitionName = "000001";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.workflowRunActionRepetitions.get(
    resourceGroupName,
    name,
    workflowName,
    runName,
    actionName,
    repetitionName,
  );
  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-04-01/examples/WorkflowRunActionRepetitions_Get.json
// this example is just showing the usage of "WorkflowRunActionRepetitions_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 = "testResourceGroup";
string name = "test-name";
string workflowName = "testFlow";
string runName = "08586776228332053161046300351";
string actionName = "testAction";
ResourceIdentifier workflowRunActionResourceId = WorkflowRunActionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, workflowName, runName, actionName);
WorkflowRunActionResource workflowRunAction = client.GetWorkflowRunActionResource(workflowRunActionResourceId);

// get the collection of this WorkflowRunActionRepetitionResource
WorkflowRunActionRepetitionCollection collection = workflowRunAction.GetWorkflowRunActionRepetitions();

// invoke the operation
string repetitionName = "000001";
NullableResponse<WorkflowRunActionRepetitionResource> response = await collection.GetIfExistsAsync(repetitionName);
WorkflowRunActionRepetitionResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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
    WorkflowRunActionRepetitionDefinitionData 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

Resposta de exemplo

Código de status:

200

{
  "properties": {
    "repetitionIndexes": [
      {
        "scopeName": "For_each",
        "itemIndex": 1
      }
    ],
    "trackingId": "f84f23eb-b331-4772-9f39-cc307fa83bc3",
    "inputsLink": {
      "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000001/contents/ActionInputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000001%2Fcontents%2FActionInputs%2Fread&sv=1.0&sig=dLmnt50joimEMK4k9rR6njHQh94iSFJ9rrDxFbkEg5M",
      "contentVersion": "OA3i83YHGYVch+N8BQJIRQ==",
      "contentSize": 6,
      "contentHash": {
        "algorithm": "md5",
        "value": "OA3i83YHGYVch+N8BQJIRQ=="
      }
    },
    "outputsLink": {
      "uri": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000001/contents/ActionOutputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000001%2Fcontents%2FActionOutputs%2Fread&sv=1.0&sig=B3-X5sqIAv1Lb31GOD34ZgIRUXGuiM2QllWiNwXFYAw",
      "contentVersion": "OA3i83YHGYVch+N8BQJIRQ==",
      "contentSize": 6,
      "contentHash": {
        "algorithm": "md5",
        "value": "OA3i83YHGYVch+N8BQJIRQ=="
      }
    },
    "startTime": "2018-04-18T17:05:57.0929911Z",
    "endTime": "2018-04-18T17:05:57.1015421Z",
    "correlation": {
      "actionTrackingId": "f84f23eb-b331-4772-9f39-cc307fa83bc3",
      "clientTrackingId": "08586775357427610445444523191"
    },
    "status": "Succeeded",
    "code": "OK"
  },
  "id": "/workflows/testFlow/runs/08586776228332053161046300351/actions/testAction/repetitions/000001",
  "name": "000001",
  "type": "/workflows/runs/actions/repetitions"
}

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 foi capaz 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 de erro contém os detalhes do erro.
Object
RepetitionIndex	O índice de repetição de ação de execução de fluxo de trabalho.
RetryHistory	O histórico de repetição.
RunActionCorrelation	As propriedades de correlação de ação de execução de fluxo de trabalho.
WorkflowRunActionRepetitionDefinition	A definição de repetição de ação de execução de fluxo de trabalho.
WorkflowStatus	O status do fluxo de trabalho.

ContentHash

Objeto

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

Objeto

O link de conteúdo.

Nome	Tipo	Description
contentHash	ContentHash	O hash de conteúdo.
contentSize	integer (int64)	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

Objeto

As propriedades de erro indicam por que o serviço lógico não foi capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Nome	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

ErrorResponse

Objeto

A resposta de erro indica que o serviço lógico não é capaz de processar a solicitação de entrada. A propriedade de erro contém os detalhes do erro.

Nome	Tipo	Description
error	ErrorProperties	As propriedades de erro.

Object

Objeto

RepetitionIndex

Objeto

O índice de repetição de ação de execução de fluxo de trabalho.

Nome	Tipo	Description
itemIndex	integer (int32)	O índice.
scopeName	string	O escopo.

RetryHistory

Objeto

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 (date-time)	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 (date-time)	Obtém a hora de início.

RunActionCorrelation

Objeto

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 acompanhamento do cliente.

WorkflowRunActionRepetitionDefinition

Objeto

A definição de repetição de ação de execução de fluxo de trabalho.

Nome	Tipo	Description
code	string	O código de repetição do escopo do fluxo de trabalho.
correlation	RunActionCorrelation	As propriedades de correlação.
endTime	string (date-time)	A hora de término da repetição do escopo do fluxo de trabalho.
error
id	string	A ID do recurso.
location	string	O local do recurso.
name	string	Obtém o nome do recurso.
properties.inputs	Object	Obtém as entradas.
properties.inputsLink	ContentLink	Obtém o link para entradas.
properties.iterationCount	integer (int32)
properties.outputs	Object	Obtém as saídas.
properties.outputsLink	ContentLink	Obtém o link para saídas.
properties.repetitionIndexes	RepetitionIndex[]	Os índices de repetição.
properties.retryHistory	RetryHistory[]	Obtém os históricos de repetição.
properties.trackedProperties	Object	Obtém as propriedades controladas.
properties.trackingId	string	Obtém a ID de acompanhamento.
startTime	string (date-time)	A hora de início da repetição do escopo do fluxo de trabalho.
status	WorkflowStatus	O status da repetição do escopo do fluxo de trabalho.
tags	object	As marcas de recurso.
type	string	Obtém o tipo de recurso.

WorkflowStatus

Enumeração

O status do fluxo de trabalho.

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