Azure Classic

v5.24.0 published on Wednesday, Nov 9, 2022 by Pulumi

Pipeline

Manages a Pipeline inside a Azure Data Factory.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleFactory = new Azure.DataFactory.Factory("exampleFactory", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var examplePipeline = new Azure.DataFactory.Pipeline("examplePipeline", new()
    {
        DataFactoryId = exampleFactory.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleFactory, err := datafactory.NewFactory(ctx, "exampleFactory", &datafactory.FactoryArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewPipeline(ctx, "examplePipeline", &datafactory.PipelineArgs{
			DataFactoryId: exampleFactory.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.datafactory.Factory;
import com.pulumi.azure.datafactory.FactoryArgs;
import com.pulumi.azure.datafactory.Pipeline;
import com.pulumi.azure.datafactory.PipelineArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var examplePipeline = new Pipeline("examplePipeline", PipelineArgs.builder()        
            .dataFactoryId(exampleFactory.id())
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_pipeline = azure.datafactory.Pipeline("examplePipeline", data_factory_id=example_factory.id)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleFactory = new azure.datafactory.Factory("exampleFactory", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const examplePipeline = new azure.datafactory.Pipeline("examplePipeline", {dataFactoryId: exampleFactory.id});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  examplePipeline:
    type: azure:datafactory:Pipeline
    properties:
      dataFactoryId: ${exampleFactory.id}

With Activities

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var test = new Azure.DataFactory.Pipeline("test", new()
    {
        DataFactoryId = azurerm_data_factory.Test.Id,
        Variables = 
        {
            { "bob", "item1" },
        },
        ActivitiesJson = @"[
    {
        ""name"": ""Append variable1"",
        ""type"": ""AppendVariable"",
        ""dependsOn"": [],
        ""userProperties"": [],
        ""typeProperties"": {
          ""variableName"": ""bob"",
          ""value"": ""something""
        }
    }
]
",
    });

});
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datafactory.NewPipeline(ctx, "test", &datafactory.PipelineArgs{
			DataFactoryId: pulumi.Any(azurerm_data_factory.Test.Id),
			Variables: pulumi.StringMap{
				"bob": pulumi.String("item1"),
			},
			ActivitiesJson: pulumi.String(fmt.Sprintf(`[
    {
        "name": "Append variable1",
        "type": "AppendVariable",
        "dependsOn": [],
        "userProperties": [],
        "typeProperties": {
          "variableName": "bob",
          "value": "something"
        }
    }
]
`)),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.datafactory.Pipeline;
import com.pulumi.azure.datafactory.PipelineArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new Pipeline("test", PipelineArgs.builder()        
            .dataFactoryId(azurerm_data_factory.test().id())
            .variables(Map.of("bob", "item1"))
            .activitiesJson("""
[
    {
        "name": "Append variable1",
        "type": "AppendVariable",
        "dependsOn": [],
        "userProperties": [],
        "typeProperties": {
          "variableName": "bob",
          "value": "something"
        }
    }
]
            """)
            .build());

    }
}
import pulumi
import pulumi_azure as azure

test = azure.datafactory.Pipeline("test",
    data_factory_id=azurerm_data_factory["test"]["id"],
    variables={
        "bob": "item1",
    },
    activities_json="""[
    {
        "name": "Append variable1",
        "type": "AppendVariable",
        "dependsOn": [],
        "userProperties": [],
        "typeProperties": {
          "variableName": "bob",
          "value": "something"
        }
    }
]
""")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const test = new azure.datafactory.Pipeline("test", {
    dataFactoryId: azurerm_data_factory.test.id,
    variables: {
        bob: "item1",
    },
    activitiesJson: `[
    {
        "name": "Append variable1",
        "type": "AppendVariable",
        "dependsOn": [],
        "userProperties": [],
        "typeProperties": {
          "variableName": "bob",
          "value": "something"
        }
    }
]
`,
});
resources:
  test:
    type: azure:datafactory:Pipeline
    properties:
      dataFactoryId: ${azurerm_data_factory.test.id}
      variables:
        bob: item1
      activitiesJson: |
        [
            {
                "name": "Append variable1",
                "type": "AppendVariable",
                "dependsOn": [],
                "userProperties": [],
                "typeProperties": {
                  "variableName": "bob",
                  "value": "something"
                }
            }
        ]        

Create Pipeline Resource

new Pipeline(name: string, args: PipelineArgs, opts?: CustomResourceOptions);
@overload
def Pipeline(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             activities_json: Optional[str] = None,
             annotations: Optional[Sequence[str]] = None,
             concurrency: Optional[int] = None,
             data_factory_id: Optional[str] = None,
             description: Optional[str] = None,
             folder: Optional[str] = None,
             moniter_metrics_after_duration: Optional[str] = None,
             name: Optional[str] = None,
             parameters: Optional[Mapping[str, str]] = None,
             variables: Optional[Mapping[str, str]] = None)
@overload
def Pipeline(resource_name: str,
             args: PipelineArgs,
             opts: Optional[ResourceOptions] = None)
func NewPipeline(ctx *Context, name string, args PipelineArgs, opts ...ResourceOption) (*Pipeline, error)
public Pipeline(string name, PipelineArgs args, CustomResourceOptions? opts = null)
public Pipeline(String name, PipelineArgs args)
public Pipeline(String name, PipelineArgs args, CustomResourceOptions options)
type: azure:datafactory:Pipeline
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args PipelineArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args PipelineArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args PipelineArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PipelineArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args PipelineArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Pipeline Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Pipeline resource accepts the following input properties:

DataFactoryId string

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

ActivitiesJson string

A JSON object that contains the activities that will be associated with the Data Factory Pipeline.

Annotations List<string>

List of tags that can be used for describing the Data Factory Pipeline.

Concurrency int

The max number of concurrent runs for the Data Factory Pipeline. Must be between 1 and 50.

Description string

The description for the Data Factory Pipeline.

Folder string

The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.

MoniterMetricsAfterDuration string

The TimeSpan value after which an Azure Monitoring Metric is fired.

Name string

Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

Parameters Dictionary<string, string>

A map of parameters to associate with the Data Factory Pipeline.

Variables Dictionary<string, string>

A map of variables to associate with the Data Factory Pipeline.

DataFactoryId string

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

ActivitiesJson string

A JSON object that contains the activities that will be associated with the Data Factory Pipeline.

Annotations []string

List of tags that can be used for describing the Data Factory Pipeline.

Concurrency int

The max number of concurrent runs for the Data Factory Pipeline. Must be between 1 and 50.

Description string

The description for the Data Factory Pipeline.

Folder string

The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.

MoniterMetricsAfterDuration string

The TimeSpan value after which an Azure Monitoring Metric is fired.

Name string

Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

Parameters map[string]string

A map of parameters to associate with the Data Factory Pipeline.

Variables map[string]string

A map of variables to associate with the Data Factory Pipeline.

dataFactoryId String

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

activitiesJson String

A JSON object that contains the activities that will be associated with the Data Factory Pipeline.

annotations List<String>

List of tags that can be used for describing the Data Factory Pipeline.

concurrency Integer

The max number of concurrent runs for the Data Factory Pipeline. Must be between 1 and 50.

description String

The description for the Data Factory Pipeline.

folder String

The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.

moniterMetricsAfterDuration String

The TimeSpan value after which an Azure Monitoring Metric is fired.

name String

Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters Map<String,String>

A map of parameters to associate with the Data Factory Pipeline.

variables Map<String,String>

A map of variables to associate with the Data Factory Pipeline.

dataFactoryId string

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

activitiesJson string

A JSON object that contains the activities that will be associated with the Data Factory Pipeline.

annotations string[]

List of tags that can be used for describing the Data Factory Pipeline.

concurrency number

The max number of concurrent runs for the Data Factory Pipeline. Must be between 1 and 50.

description string

The description for the Data Factory Pipeline.

folder string

The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.

moniterMetricsAfterDuration string

The TimeSpan value after which an Azure Monitoring Metric is fired.

name string

Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters {[key: string]: string}

A map of parameters to associate with the Data Factory Pipeline.

variables {[key: string]: string}

A map of variables to associate with the Data Factory Pipeline.

data_factory_id str

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

activities_json str

A JSON object that contains the activities that will be associated with the Data Factory Pipeline.

annotations Sequence[str]

List of tags that can be used for describing the Data Factory Pipeline.

concurrency int

The max number of concurrent runs for the Data Factory Pipeline. Must be between 1 and 50.

description str

The description for the Data Factory Pipeline.

folder str

The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.

moniter_metrics_after_duration str

The TimeSpan value after which an Azure Monitoring Metric is fired.

name str

Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters Mapping[str, str]

A map of parameters to associate with the Data Factory Pipeline.

variables Mapping[str, str]

A map of variables to associate with the Data Factory Pipeline.

dataFactoryId String

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

activitiesJson String

A JSON object that contains the activities that will be associated with the Data Factory Pipeline.

annotations List<String>

List of tags that can be used for describing the Data Factory Pipeline.

concurrency Number

The max number of concurrent runs for the Data Factory Pipeline. Must be between 1 and 50.

description String

The description for the Data Factory Pipeline.

folder String

The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.

moniterMetricsAfterDuration String

The TimeSpan value after which an Azure Monitoring Metric is fired.

name String

Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters Map<String>

A map of parameters to associate with the Data Factory Pipeline.

variables Map<String>

A map of variables to associate with the Data Factory Pipeline.

Outputs

All input properties are implicitly available as output properties. Additionally, the Pipeline resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing Pipeline Resource

Get an existing Pipeline resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PipelineState, opts?: CustomResourceOptions): Pipeline
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activities_json: Optional[str] = None,
        annotations: Optional[Sequence[str]] = None,
        concurrency: Optional[int] = None,
        data_factory_id: Optional[str] = None,
        description: Optional[str] = None,
        folder: Optional[str] = None,
        moniter_metrics_after_duration: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        variables: Optional[Mapping[str, str]] = None) -> Pipeline
func GetPipeline(ctx *Context, name string, id IDInput, state *PipelineState, opts ...ResourceOption) (*Pipeline, error)
public static Pipeline Get(string name, Input<string> id, PipelineState? state, CustomResourceOptions? opts = null)
public static Pipeline get(String name, Output<String> id, PipelineState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ActivitiesJson string

A JSON object that contains the activities that will be associated with the Data Factory Pipeline.

Annotations List<string>

List of tags that can be used for describing the Data Factory Pipeline.

Concurrency int

The max number of concurrent runs for the Data Factory Pipeline. Must be between 1 and 50.

DataFactoryId string

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

Description string

The description for the Data Factory Pipeline.

Folder string

The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.

MoniterMetricsAfterDuration string

The TimeSpan value after which an Azure Monitoring Metric is fired.

Name string

Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

Parameters Dictionary<string, string>

A map of parameters to associate with the Data Factory Pipeline.

Variables Dictionary<string, string>

A map of variables to associate with the Data Factory Pipeline.

ActivitiesJson string

A JSON object that contains the activities that will be associated with the Data Factory Pipeline.

Annotations []string

List of tags that can be used for describing the Data Factory Pipeline.

Concurrency int

The max number of concurrent runs for the Data Factory Pipeline. Must be between 1 and 50.

DataFactoryId string

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

Description string

The description for the Data Factory Pipeline.

Folder string

The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.

MoniterMetricsAfterDuration string

The TimeSpan value after which an Azure Monitoring Metric is fired.

Name string

Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

Parameters map[string]string

A map of parameters to associate with the Data Factory Pipeline.

Variables map[string]string

A map of variables to associate with the Data Factory Pipeline.

activitiesJson String

A JSON object that contains the activities that will be associated with the Data Factory Pipeline.

annotations List<String>

List of tags that can be used for describing the Data Factory Pipeline.

concurrency Integer

The max number of concurrent runs for the Data Factory Pipeline. Must be between 1 and 50.

dataFactoryId String

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

description String

The description for the Data Factory Pipeline.

folder String

The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.

moniterMetricsAfterDuration String

The TimeSpan value after which an Azure Monitoring Metric is fired.

name String

Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters Map<String,String>

A map of parameters to associate with the Data Factory Pipeline.

variables Map<String,String>

A map of variables to associate with the Data Factory Pipeline.

activitiesJson string

A JSON object that contains the activities that will be associated with the Data Factory Pipeline.

annotations string[]

List of tags that can be used for describing the Data Factory Pipeline.

concurrency number

The max number of concurrent runs for the Data Factory Pipeline. Must be between 1 and 50.

dataFactoryId string

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

description string

The description for the Data Factory Pipeline.

folder string

The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.

moniterMetricsAfterDuration string

The TimeSpan value after which an Azure Monitoring Metric is fired.

name string

Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters {[key: string]: string}

A map of parameters to associate with the Data Factory Pipeline.

variables {[key: string]: string}

A map of variables to associate with the Data Factory Pipeline.

activities_json str

A JSON object that contains the activities that will be associated with the Data Factory Pipeline.

annotations Sequence[str]

List of tags that can be used for describing the Data Factory Pipeline.

concurrency int

The max number of concurrent runs for the Data Factory Pipeline. Must be between 1 and 50.

data_factory_id str

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

description str

The description for the Data Factory Pipeline.

folder str

The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.

moniter_metrics_after_duration str

The TimeSpan value after which an Azure Monitoring Metric is fired.

name str

Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters Mapping[str, str]

A map of parameters to associate with the Data Factory Pipeline.

variables Mapping[str, str]

A map of variables to associate with the Data Factory Pipeline.

activitiesJson String

A JSON object that contains the activities that will be associated with the Data Factory Pipeline.

annotations List<String>

List of tags that can be used for describing the Data Factory Pipeline.

concurrency Number

The max number of concurrent runs for the Data Factory Pipeline. Must be between 1 and 50.

dataFactoryId String

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

description String

The description for the Data Factory Pipeline.

folder String

The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.

moniterMetricsAfterDuration String

The TimeSpan value after which an Azure Monitoring Metric is fired.

name String

Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters Map<String>

A map of parameters to associate with the Data Factory Pipeline.

variables Map<String>

A map of variables to associate with the Data Factory Pipeline.

Import

Data Factory Pipeline’s can be imported using the resource id, e.g.

 $ pulumi import azure:datafactory/pipeline:Pipeline example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/pipelines/example

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.