We recommend using Azure Native.
azure.datafactory.Factory
Explore with Pulumi AI
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/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/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.
Constructor 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={
        "account_name": "string",
        "branch_name": "string",
        "repository_name": "string",
        "root_folder": "string",
        "git_url": "string",
        "publishing_enabled": False,
    },
    global_parameters=[{
        "name": "string",
        "type": "string",
        "value": "string",
    }],
    identity={
        "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={
        "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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Factory resource accepts the following input properties:
- ResourceGroup stringName 
- The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
- CustomerManaged stringKey Id 
- Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
- CustomerManaged stringKey Identity Id 
- Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_idis set.
- GithubConfiguration FactoryGithub Configuration 
- A github_configurationblock as defined below.
- GlobalParameters List<FactoryGlobal Parameter> 
- A list of global_parameterblocks as defined above.
- Identity
FactoryIdentity 
- An identityblock as defined below.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- ManagedVirtual boolNetwork Enabled 
- 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.
- PublicNetwork boolEnabled 
- 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.
- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- VstsConfiguration FactoryVsts Configuration 
- A vsts_configurationblock as defined below.
- ResourceGroup stringName 
- The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
- CustomerManaged stringKey Id 
- Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
- CustomerManaged stringKey Identity Id 
- Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_idis set.
- GithubConfiguration FactoryGithub Configuration Args 
- A github_configurationblock as defined below.
- GlobalParameters []FactoryGlobal Parameter Args 
- A list of global_parameterblocks as defined above.
- Identity
FactoryIdentity Args 
- An identityblock as defined below.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- ManagedVirtual boolNetwork Enabled 
- 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.
- PublicNetwork boolEnabled 
- 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.
- map[string]string
- A mapping of tags to assign to the resource.
- VstsConfiguration FactoryVsts Configuration Args 
- A vsts_configurationblock as defined below.
- resourceGroup StringName 
- The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
- customerManaged StringKey Id 
- Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
- customerManaged StringKey Identity Id 
- Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_idis set.
- githubConfiguration FactoryGithub Configuration 
- A github_configurationblock as defined below.
- globalParameters List<FactoryGlobal Parameter> 
- A list of global_parameterblocks as defined above.
- identity
FactoryIdentity 
- An identityblock as defined below.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- managedVirtual BooleanNetwork Enabled 
- 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.
- publicNetwork BooleanEnabled 
- 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.
- Map<String,String>
- A mapping of tags to assign to the resource.
- vstsConfiguration FactoryVsts Configuration 
- A vsts_configurationblock as defined below.
- resourceGroup stringName 
- The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
- customerManaged stringKey Id 
- Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
- customerManaged stringKey Identity Id 
- Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_idis set.
- githubConfiguration FactoryGithub Configuration 
- A github_configurationblock as defined below.
- globalParameters FactoryGlobal Parameter[] 
- A list of global_parameterblocks as defined above.
- identity
FactoryIdentity 
- An identityblock as defined below.
- location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- managedVirtual booleanNetwork Enabled 
- 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.
- publicNetwork booleanEnabled 
- 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.
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- vstsConfiguration FactoryVsts Configuration 
- A vsts_configurationblock as defined below.
- resource_group_ strname 
- The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
- customer_managed_ strkey_ id 
- 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_ strkey_ identity_ id 
- Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_idis set.
- github_configuration FactoryGithub Configuration Args 
- A github_configurationblock as defined below.
- global_parameters Sequence[FactoryGlobal Parameter Args] 
- A list of global_parameterblocks as defined above.
- identity
FactoryIdentity Args 
- An identityblock 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_ boolnetwork_ enabled 
- 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_ boolenabled 
- 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.
- Mapping[str, str]
- A mapping of tags to assign to the resource.
- vsts_configuration FactoryVsts Configuration Args 
- A vsts_configurationblock as defined below.
- resourceGroup StringName 
- The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
- customerManaged StringKey Id 
- Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
- customerManaged StringKey Identity Id 
- Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_idis set.
- githubConfiguration Property Map
- A github_configurationblock as defined below.
- globalParameters List<Property Map>
- A list of global_parameterblocks as defined above.
- identity Property Map
- An identityblock as defined below.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- managedVirtual BooleanNetwork Enabled 
- 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.
- publicNetwork BooleanEnabled 
- 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.
- Map<String>
- A mapping of tags to assign to the resource.
- vstsConfiguration Property Map
- A vsts_configurationblock 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) -> Factoryfunc 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)resources:  _:    type: azure:datafactory:Factory    get:      id: ${id}- 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.
- CustomerManaged stringKey Id 
- Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
- CustomerManaged stringKey Identity Id 
- Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_idis set.
- GithubConfiguration FactoryGithub Configuration 
- A github_configurationblock as defined below.
- GlobalParameters List<FactoryGlobal Parameter> 
- A list of global_parameterblocks as defined above.
- Identity
FactoryIdentity 
- An identityblock as defined below.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- ManagedVirtual boolNetwork Enabled 
- 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.
- PublicNetwork boolEnabled 
- 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.
- ResourceGroup stringName 
- The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- VstsConfiguration FactoryVsts Configuration 
- A vsts_configurationblock as defined below.
- CustomerManaged stringKey Id 
- Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
- CustomerManaged stringKey Identity Id 
- Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_idis set.
- GithubConfiguration FactoryGithub Configuration Args 
- A github_configurationblock as defined below.
- GlobalParameters []FactoryGlobal Parameter Args 
- A list of global_parameterblocks as defined above.
- Identity
FactoryIdentity Args 
- An identityblock as defined below.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- ManagedVirtual boolNetwork Enabled 
- 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.
- PublicNetwork boolEnabled 
- 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.
- ResourceGroup stringName 
- The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
- map[string]string
- A mapping of tags to assign to the resource.
- VstsConfiguration FactoryVsts Configuration Args 
- A vsts_configurationblock as defined below.
- customerManaged StringKey Id 
- Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
- customerManaged StringKey Identity Id 
- Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_idis set.
- githubConfiguration FactoryGithub Configuration 
- A github_configurationblock as defined below.
- globalParameters List<FactoryGlobal Parameter> 
- A list of global_parameterblocks as defined above.
- identity
FactoryIdentity 
- An identityblock as defined below.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- managedVirtual BooleanNetwork Enabled 
- 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.
- publicNetwork BooleanEnabled 
- 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.
- resourceGroup StringName 
- The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
- Map<String,String>
- A mapping of tags to assign to the resource.
- vstsConfiguration FactoryVsts Configuration 
- A vsts_configurationblock as defined below.
- customerManaged stringKey Id 
- Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
- customerManaged stringKey Identity Id 
- Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_idis set.
- githubConfiguration FactoryGithub Configuration 
- A github_configurationblock as defined below.
- globalParameters FactoryGlobal Parameter[] 
- A list of global_parameterblocks as defined above.
- identity
FactoryIdentity 
- An identityblock as defined below.
- location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- managedVirtual booleanNetwork Enabled 
- 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.
- publicNetwork booleanEnabled 
- 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.
- resourceGroup stringName 
- The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- vstsConfiguration FactoryVsts Configuration 
- A vsts_configurationblock as defined below.
- customer_managed_ strkey_ id 
- 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_ strkey_ identity_ id 
- Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_idis set.
- github_configuration FactoryGithub Configuration Args 
- A github_configurationblock as defined below.
- global_parameters Sequence[FactoryGlobal Parameter Args] 
- A list of global_parameterblocks as defined above.
- identity
FactoryIdentity Args 
- An identityblock 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_ boolnetwork_ enabled 
- 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_ boolenabled 
- 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_ strname 
- The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
- Mapping[str, str]
- A mapping of tags to assign to the resource.
- vsts_configuration FactoryVsts Configuration Args 
- A vsts_configurationblock as defined below.
- customerManaged StringKey Id 
- Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
- customerManaged StringKey Identity Id 
- Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if customer_managed_key_idis set.
- githubConfiguration Property Map
- A github_configurationblock as defined below.
- globalParameters List<Property Map>
- A list of global_parameterblocks as defined above.
- identity Property Map
- An identityblock as defined below.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- managedVirtual BooleanNetwork Enabled 
- 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.
- publicNetwork BooleanEnabled 
- 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.
- resourceGroup StringName 
- The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
- Map<String>
- A mapping of tags to assign to the resource.
- vstsConfiguration Property Map
- A vsts_configurationblock 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      
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 - typeis set to- UserAssignedor- 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 - typeis set to- UserAssignedor- 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 - typeis set to- UserAssignedor- 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 - typeis set to- UserAssignedor- 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 - typeis set to- UserAssignedor- 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 - typeis set to- UserAssignedor- 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 azurermTerraform Provider.