pulumi-azure-native-kotlin/com.pulumi.azurenative.datafactory.kotlin/DataFlow

DataFlow

class DataFlow : KotlinCustomResource

Data flow resource type. Uses Azure REST API version 2018-06-01. In version 2.x of the Azure Native provider, it used API version 2018-06-01.

Example Usage

DataFlows_Create

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var dataFlow = new AzureNative.DataFactory.DataFlow("dataFlow", new()
    {
        DataFlowName = "exampleDataFlow",
        FactoryName = "exampleFactoryName",
        Properties = new AzureNative.DataFactory.Inputs.MappingDataFlowArgs
        {
            Description = "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.",
            ScriptLines = new[]
            {
                "source(output(",
                "PreviousConversionRate as double,",
                "Country as string,",
                "DateTime1 as string,",
                "CurrentConversionRate as double",
                "),",
                "allowSchemaDrift: false,",
                "validateSchema: false) ~> USDCurrency",
                "source(output(",
                "PreviousConversionRate as double,",
                "Country as string,",
                "DateTime1 as string,",
                "CurrentConversionRate as double",
                "),",
                "allowSchemaDrift: true,",
                "validateSchema: false) ~> CADSource",
                "USDCurrency, CADSource union(byName: true)~> Union",
                "Union derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn",
                "NewCurrencyColumn split(Country == 'USD',",
                "Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)",
                "ConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink",
                "ConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink",
            },
            Sinks = new[]
            {
                new AzureNative.DataFactory.Inputs.DataFlowSinkArgs
                {
                    Dataset = new AzureNative.DataFactory.Inputs.DatasetReferenceArgs
                    {
                        ReferenceName = "USDOutput",
                        Type = "DatasetReference",
                    },
                    Name = "USDSink",
                },
                new AzureNative.DataFactory.Inputs.DataFlowSinkArgs
                {
                    Dataset = new AzureNative.DataFactory.Inputs.DatasetReferenceArgs
                    {
                        ReferenceName = "CADOutput",
                        Type = "DatasetReference",
                    },
                    Name = "CADSink",
                },
            },
            Sources = new[]
            {
                new AzureNative.DataFactory.Inputs.DataFlowSourceArgs
                {
                    Dataset = new AzureNative.DataFactory.Inputs.DatasetReferenceArgs
                    {
                        ReferenceName = "CurrencyDatasetUSD",
                        Type = "DatasetReference",
                    },
                    Name = "USDCurrency",
                },
                new AzureNative.DataFactory.Inputs.DataFlowSourceArgs
                {
                    Dataset = new AzureNative.DataFactory.Inputs.DatasetReferenceArgs
                    {
                        ReferenceName = "CurrencyDatasetCAD",
                        Type = "DatasetReference",
                    },
                    Name = "CADSource",
                },
            },
            Type = "MappingDataFlow",
        },
        ResourceGroupName = "exampleResourceGroup",
    });
});
Content copied to clipboard
package main
import (
	datafactory "github.com/pulumi/pulumi-azure-native-sdk/datafactory/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datafactory.NewDataFlow(ctx, "dataFlow", &datafactory.DataFlowArgs{
			DataFlowName: pulumi.String("exampleDataFlow"),
			FactoryName:  pulumi.String("exampleFactoryName"),
			Properties: &datafactory.MappingDataFlowArgs{
				Description: pulumi.String("Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation."),
				ScriptLines: pulumi.StringArray{
					pulumi.String("source(output("),
					pulumi.String("PreviousConversionRate as double,"),
					pulumi.String("Country as string,"),
					pulumi.String("DateTime1 as string,"),
					pulumi.String("CurrentConversionRate as double"),
					pulumi.String("),"),
					pulumi.String("allowSchemaDrift: false,"),
					pulumi.String("validateSchema: false) ~> USDCurrency"),
					pulumi.String("source(output("),
					pulumi.String("PreviousConversionRate as double,"),
					pulumi.String("Country as string,"),
					pulumi.String("DateTime1 as string,"),
					pulumi.String("CurrentConversionRate as double"),
					pulumi.String("),"),
					pulumi.String("allowSchemaDrift: true,"),
					pulumi.String("validateSchema: false) ~> CADSource"),
					pulumi.String("USDCurrency, CADSource union(byName: true)~> Union"),
					pulumi.String("Union derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn"),
					pulumi.String("NewCurrencyColumn split(Country == 'USD',"),
					pulumi.String("Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)"),
					pulumi.String("ConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink"),
					pulumi.String("ConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink"),
				},
				Sinks: datafactory.DataFlowSinkArray{
					&datafactory.DataFlowSinkArgs{
						Dataset: &datafactory.DatasetReferenceArgs{
							ReferenceName: pulumi.String("USDOutput"),
							Type:          pulumi.String("DatasetReference"),
						},
						Name: pulumi.String("USDSink"),
					},
					&datafactory.DataFlowSinkArgs{
						Dataset: &datafactory.DatasetReferenceArgs{
							ReferenceName: pulumi.String("CADOutput"),
							Type:          pulumi.String("DatasetReference"),
						},
						Name: pulumi.String("CADSink"),
					},
				},
				Sources: datafactory.DataFlowSourceArray{
					&datafactory.DataFlowSourceArgs{
						Dataset: &datafactory.DatasetReferenceArgs{
							ReferenceName: pulumi.String("CurrencyDatasetUSD"),
							Type:          pulumi.String("DatasetReference"),
						},
						Name: pulumi.String("USDCurrency"),
					},
					&datafactory.DataFlowSourceArgs{
						Dataset: &datafactory.DatasetReferenceArgs{
							ReferenceName: pulumi.String("CurrencyDatasetCAD"),
							Type:          pulumi.String("DatasetReference"),
						},
						Name: pulumi.String("CADSource"),
					},
				},
				Type: pulumi.String("MappingDataFlow"),
			},
			ResourceGroupName: pulumi.String("exampleResourceGroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.datafactory.DataFlow;
import com.pulumi.azurenative.datafactory.DataFlowArgs;
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 dataFlow = new DataFlow("dataFlow", DataFlowArgs.builder()
            .dataFlowName("exampleDataFlow")
            .factoryName("exampleFactoryName")
            .properties(MappingDataFlowArgs.builder()
                .description("Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.")
                .scriptLines(
                    "source(output(",
                    "PreviousConversionRate as double,",
                    "Country as string,",
                    "DateTime1 as string,",
                    "CurrentConversionRate as double",
                    "),",
                    "allowSchemaDrift: false,",
                    "validateSchema: false) ~> USDCurrency",
                    "source(output(",
                    "PreviousConversionRate as double,",
                    "Country as string,",
                    "DateTime1 as string,",
                    "CurrentConversionRate as double",
                    "),",
                    "allowSchemaDrift: true,",
                    "validateSchema: false) ~> CADSource",
                    "USDCurrency, CADSource union(byName: true)~> Union",
                    "Union derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn",
                    "NewCurrencyColumn split(Country == 'USD',",
                    "Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)",
                    "ConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink",
                    "ConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink")
                .sinks(
                    DataFlowSinkArgs.builder()
                        .dataset(DatasetReferenceArgs.builder()
                            .referenceName("USDOutput")
                            .type("DatasetReference")
                            .build())
                        .name("USDSink")
                        .build(),
                    DataFlowSinkArgs.builder()
                        .dataset(DatasetReferenceArgs.builder()
                            .referenceName("CADOutput")
                            .type("DatasetReference")
                            .build())
                        .name("CADSink")
                        .build())
                .sources(
                    DataFlowSourceArgs.builder()
                        .dataset(DatasetReferenceArgs.builder()
                            .referenceName("CurrencyDatasetUSD")
                            .type("DatasetReference")
                            .build())
                        .name("USDCurrency")
                        .build(),
                    DataFlowSourceArgs.builder()
                        .dataset(DatasetReferenceArgs.builder()
                            .referenceName("CurrencyDatasetCAD")
                            .type("DatasetReference")
                            .build())
                        .name("CADSource")
                        .build())
                .type("MappingDataFlow")
                .build())
            .resourceGroupName("exampleResourceGroup")
            .build());
    }
}
Content copied to clipboard

DataFlows_Update

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var dataFlow = new AzureNative.DataFactory.DataFlow("dataFlow", new()
    {
        DataFlowName = "exampleDataFlow",
        FactoryName = "exampleFactoryName",
        Properties = new AzureNative.DataFactory.Inputs.MappingDataFlowArgs
        {
            Description = "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.",
            ScriptLines = new[]
            {
                "source(output(",
                "PreviousConversionRate as double,",
                "Country as string,",
                "DateTime1 as string,",
                "CurrentConversionRate as double",
                "),",
                "allowSchemaDrift: false,",
                "validateSchema: false) ~> USDCurrency",
                "source(output(",
                "PreviousConversionRate as double,",
                "Country as string,",
                "DateTime1 as string,",
                "CurrentConversionRate as double",
                "),",
                "allowSchemaDrift: true,",
                "validateSchema: false) ~> CADSource",
                "USDCurrency, CADSource union(byName: true)~> Union",
                "Union derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn",
                "NewCurrencyColumn split(Country == 'USD',",
                "Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)",
                "ConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink",
                "ConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink",
            },
            Sinks = new[]
            {
                new AzureNative.DataFactory.Inputs.DataFlowSinkArgs
                {
                    Dataset = new AzureNative.DataFactory.Inputs.DatasetReferenceArgs
                    {
                        ReferenceName = "USDOutput",
                        Type = "DatasetReference",
                    },
                    Name = "USDSink",
                },
                new AzureNative.DataFactory.Inputs.DataFlowSinkArgs
                {
                    Dataset = new AzureNative.DataFactory.Inputs.DatasetReferenceArgs
                    {
                        ReferenceName = "CADOutput",
                        Type = "DatasetReference",
                    },
                    Name = "CADSink",
                },
            },
            Sources = new[]
            {
                new AzureNative.DataFactory.Inputs.DataFlowSourceArgs
                {
                    Dataset = new AzureNative.DataFactory.Inputs.DatasetReferenceArgs
                    {
                        ReferenceName = "CurrencyDatasetUSD",
                        Type = "DatasetReference",
                    },
                    Name = "USDCurrency",
                },
                new AzureNative.DataFactory.Inputs.DataFlowSourceArgs
                {
                    Dataset = new AzureNative.DataFactory.Inputs.DatasetReferenceArgs
                    {
                        ReferenceName = "CurrencyDatasetCAD",
                        Type = "DatasetReference",
                    },
                    Name = "CADSource",
                },
            },
            Type = "MappingDataFlow",
        },
        ResourceGroupName = "exampleResourceGroup",
    });
});
Content copied to clipboard
package main
import (
	datafactory "github.com/pulumi/pulumi-azure-native-sdk/datafactory/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datafactory.NewDataFlow(ctx, "dataFlow", &datafactory.DataFlowArgs{
			DataFlowName: pulumi.String("exampleDataFlow"),
			FactoryName:  pulumi.String("exampleFactoryName"),
			Properties: &datafactory.MappingDataFlowArgs{
				Description: pulumi.String("Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation."),
				ScriptLines: pulumi.StringArray{
					pulumi.String("source(output("),
					pulumi.String("PreviousConversionRate as double,"),
					pulumi.String("Country as string,"),
					pulumi.String("DateTime1 as string,"),
					pulumi.String("CurrentConversionRate as double"),
					pulumi.String("),"),
					pulumi.String("allowSchemaDrift: false,"),
					pulumi.String("validateSchema: false) ~> USDCurrency"),
					pulumi.String("source(output("),
					pulumi.String("PreviousConversionRate as double,"),
					pulumi.String("Country as string,"),
					pulumi.String("DateTime1 as string,"),
					pulumi.String("CurrentConversionRate as double"),
					pulumi.String("),"),
					pulumi.String("allowSchemaDrift: true,"),
					pulumi.String("validateSchema: false) ~> CADSource"),
					pulumi.String("USDCurrency, CADSource union(byName: true)~> Union"),
					pulumi.String("Union derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn"),
					pulumi.String("NewCurrencyColumn split(Country == 'USD',"),
					pulumi.String("Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)"),
					pulumi.String("ConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink"),
					pulumi.String("ConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink"),
				},
				Sinks: datafactory.DataFlowSinkArray{
					&datafactory.DataFlowSinkArgs{
						Dataset: &datafactory.DatasetReferenceArgs{
							ReferenceName: pulumi.String("USDOutput"),
							Type:          pulumi.String("DatasetReference"),
						},
						Name: pulumi.String("USDSink"),
					},
					&datafactory.DataFlowSinkArgs{
						Dataset: &datafactory.DatasetReferenceArgs{
							ReferenceName: pulumi.String("CADOutput"),
							Type:          pulumi.String("DatasetReference"),
						},
						Name: pulumi.String("CADSink"),
					},
				},
				Sources: datafactory.DataFlowSourceArray{
					&datafactory.DataFlowSourceArgs{
						Dataset: &datafactory.DatasetReferenceArgs{
							ReferenceName: pulumi.String("CurrencyDatasetUSD"),
							Type:          pulumi.String("DatasetReference"),
						},
						Name: pulumi.String("USDCurrency"),
					},
					&datafactory.DataFlowSourceArgs{
						Dataset: &datafactory.DatasetReferenceArgs{
							ReferenceName: pulumi.String("CurrencyDatasetCAD"),
							Type:          pulumi.String("DatasetReference"),
						},
						Name: pulumi.String("CADSource"),
					},
				},
				Type: pulumi.String("MappingDataFlow"),
			},
			ResourceGroupName: pulumi.String("exampleResourceGroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.datafactory.DataFlow;
import com.pulumi.azurenative.datafactory.DataFlowArgs;
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 dataFlow = new DataFlow("dataFlow", DataFlowArgs.builder()
            .dataFlowName("exampleDataFlow")
            .factoryName("exampleFactoryName")
            .properties(MappingDataFlowArgs.builder()
                .description("Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.")
                .scriptLines(
                    "source(output(",
                    "PreviousConversionRate as double,",
                    "Country as string,",
                    "DateTime1 as string,",
                    "CurrentConversionRate as double",
                    "),",
                    "allowSchemaDrift: false,",
                    "validateSchema: false) ~> USDCurrency",
                    "source(output(",
                    "PreviousConversionRate as double,",
                    "Country as string,",
                    "DateTime1 as string,",
                    "CurrentConversionRate as double",
                    "),",
                    "allowSchemaDrift: true,",
                    "validateSchema: false) ~> CADSource",
                    "USDCurrency, CADSource union(byName: true)~> Union",
                    "Union derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn",
                    "NewCurrencyColumn split(Country == 'USD',",
                    "Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)",
                    "ConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink",
                    "ConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink")
                .sinks(
                    DataFlowSinkArgs.builder()
                        .dataset(DatasetReferenceArgs.builder()
                            .referenceName("USDOutput")
                            .type("DatasetReference")
                            .build())
                        .name("USDSink")
                        .build(),
                    DataFlowSinkArgs.builder()
                        .dataset(DatasetReferenceArgs.builder()
                            .referenceName("CADOutput")
                            .type("DatasetReference")
                            .build())
                        .name("CADSink")
                        .build())
                .sources(
                    DataFlowSourceArgs.builder()
                        .dataset(DatasetReferenceArgs.builder()
                            .referenceName("CurrencyDatasetUSD")
                            .type("DatasetReference")
                            .build())
                        .name("USDCurrency")
                        .build(),
                    DataFlowSourceArgs.builder()
                        .dataset(DatasetReferenceArgs.builder()
                            .referenceName("CurrencyDatasetCAD")
                            .type("DatasetReference")
                            .build())
                        .name("CADSource")
                        .build())
                .type("MappingDataFlow")
                .build())
            .resourceGroupName("exampleResourceGroup")
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:datafactory:DataFlow exampleDataFlow /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}
Content copied to clipboard

Properties

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val etag: Output<String>

Etag identifies change in the resource.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

The resource name.

Link copied to clipboard
val properties: Output<Any>

Data flow properties.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val type: Output<String>

The resource type.

Link copied to clipboard
val urn: Output<String>