Factory

Manages an Azure Data Factory (Version 2).

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

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

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("northeurope"),
        })
        if err != nil {
            return err
        }
        _, err = datafactory.NewFactory(ctx, "exampleFactory", &datafactory.FactoryArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

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

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

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

Create a Factory Resource

new Factory(name: string, args: FactoryArgs, opts?: CustomResourceOptions);

def Factory(resource_name, opts=None, github_configuration=None, identity=None, location=None, name=None, resource_group_name=None, tags=None, vsts_configuration=None, __props__=None);

func NewFactory(ctx *Context, name string, args FactoryArgs, opts ...ResourceOption) (*Factory, error)

public Factory(string name, FactoryArgs args, CustomResourceOptions? opts = null)

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

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args 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.

Factory Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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.
GithubConfiguration FactoryGithubConfigurationArgs: A github_configuration block as defined below.
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.
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.
Tags Dictionary<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.
GithubConfiguration FactoryGithubConfiguration: A github_configuration block as defined below.
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.
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.
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.
githubConfiguration FactoryGithubConfiguration: A github_configuration block as defined below.
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.
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.
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.
github_configuration Dict[FactoryGithubConfiguration]: A github_configuration block as defined below.
identity Dict[FactoryIdentity]: 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.
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.
tags Dict[str, str]: A mapping of tags to assign to the resource.
vsts_configuration Dict[FactoryVstsConfiguration]: 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 str: The provider-assigned unique ID for this managed resource.

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

static get(resource_name, id, opts=None, github_configuration=None, identity=None, location=None, name=None, resource_group_name=None, tags=None, vsts_configuration=None, __props__=None);

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)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

GithubConfiguration FactoryGithubConfigurationArgs: A github_configuration block as defined below.
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.
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.
ResourceGroupName string: The name of the resource group in which to create the Data Factory.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
VstsConfiguration FactoryVstsConfigurationArgs: A vsts_configuration block as defined below.

GithubConfiguration FactoryGithubConfiguration: A github_configuration block as defined below.
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.
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.
ResourceGroupName string: The name of the resource group in which to create 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.

githubConfiguration FactoryGithubConfiguration: A github_configuration block as defined below.
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.
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.
resourceGroupName string: The name of the resource group in which to create 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.

github_configuration Dict[FactoryGithubConfiguration]: A github_configuration block as defined below.
identity Dict[FactoryIdentity]: 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.
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.
resource_group_name str: The name of the resource group in which to create the Data Factory.
tags Dict[str, str]: A mapping of tags to assign to the resource.
vsts_configuration Dict[FactoryVstsConfiguration]: A vsts_configuration block as defined below.

Supporting Types

FactoryGithubConfiguration

See the input and output API doc for this type.

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

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

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

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

FactoryIdentity

See the input and output API doc for this type.

Type string: Specifies the identity type of the Data Factory. At this time the only allowed value is SystemAssigned.
PrincipalId string: The ID of the Principal (Client) in Azure Active Directory
TenantId string: Specifies the Tenant ID associated with the VSTS account.

Type string: Specifies the identity type of the Data Factory. At this time the only allowed value is SystemAssigned.
PrincipalId string: The ID of the Principal (Client) in Azure Active Directory
TenantId string: Specifies the Tenant ID associated with the VSTS account.

type string: Specifies the identity type of the Data Factory. At this time the only allowed value is SystemAssigned.
principalId string: The ID of the Principal (Client) in Azure Active Directory
tenantId string: Specifies the Tenant ID associated with the VSTS account.

type str: Specifies the identity type of the Data Factory. At this time the only allowed value is SystemAssigned.
principal_id str: The ID of the Principal (Client) in Azure Active Directory
tenant_id str: Specifies the Tenant ID associated with the VSTS account.

FactoryVstsConfiguration

See the input and output API doc for this type.

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.

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.

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.

account_name str: Specifies the VSTS account name.
branchName str: Specifies the branch of the repository to get code from.
projectName str: Specifies the name of the VSTS project.
repositoryName str: Specifies the name of the git repository.
rootFolder 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.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Factory

Example Usage

Create a Factory Resource

Factory Resource Properties

Inputs

Outputs

Look up an Existing Factory Resource

Supporting Types

FactoryGithubConfiguration

FactoryIdentity

FactoryVstsConfiguration

Package Details

On This Page