1. Packages
  2. Azure Classic
  3. API Docs
  4. datafactory
  5. Factory

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.datafactory.Factory

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages an Azure Data Factory (Version 2).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleFactory = new azure.datafactory.Factory("example", {
        name: "example",
        location: example.location,
        resourceGroupName: example.name,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_factory = azure.datafactory.Factory("example",
        name="example",
        location=example.location,
        resource_group_name=example.name)
    
    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 {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
    			Name:              pulumi.String("example"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleFactory = new Azure.DataFactory.Factory("example", new()
        {
            Name = "example",
            Location = example.Location,
            ResourceGroupName = example.Name,
        });
    
    });
    
    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 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
                .name("example")
                .location(example.location())
                .resourceGroupName(example.name())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleFactory:
        type: azure:datafactory:Factory
        name: example
        properties:
          name: example
          location: ${example.location}
          resourceGroupName: ${example.name}
    

    Create Factory Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Factory(name: string, args: FactoryArgs, opts?: CustomResourceOptions);
    @overload
    def Factory(resource_name: str,
                args: FactoryArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Factory(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                resource_group_name: Optional[str] = None,
                managed_virtual_network_enabled: Optional[bool] = None,
                github_configuration: Optional[FactoryGithubConfigurationArgs] = None,
                global_parameters: Optional[Sequence[FactoryGlobalParameterArgs]] = None,
                identity: Optional[FactoryIdentityArgs] = None,
                location: Optional[str] = None,
                customer_managed_key_id: Optional[str] = None,
                name: Optional[str] = None,
                public_network_enabled: Optional[bool] = None,
                purview_id: Optional[str] = None,
                customer_managed_key_identity_id: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                vsts_configuration: Optional[FactoryVstsConfigurationArgs] = None)
    func NewFactory(ctx *Context, name string, args FactoryArgs, opts ...ResourceOption) (*Factory, error)
    public Factory(string name, FactoryArgs args, CustomResourceOptions? opts = null)
    public Factory(String name, FactoryArgs args)
    public Factory(String name, FactoryArgs args, CustomResourceOptions options)
    
    type: azure:datafactory:Factory
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FactoryArgs
    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 FactoryArgs
    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 FactoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FactoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FactoryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var factoryResource = new Azure.DataFactory.Factory("factoryResource", new()
    {
        ResourceGroupName = "string",
        ManagedVirtualNetworkEnabled = false,
        GithubConfiguration = new Azure.DataFactory.Inputs.FactoryGithubConfigurationArgs
        {
            AccountName = "string",
            BranchName = "string",
            RepositoryName = "string",
            RootFolder = "string",
            GitUrl = "string",
            PublishingEnabled = false,
        },
        GlobalParameters = new[]
        {
            new Azure.DataFactory.Inputs.FactoryGlobalParameterArgs
            {
                Name = "string",
                Type = "string",
                Value = "string",
            },
        },
        Identity = new Azure.DataFactory.Inputs.FactoryIdentityArgs
        {
            Type = "string",
            IdentityIds = new[]
            {
                "string",
            },
            PrincipalId = "string",
            TenantId = "string",
        },
        Location = "string",
        CustomerManagedKeyId = "string",
        Name = "string",
        PublicNetworkEnabled = false,
        PurviewId = "string",
        CustomerManagedKeyIdentityId = "string",
        Tags = 
        {
            { "string", "string" },
        },
        VstsConfiguration = new Azure.DataFactory.Inputs.FactoryVstsConfigurationArgs
        {
            AccountName = "string",
            BranchName = "string",
            ProjectName = "string",
            RepositoryName = "string",
            RootFolder = "string",
            TenantId = "string",
            PublishingEnabled = false,
        },
    });
    
    example, err := datafactory.NewFactory(ctx, "factoryResource", &datafactory.FactoryArgs{
    	ResourceGroupName:            pulumi.String("string"),
    	ManagedVirtualNetworkEnabled: pulumi.Bool(false),
    	GithubConfiguration: &datafactory.FactoryGithubConfigurationArgs{
    		AccountName:       pulumi.String("string"),
    		BranchName:        pulumi.String("string"),
    		RepositoryName:    pulumi.String("string"),
    		RootFolder:        pulumi.String("string"),
    		GitUrl:            pulumi.String("string"),
    		PublishingEnabled: pulumi.Bool(false),
    	},
    	GlobalParameters: datafactory.FactoryGlobalParameterArray{
    		&datafactory.FactoryGlobalParameterArgs{
    			Name:  pulumi.String("string"),
    			Type:  pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	Identity: &datafactory.FactoryIdentityArgs{
    		Type: pulumi.String("string"),
    		IdentityIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		PrincipalId: pulumi.String("string"),
    		TenantId:    pulumi.String("string"),
    	},
    	Location:                     pulumi.String("string"),
    	CustomerManagedKeyId:         pulumi.String("string"),
    	Name:                         pulumi.String("string"),
    	PublicNetworkEnabled:         pulumi.Bool(false),
    	PurviewId:                    pulumi.String("string"),
    	CustomerManagedKeyIdentityId: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	VstsConfiguration: &datafactory.FactoryVstsConfigurationArgs{
    		AccountName:       pulumi.String("string"),
    		BranchName:        pulumi.String("string"),
    		ProjectName:       pulumi.String("string"),
    		RepositoryName:    pulumi.String("string"),
    		RootFolder:        pulumi.String("string"),
    		TenantId:          pulumi.String("string"),
    		PublishingEnabled: pulumi.Bool(false),
    	},
    })
    
    var factoryResource = new Factory("factoryResource", FactoryArgs.builder()
        .resourceGroupName("string")
        .managedVirtualNetworkEnabled(false)
        .githubConfiguration(FactoryGithubConfigurationArgs.builder()
            .accountName("string")
            .branchName("string")
            .repositoryName("string")
            .rootFolder("string")
            .gitUrl("string")
            .publishingEnabled(false)
            .build())
        .globalParameters(FactoryGlobalParameterArgs.builder()
            .name("string")
            .type("string")
            .value("string")
            .build())
        .identity(FactoryIdentityArgs.builder()
            .type("string")
            .identityIds("string")
            .principalId("string")
            .tenantId("string")
            .build())
        .location("string")
        .customerManagedKeyId("string")
        .name("string")
        .publicNetworkEnabled(false)
        .purviewId("string")
        .customerManagedKeyIdentityId("string")
        .tags(Map.of("string", "string"))
        .vstsConfiguration(FactoryVstsConfigurationArgs.builder()
            .accountName("string")
            .branchName("string")
            .projectName("string")
            .repositoryName("string")
            .rootFolder("string")
            .tenantId("string")
            .publishingEnabled(false)
            .build())
        .build());
    
    factory_resource = azure.datafactory.Factory("factoryResource",
        resource_group_name="string",
        managed_virtual_network_enabled=False,
        github_configuration=azure.datafactory.FactoryGithubConfigurationArgs(
            account_name="string",
            branch_name="string",
            repository_name="string",
            root_folder="string",
            git_url="string",
            publishing_enabled=False,
        ),
        global_parameters=[azure.datafactory.FactoryGlobalParameterArgs(
            name="string",
            type="string",
            value="string",
        )],
        identity=azure.datafactory.FactoryIdentityArgs(
            type="string",
            identity_ids=["string"],
            principal_id="string",
            tenant_id="string",
        ),
        location="string",
        customer_managed_key_id="string",
        name="string",
        public_network_enabled=False,
        purview_id="string",
        customer_managed_key_identity_id="string",
        tags={
            "string": "string",
        },
        vsts_configuration=azure.datafactory.FactoryVstsConfigurationArgs(
            account_name="string",
            branch_name="string",
            project_name="string",
            repository_name="string",
            root_folder="string",
            tenant_id="string",
            publishing_enabled=False,
        ))
    
    const factoryResource = new azure.datafactory.Factory("factoryResource", {
        resourceGroupName: "string",
        managedVirtualNetworkEnabled: false,
        githubConfiguration: {
            accountName: "string",
            branchName: "string",
            repositoryName: "string",
            rootFolder: "string",
            gitUrl: "string",
            publishingEnabled: false,
        },
        globalParameters: [{
            name: "string",
            type: "string",
            value: "string",
        }],
        identity: {
            type: "string",
            identityIds: ["string"],
            principalId: "string",
            tenantId: "string",
        },
        location: "string",
        customerManagedKeyId: "string",
        name: "string",
        publicNetworkEnabled: false,
        purviewId: "string",
        customerManagedKeyIdentityId: "string",
        tags: {
            string: "string",
        },
        vstsConfiguration: {
            accountName: "string",
            branchName: "string",
            projectName: "string",
            repositoryName: "string",
            rootFolder: "string",
            tenantId: "string",
            publishingEnabled: false,
        },
    });
    
    type: azure:datafactory:Factory
    properties:
        customerManagedKeyId: string
        customerManagedKeyIdentityId: string
        githubConfiguration:
            accountName: string
            branchName: string
            gitUrl: string
            publishingEnabled: false
            repositoryName: string
            rootFolder: string
        globalParameters:
            - name: string
              type: string
              value: string
        identity:
            identityIds:
                - string
            principalId: string
            tenantId: string
            type: string
        location: string
        managedVirtualNetworkEnabled: false
        name: string
        publicNetworkEnabled: false
        purviewId: string
        resourceGroupName: string
        tags:
            string: string
        vstsConfiguration:
            accountName: string
            branchName: string
            projectName: string
            publishingEnabled: false
            repositoryName: string
            rootFolder: string
            tenantId: string
    

    Factory 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 Factory resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
    CustomerManagedKeyId string
    Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
    CustomerManagedKeyIdentityId string
    Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_id is set.
    GithubConfiguration FactoryGithubConfiguration
    A github_configuration block as defined below.
    GlobalParameters List<FactoryGlobalParameter>
    A list of global_parameter blocks as defined above.
    Identity FactoryIdentity
    An identity block as defined below.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    ManagedVirtualNetworkEnabled bool
    Is Managed Virtual Network enabled?
    Name string
    Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    PublicNetworkEnabled bool
    Is the Data Factory visible to the public network? Defaults to true.
    PurviewId string
    Specifies the ID of the purview account resource associated with the Data Factory.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    VstsConfiguration FactoryVstsConfiguration
    A vsts_configuration block as defined below.
    ResourceGroupName string
    The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
    CustomerManagedKeyId string
    Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
    CustomerManagedKeyIdentityId string
    Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_id is set.
    GithubConfiguration FactoryGithubConfigurationArgs
    A github_configuration block as defined below.
    GlobalParameters []FactoryGlobalParameterArgs
    A list of global_parameter blocks as defined above.
    Identity FactoryIdentityArgs
    An identity block as defined below.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    ManagedVirtualNetworkEnabled bool
    Is Managed Virtual Network enabled?
    Name string
    Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    PublicNetworkEnabled bool
    Is the Data Factory visible to the public network? Defaults to true.
    PurviewId string
    Specifies the ID of the purview account resource associated with the Data Factory.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    VstsConfiguration FactoryVstsConfigurationArgs
    A vsts_configuration block as defined below.
    resourceGroupName String
    The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
    customerManagedKeyId String
    Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
    customerManagedKeyIdentityId String
    Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_id is set.
    githubConfiguration FactoryGithubConfiguration
    A github_configuration block as defined below.
    globalParameters List<FactoryGlobalParameter>
    A list of global_parameter blocks as defined above.
    identity FactoryIdentity
    An identity block as defined below.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    managedVirtualNetworkEnabled Boolean
    Is Managed Virtual Network enabled?
    name String
    Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    publicNetworkEnabled Boolean
    Is the Data Factory visible to the public network? Defaults to true.
    purviewId String
    Specifies the ID of the purview account resource associated with the Data Factory.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    vstsConfiguration FactoryVstsConfiguration
    A vsts_configuration block as defined below.
    resourceGroupName string
    The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
    customerManagedKeyId string
    Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
    customerManagedKeyIdentityId string
    Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_id is set.
    githubConfiguration FactoryGithubConfiguration
    A github_configuration block as defined below.
    globalParameters FactoryGlobalParameter[]
    A list of global_parameter blocks as defined above.
    identity FactoryIdentity
    An identity block as defined below.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    managedVirtualNetworkEnabled boolean
    Is Managed Virtual Network enabled?
    name string
    Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    publicNetworkEnabled boolean
    Is the Data Factory visible to the public network? Defaults to true.
    purviewId string
    Specifies the ID of the purview account resource associated with the Data Factory.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    vstsConfiguration FactoryVstsConfiguration
    A vsts_configuration block as defined below.
    resource_group_name str
    The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
    customer_managed_key_id str
    Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
    customer_managed_key_identity_id str
    Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_id is set.
    github_configuration FactoryGithubConfigurationArgs
    A github_configuration block as defined below.
    global_parameters Sequence[FactoryGlobalParameterArgs]
    A list of global_parameter blocks as defined above.
    identity FactoryIdentityArgs
    An identity block as defined below.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    managed_virtual_network_enabled bool
    Is Managed Virtual Network enabled?
    name str
    Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    public_network_enabled bool
    Is the Data Factory visible to the public network? Defaults to true.
    purview_id str
    Specifies the ID of the purview account resource associated with the Data Factory.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    vsts_configuration FactoryVstsConfigurationArgs
    A vsts_configuration block as defined below.
    resourceGroupName String
    The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
    customerManagedKeyId String
    Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
    customerManagedKeyIdentityId String
    Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_id is set.
    githubConfiguration Property Map
    A github_configuration block as defined below.
    globalParameters List<Property Map>
    A list of global_parameter blocks as defined above.
    identity Property Map
    An identity block as defined below.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    managedVirtualNetworkEnabled Boolean
    Is Managed Virtual Network enabled?
    name String
    Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    publicNetworkEnabled Boolean
    Is the Data Factory visible to the public network? Defaults to true.
    purviewId String
    Specifies the ID of the purview account resource associated with the Data Factory.
    tags Map<String>
    A mapping of tags to assign to the resource.
    vstsConfiguration Property Map
    A vsts_configuration block as defined below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Factory 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 Factory Resource

    Get an existing Factory 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?: FactoryState, opts?: CustomResourceOptions): Factory
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            customer_managed_key_id: Optional[str] = None,
            customer_managed_key_identity_id: Optional[str] = None,
            github_configuration: Optional[FactoryGithubConfigurationArgs] = None,
            global_parameters: Optional[Sequence[FactoryGlobalParameterArgs]] = None,
            identity: Optional[FactoryIdentityArgs] = None,
            location: Optional[str] = None,
            managed_virtual_network_enabled: Optional[bool] = None,
            name: Optional[str] = None,
            public_network_enabled: Optional[bool] = None,
            purview_id: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            vsts_configuration: Optional[FactoryVstsConfigurationArgs] = None) -> Factory
    func GetFactory(ctx *Context, name string, id IDInput, state *FactoryState, opts ...ResourceOption) (*Factory, error)
    public static Factory Get(string name, Input<string> id, FactoryState? state, CustomResourceOptions? opts = null)
    public static Factory get(String name, Output<String> id, FactoryState 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:
    CustomerManagedKeyId string
    Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
    CustomerManagedKeyIdentityId string
    Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_id is set.
    GithubConfiguration FactoryGithubConfiguration
    A github_configuration block as defined below.
    GlobalParameters List<FactoryGlobalParameter>
    A list of global_parameter blocks as defined above.
    Identity FactoryIdentity
    An identity block as defined below.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    ManagedVirtualNetworkEnabled bool
    Is Managed Virtual Network enabled?
    Name string
    Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    PublicNetworkEnabled bool
    Is the Data Factory visible to the public network? Defaults to true.
    PurviewId string
    Specifies the ID of the purview account resource associated with the Data Factory.
    ResourceGroupName string
    The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    VstsConfiguration FactoryVstsConfiguration
    A vsts_configuration block as defined below.
    CustomerManagedKeyId string
    Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
    CustomerManagedKeyIdentityId string
    Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_id is set.
    GithubConfiguration FactoryGithubConfigurationArgs
    A github_configuration block as defined below.
    GlobalParameters []FactoryGlobalParameterArgs
    A list of global_parameter blocks as defined above.
    Identity FactoryIdentityArgs
    An identity block as defined below.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    ManagedVirtualNetworkEnabled bool
    Is Managed Virtual Network enabled?
    Name string
    Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    PublicNetworkEnabled bool
    Is the Data Factory visible to the public network? Defaults to true.
    PurviewId string
    Specifies the ID of the purview account resource associated with the Data Factory.
    ResourceGroupName string
    The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    VstsConfiguration FactoryVstsConfigurationArgs
    A vsts_configuration block as defined below.
    customerManagedKeyId String
    Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
    customerManagedKeyIdentityId String
    Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_id is set.
    githubConfiguration FactoryGithubConfiguration
    A github_configuration block as defined below.
    globalParameters List<FactoryGlobalParameter>
    A list of global_parameter blocks as defined above.
    identity FactoryIdentity
    An identity block as defined below.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    managedVirtualNetworkEnabled Boolean
    Is Managed Virtual Network enabled?
    name String
    Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    publicNetworkEnabled Boolean
    Is the Data Factory visible to the public network? Defaults to true.
    purviewId String
    Specifies the ID of the purview account resource associated with the Data Factory.
    resourceGroupName String
    The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    vstsConfiguration FactoryVstsConfiguration
    A vsts_configuration block as defined below.
    customerManagedKeyId string
    Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
    customerManagedKeyIdentityId string
    Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_id is set.
    githubConfiguration FactoryGithubConfiguration
    A github_configuration block as defined below.
    globalParameters FactoryGlobalParameter[]
    A list of global_parameter blocks as defined above.
    identity FactoryIdentity
    An identity block as defined below.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    managedVirtualNetworkEnabled boolean
    Is Managed Virtual Network enabled?
    name string
    Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    publicNetworkEnabled boolean
    Is the Data Factory visible to the public network? Defaults to true.
    purviewId string
    Specifies the ID of the purview account resource associated with the Data Factory.
    resourceGroupName string
    The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    vstsConfiguration FactoryVstsConfiguration
    A vsts_configuration block as defined below.
    customer_managed_key_id str
    Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
    customer_managed_key_identity_id str
    Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_id is set.
    github_configuration FactoryGithubConfigurationArgs
    A github_configuration block as defined below.
    global_parameters Sequence[FactoryGlobalParameterArgs]
    A list of global_parameter blocks as defined above.
    identity FactoryIdentityArgs
    An identity block as defined below.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    managed_virtual_network_enabled bool
    Is Managed Virtual Network enabled?
    name str
    Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    public_network_enabled bool
    Is the Data Factory visible to the public network? Defaults to true.
    purview_id str
    Specifies the ID of the purview account resource associated with the Data Factory.
    resource_group_name str
    The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    vsts_configuration FactoryVstsConfigurationArgs
    A vsts_configuration block as defined below.
    customerManagedKeyId String
    Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
    customerManagedKeyIdentityId String
    Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_id is set.
    githubConfiguration Property Map
    A github_configuration block as defined below.
    globalParameters List<Property Map>
    A list of global_parameter blocks as defined above.
    identity Property Map
    An identity block as defined below.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    managedVirtualNetworkEnabled Boolean
    Is Managed Virtual Network enabled?
    name String
    Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
    publicNetworkEnabled Boolean
    Is the Data Factory visible to the public network? Defaults to true.
    purviewId String
    Specifies the ID of the purview account resource associated with the Data Factory.
    resourceGroupName String
    The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.
    vstsConfiguration Property Map
    A vsts_configuration block as defined below.

    Supporting Types

    FactoryGithubConfiguration, FactoryGithubConfigurationArgs

    AccountName string
    Specifies the GitHub account name.
    BranchName string
    Specifies the branch of the repository to get code from.
    RepositoryName string
    Specifies the name of the git repository.
    RootFolder string
    Specifies the root folder within the repository. Set to / for the top level.
    GitUrl string
    Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com. Use https://github.com for open source repositories.
    PublishingEnabled bool

    Is automated publishing enabled? Defaults to true.

    Note: You must log in to the Data Factory management UI to complete the authentication to the GitHub repository.

    AccountName string
    Specifies the GitHub account name.
    BranchName string
    Specifies the branch of the repository to get code from.
    RepositoryName string
    Specifies the name of the git repository.
    RootFolder string
    Specifies the root folder within the repository. Set to / for the top level.
    GitUrl string
    Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com. Use https://github.com for open source repositories.
    PublishingEnabled bool

    Is automated publishing enabled? Defaults to true.

    Note: You must log in to the Data Factory management UI to complete the authentication to the GitHub repository.

    accountName String
    Specifies the GitHub account name.
    branchName String
    Specifies the branch of the repository to get code from.
    repositoryName String
    Specifies the name of the git repository.
    rootFolder String
    Specifies the root folder within the repository. Set to / for the top level.
    gitUrl String
    Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com. Use https://github.com for open source repositories.
    publishingEnabled Boolean

    Is automated publishing enabled? Defaults to true.

    Note: You must log in to the Data Factory management UI to complete the authentication to the GitHub repository.

    accountName string
    Specifies the GitHub account name.
    branchName string
    Specifies the branch of the repository to get code from.
    repositoryName string
    Specifies the name of the git repository.
    rootFolder string
    Specifies the root folder within the repository. Set to / for the top level.
    gitUrl string
    Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com. Use https://github.com for open source repositories.
    publishingEnabled boolean

    Is automated publishing enabled? Defaults to true.

    Note: You must log in to the Data Factory management UI to complete the authentication to the GitHub repository.

    account_name str
    Specifies the GitHub account name.
    branch_name str
    Specifies the branch of the repository to get code from.
    repository_name str
    Specifies the name of the git repository.
    root_folder str
    Specifies the root folder within the repository. Set to / for the top level.
    git_url str
    Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com. Use https://github.com for open source repositories.
    publishing_enabled bool

    Is automated publishing enabled? Defaults to true.

    Note: You must log in to the Data Factory management UI to complete the authentication to the GitHub repository.

    accountName String
    Specifies the GitHub account name.
    branchName String
    Specifies the branch of the repository to get code from.
    repositoryName String
    Specifies the name of the git repository.
    rootFolder String
    Specifies the root folder within the repository. Set to / for the top level.
    gitUrl String
    Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com. Use https://github.com for open source repositories.
    publishingEnabled Boolean

    Is automated publishing enabled? Defaults to true.

    Note: You must log in to the Data Factory management UI to complete the authentication to the GitHub repository.

    FactoryGlobalParameter, FactoryGlobalParameterArgs

    Name string
    Specifies the global parameter name.
    Type string
    Specifies the global parameter type. Possible Values are Array, Bool, Float, Int, Object or String.
    Value string

    Specifies the global parameter value.

    Note: For type Array and Object it is recommended to use jsonencode() for the value

    Name string
    Specifies the global parameter name.
    Type string
    Specifies the global parameter type. Possible Values are Array, Bool, Float, Int, Object or String.
    Value string

    Specifies the global parameter value.

    Note: For type Array and Object it is recommended to use jsonencode() for the value

    name String
    Specifies the global parameter name.
    type String
    Specifies the global parameter type. Possible Values are Array, Bool, Float, Int, Object or String.
    value String

    Specifies the global parameter value.

    Note: For type Array and Object it is recommended to use jsonencode() for the value

    name string
    Specifies the global parameter name.
    type string
    Specifies the global parameter type. Possible Values are Array, Bool, Float, Int, Object or String.
    value string

    Specifies the global parameter value.

    Note: For type Array and Object it is recommended to use jsonencode() for the value

    name str
    Specifies the global parameter name.
    type str
    Specifies the global parameter type. Possible Values are Array, Bool, Float, Int, Object or String.
    value str

    Specifies the global parameter value.

    Note: For type Array and Object it is recommended to use jsonencode() for the value

    name String
    Specifies the global parameter name.
    type String
    Specifies the global parameter type. Possible Values are Array, Bool, Float, Int, Object or String.
    value String

    Specifies the global parameter value.

    Note: For type Array and Object it is recommended to use jsonencode() for the value

    FactoryIdentity, FactoryIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this Data Factory. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    IdentityIds List<string>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Data Factory.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    Type string
    Specifies the type of Managed Service Identity that should be configured on this Data Factory. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    IdentityIds []string

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Data Factory.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Data Factory. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Data Factory.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.
    type string
    Specifies the type of Managed Service Identity that should be configured on this Data Factory. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds string[]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Data Factory.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId string
    The Principal ID associated with this Managed Service Identity.
    tenantId string
    The Tenant ID associated with this Managed Service Identity.
    type str
    Specifies the type of Managed Service Identity that should be configured on this Data Factory. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identity_ids Sequence[str]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Data Factory.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principal_id str
    The Principal ID associated with this Managed Service Identity.
    tenant_id str
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Data Factory. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Data Factory.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.

    FactoryVstsConfiguration, FactoryVstsConfigurationArgs

    AccountName string
    Specifies the VSTS account name.
    BranchName string
    Specifies the branch of the repository to get code from.
    ProjectName string
    Specifies the name of the VSTS project.
    RepositoryName string
    Specifies the name of the git repository.
    RootFolder string
    Specifies the root folder within the repository. Set to / for the top level.
    TenantId string
    Specifies the Tenant ID associated with the VSTS account.
    PublishingEnabled bool
    Is automated publishing enabled? Defaults to true.
    AccountName string
    Specifies the VSTS account name.
    BranchName string
    Specifies the branch of the repository to get code from.
    ProjectName string
    Specifies the name of the VSTS project.
    RepositoryName string
    Specifies the name of the git repository.
    RootFolder string
    Specifies the root folder within the repository. Set to / for the top level.
    TenantId string
    Specifies the Tenant ID associated with the VSTS account.
    PublishingEnabled bool
    Is automated publishing enabled? Defaults to true.
    accountName String
    Specifies the VSTS account name.
    branchName String
    Specifies the branch of the repository to get code from.
    projectName String
    Specifies the name of the VSTS project.
    repositoryName String
    Specifies the name of the git repository.
    rootFolder String
    Specifies the root folder within the repository. Set to / for the top level.
    tenantId String
    Specifies the Tenant ID associated with the VSTS account.
    publishingEnabled Boolean
    Is automated publishing enabled? Defaults to true.
    accountName string
    Specifies the VSTS account name.
    branchName string
    Specifies the branch of the repository to get code from.
    projectName string
    Specifies the name of the VSTS project.
    repositoryName string
    Specifies the name of the git repository.
    rootFolder string
    Specifies the root folder within the repository. Set to / for the top level.
    tenantId string
    Specifies the Tenant ID associated with the VSTS account.
    publishingEnabled boolean
    Is automated publishing enabled? Defaults to true.
    account_name str
    Specifies the VSTS account name.
    branch_name str
    Specifies the branch of the repository to get code from.
    project_name str
    Specifies the name of the VSTS project.
    repository_name str
    Specifies the name of the git repository.
    root_folder str
    Specifies the root folder within the repository. Set to / for the top level.
    tenant_id str
    Specifies the Tenant ID associated with the VSTS account.
    publishing_enabled bool
    Is automated publishing enabled? Defaults to true.
    accountName String
    Specifies the VSTS account name.
    branchName String
    Specifies the branch of the repository to get code from.
    projectName String
    Specifies the name of the VSTS project.
    repositoryName String
    Specifies the name of the git repository.
    rootFolder String
    Specifies the root folder within the repository. Set to / for the top level.
    tenantId String
    Specifies the Tenant ID associated with the VSTS account.
    publishingEnabled Boolean
    Is automated publishing enabled? Defaults to true.

    Import

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

    $ pulumi import azure:datafactory/factory:Factory example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi