Pipeline

Manages a Pipeline inside a Azure Data Factory.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "northeurope",
        });
        var exampleFactory = new Azure.DataFactory.Factory("exampleFactory", new Azure.DataFactory.FactoryArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
        });
        var examplePipeline = new Azure.DataFactory.Pipeline("examplePipeline", new Azure.DataFactory.PipelineArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            DataFactoryName = exampleFactory.Name,
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("northeurope"),
        })
        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{
            ResourceGroupName: exampleResourceGroup.Name,
            DataFactoryName:   exampleFactory.Name,
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_pipeline = azure.datafactory.Pipeline("examplePipeline",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "northeurope"});
const exampleFactory = new azure.datafactory.Factory("exampleFactory", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const examplePipeline = new azure.datafactory.Pipeline("examplePipeline", {
    resourceGroupName: exampleResourceGroup.name,
    dataFactoryName: exampleFactory.name,
});

With Activities

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var test = new Azure.DataFactory.Pipeline("test", new Azure.DataFactory.PipelineArgs
        {
            ResourceGroupName = azurerm_resource_group.Test.Name,
            DataFactoryName = azurerm_data_factory.Test.Name,
            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/v3/go/azure/datafactory"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err = datafactory.NewPipeline(ctx, "test", &datafactory.PipelineArgs{
            ResourceGroupName: pulumi.String(azurerm_resource_group.Test.Name),
            DataFactoryName:   pulumi.String(azurerm_data_factory.Test.Name),
            Variables: pulumi.Map{
                "bob": pulumi.String("item1"),
            },
            ActivitiesJson: pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v", "[\n", "   {\n", "       \"name\": \"Append variable1\",\n", "     \"type\": \"AppendVariable\",\n", "       \"dependsOn\": [],\n", "      \"userProperties\": [],\n", "     \"typeProperties\": {\n", "           \"variableName\": \"bob\",\n", "          \"value\": \"something\"\n", "        }\n", "   }\n", "]\n")),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

test = azure.datafactory.Pipeline("test",
    resource_group_name=azurerm_resource_group["test"]["name"],
    data_factory_name=azurerm_data_factory["test"]["name"],
    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", {
    resourceGroupName: azurerm_resource_group.test.name,
    dataFactoryName: azurerm_data_factory.test.name,
    variables: {
        bob: "item1",
    },
    activitiesJson: `[
    {
        "name": "Append variable1",
        "type": "AppendVariable",
        "dependsOn": [],
        "userProperties": [],
        "typeProperties": {
            "variableName": "bob",
            "value": "something"
        }
    }
]
`,
});

Create a Pipeline Resource

new Pipeline(name: string, args: PipelineArgs, opts?: CustomResourceOptions);

def Pipeline(resource_name, opts=None, activities_json=None, annotations=None, data_factory_name=None, description=None, name=None, parameters=None, resource_group_name=None, variables=None, __props__=None);

func NewPipeline(ctx *Context, name string, args PipelineArgs, opts ...ResourceOption) (*Pipeline, error)

public Pipeline(string name, PipelineArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Pipeline Resource Properties

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

Inputs

The Pipeline resource accepts the following input properties:

DataFactoryName string: The Data Factory name in which to associate the Pipeline with. Changing this forces a new resource.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Pipeline. 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.
Description string: The description for the Data Factory Pipeline.
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.

DataFactoryName string: The Data Factory name in which to associate the Pipeline with. Changing this forces a new resource.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Pipeline. 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.
Description string: The description for the Data Factory Pipeline.
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.

dataFactoryName string: The Data Factory name in which to associate the Pipeline with. Changing this forces a new resource.
resourceGroupName string: The name of the resource group in which to create the Data Factory Pipeline. 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.
description string: The description for the Data Factory Pipeline.
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_name str: The Data Factory name in which to associate the Pipeline with. Changing this forces a new resource.
resource_group_name str: The name of the resource group in which to create the Data Factory Pipeline. 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 List[str]: List of tags that can be used for describing the Data Factory Pipeline.
description str: The description for the Data Factory Pipeline.
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 Dict[str, str]: A map of parameters to associate with the Data Factory Pipeline.
variables Dict[str, str]: 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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, activities_json=None, annotations=None, data_factory_name=None, description=None, name=None, parameters=None, resource_group_name=None, variables=None, __props__=None);

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)

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.

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.
DataFactoryName string: The Data Factory name in which to associate the Pipeline with. Changing this forces a new resource.
Description string: The description for the Data Factory Pipeline.
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.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Pipeline. Changing this forces a new resource
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.
DataFactoryName string: The Data Factory name in which to associate the Pipeline with. Changing this forces a new resource.
Description string: The description for the Data Factory Pipeline.
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.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Pipeline. Changing this forces a new resource
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.
dataFactoryName string: The Data Factory name in which to associate the Pipeline with. Changing this forces a new resource.
description string: The description for the Data Factory Pipeline.
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.
resourceGroupName string: The name of the resource group in which to create the Data Factory Pipeline. Changing this forces a new resource
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 List[str]: List of tags that can be used for describing the Data Factory Pipeline.
data_factory_name str: The Data Factory name in which to associate the Pipeline with. Changing this forces a new resource.
description str: The description for the Data Factory Pipeline.
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 Dict[str, str]: A map of parameters to associate with the Data Factory Pipeline.
resource_group_name str: The name of the resource group in which to create the Data Factory Pipeline. Changing this forces a new resource
variables Dict[str, str]: A map of variables to associate with the Data Factory Pipeline.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud