Pipelines - Create Run

Serviço:: Data Factory

Versão da API:: 2018-06-01

Cria uma execução de um pipeline.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun?api-version=2018-06-01

Com parâmetros opcionais:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun?api-version=2018-06-01&referencePipelineRunId={referencePipelineRunId}&isRecovery={isRecovery}&startActivityName={startActivityName}&startFromFailure={startFromFailure}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	O nome da fábrica.
pipelineName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>#.%&:\\+?/]$	O nome do pipeline.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	O nome do grupo de recursos.
subscriptionId	path	True	string	O identificador de assinatura.
api-version	query	True	string	A versão da API.
isRecovery	query		boolean	Sinalizador do modo de recuperação. Se o modo de recuperação estiver definido como true, o pipeline referenciado especificado será executado e a nova execução serão agrupados sob o mesmo groupId.
referencePipelineRunId	query		string	O identificador de execução do pipeline. Se o ID de execução for especificado, os parâmetros da execução especificada serão usados para criar uma nova execução.
startActivityName	query		string	No modo de recuperação, a repetição será iniciada a partir desta atividade. Se não for especificado, todas as atividades serão executadas.
startFromFailure	query		boolean	No modo de recuperação, se definido como true, a nova execução será iniciada a partir de atividades com falha. A propriedade será usada somente se startActivityName não for especificado.

Corpo do Pedido

Name	Tipo	Description
parameters	ParameterValueSpecification	Parâmetros da execução do pipeline. Esses parâmetros serão usados somente se o runId não for especificado.

Respostas

Name	Tipo	Description
200 OK	CreateRunResponse	OK.
Other Status Codes	CloudError	Uma resposta de erro recebida do serviço Azure Data Factory.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Pipelines_CreateRun

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline/createRun?api-version=2018-06-01&referencePipelineRunId=

{
  "OutputBlobNameList": [
    "exampleoutput.csv"
  ]
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Core.Expressions.DataFactory;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/examples/Pipelines_CreateRun.json
// this example is just showing the usage of "Pipelines_CreateRun" 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 DataFactoryPipelineResource created on azure
// for more information of creating DataFactoryPipelineResource, please refer to the document of DataFactoryPipelineResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
string pipelineName = "examplePipeline";
ResourceIdentifier dataFactoryPipelineResourceId = DataFactoryPipelineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, pipelineName);
DataFactoryPipelineResource dataFactoryPipeline = client.GetDataFactoryPipelineResource(dataFactoryPipelineResourceId);

// invoke the operation
IDictionary<string, BinaryData> parameterValueSpecification = new Dictionary<string, BinaryData>
{
    ["OutputBlobNameList"] = BinaryData.FromObjectAsJson(new object[]
{
"exampleoutput.csv"
})
};
string referencePipelineRunId = null;
PipelineCreateRunResult result = await dataFactoryPipeline.CreateRunAsync(parameterValueSpecification: parameterValueSpecification, referencePipelineRunId: referencePipelineRunId);

Console.WriteLine($"Succeeded: {result}");

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

Resposta da amostra

Código de estado:: 200

Date: Sat, 16 Jun 2018 00:37:48 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1190
x-ms-request-id: 5c2b442b-d360-43ec-9268-f923f88f31fd
x-ms-correlation-request-id: 5c2b442b-d360-43ec-9268-f923f88f31fd

{
  "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b"
}

Definições

Name	Description
CloudError	O objeto que define a estrutura de uma resposta de erro do Azure Data Factory.
CreateRunResponse	Corpo da resposta com um identificador de execução.

CloudError

Object

O objeto que define a estrutura de uma resposta de erro do Azure Data Factory.

Name	Tipo	Description
error.code	string	Código de erro.
error.details	CloudError[]	Matriz com detalhes de erro adicionais.
error.message	string	Mensagem de erro.
error.target	string	Nome/caminho da propriedade na solicitação associada ao erro.

CreateRunResponse