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

We recommend using Azure Native.

Azure Classic v5.67.0 published on Wednesday, Feb 21, 2024 by Pulumi

azure.datafactory.getFactory

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.67.0 published on Wednesday, Feb 21, 2024 by Pulumi

    Use this data source to access information about an existing Azure Data Factory (Version 2).

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Azure.DataFactory.GetFactory.Invoke(new()
        {
            Name = "existing-adf",
            ResourceGroupName = "existing-rg",
        });
    
        return new Dictionary<string, object?>
        {
            ["id"] = example.Apply(getFactoryResult => getFactoryResult.Id),
        };
    });
    
    package main
    
    import (
    	"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 := datafactory.LookupFactory(ctx, &datafactory.LookupFactoryArgs{
    			Name:              "existing-adf",
    			ResourceGroupName: "existing-rg",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("id", example.Id)
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.datafactory.DatafactoryFunctions;
    import com.pulumi.azure.datafactory.inputs.GetFactoryArgs;
    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) {
            final var example = DatafactoryFunctions.getFactory(GetFactoryArgs.builder()
                .name("existing-adf")
                .resourceGroupName("existing-rg")
                .build());
    
            ctx.export("id", example.applyValue(getFactoryResult -> getFactoryResult.id()));
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.datafactory.get_factory(name="existing-adf",
        resource_group_name="existing-rg")
    pulumi.export("id", example.id)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.datafactory.getFactory({
        name: "existing-adf",
        resourceGroupName: "existing-rg",
    });
    export const id = example.then(example => example.id);
    
    variables:
      example:
        fn::invoke:
          Function: azure:datafactory:getFactory
          Arguments:
            name: existing-adf
            resourceGroupName: existing-rg
    outputs:
      id: ${example.id}
    

    Using getFactory

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFactory(args: GetFactoryArgs, opts?: InvokeOptions): Promise<GetFactoryResult>
    function getFactoryOutput(args: GetFactoryOutputArgs, opts?: InvokeOptions): Output<GetFactoryResult>
    def get_factory(name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetFactoryResult
    def get_factory_output(name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetFactoryResult]
    func LookupFactory(ctx *Context, args *LookupFactoryArgs, opts ...InvokeOption) (*LookupFactoryResult, error)
    func LookupFactoryOutput(ctx *Context, args *LookupFactoryOutputArgs, opts ...InvokeOption) LookupFactoryResultOutput

    > Note: This function is named LookupFactory in the Go SDK.

    public static class GetFactory 
    {
        public static Task<GetFactoryResult> InvokeAsync(GetFactoryArgs args, InvokeOptions? opts = null)
        public static Output<GetFactoryResult> Invoke(GetFactoryInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFactoryResult> getFactory(GetFactoryArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure:datafactory/getFactory:getFactory
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of this Azure Data Factory.
    ResourceGroupName string
    The name of the Resource Group where the Azure Data Factory exists.
    Name string
    The name of this Azure Data Factory.
    ResourceGroupName string
    The name of the Resource Group where the Azure Data Factory exists.
    name String
    The name of this Azure Data Factory.
    resourceGroupName String
    The name of the Resource Group where the Azure Data Factory exists.
    name string
    The name of this Azure Data Factory.
    resourceGroupName string
    The name of the Resource Group where the Azure Data Factory exists.
    name str
    The name of this Azure Data Factory.
    resource_group_name str
    The name of the Resource Group where the Azure Data Factory exists.
    name String
    The name of this Azure Data Factory.
    resourceGroupName String
    The name of the Resource Group where the Azure Data Factory exists.

    getFactory Result

    The following output properties are available:

    GithubConfigurations List<GetFactoryGithubConfiguration>
    A github_configuration block as defined below.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identities List<GetFactoryIdentity>
    An identity block as defined below.
    Location string
    The Azure Region where the Azure Data Factory exists.
    Name string
    ResourceGroupName string
    Tags Dictionary<string, string>
    A mapping of tags assigned to the Azure Data Factory.
    VstsConfigurations List<GetFactoryVstsConfiguration>
    A vsts_configuration block as defined below.
    GithubConfigurations []GetFactoryGithubConfiguration
    A github_configuration block as defined below.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identities []GetFactoryIdentity
    An identity block as defined below.
    Location string
    The Azure Region where the Azure Data Factory exists.
    Name string
    ResourceGroupName string
    Tags map[string]string
    A mapping of tags assigned to the Azure Data Factory.
    VstsConfigurations []GetFactoryVstsConfiguration
    A vsts_configuration block as defined below.
    githubConfigurations List<GetFactoryGithubConfiguration>
    A github_configuration block as defined below.
    id String
    The provider-assigned unique ID for this managed resource.
    identities List<GetFactoryIdentity>
    An identity block as defined below.
    location String
    The Azure Region where the Azure Data Factory exists.
    name String
    resourceGroupName String
    tags Map<String,String>
    A mapping of tags assigned to the Azure Data Factory.
    vstsConfigurations List<GetFactoryVstsConfiguration>
    A vsts_configuration block as defined below.
    githubConfigurations GetFactoryGithubConfiguration[]
    A github_configuration block as defined below.
    id string
    The provider-assigned unique ID for this managed resource.
    identities GetFactoryIdentity[]
    An identity block as defined below.
    location string
    The Azure Region where the Azure Data Factory exists.
    name string
    resourceGroupName string
    tags {[key: string]: string}
    A mapping of tags assigned to the Azure Data Factory.
    vstsConfigurations GetFactoryVstsConfiguration[]
    A vsts_configuration block as defined below.
    github_configurations Sequence[GetFactoryGithubConfiguration]
    A github_configuration block as defined below.
    id str
    The provider-assigned unique ID for this managed resource.
    identities Sequence[GetFactoryIdentity]
    An identity block as defined below.
    location str
    The Azure Region where the Azure Data Factory exists.
    name str
    resource_group_name str
    tags Mapping[str, str]
    A mapping of tags assigned to the Azure Data Factory.
    vsts_configurations Sequence[GetFactoryVstsConfiguration]
    A vsts_configuration block as defined below.
    githubConfigurations List<Property Map>
    A github_configuration block as defined below.
    id String
    The provider-assigned unique ID for this managed resource.
    identities List<Property Map>
    An identity block as defined below.
    location String
    The Azure Region where the Azure Data Factory exists.
    name String
    resourceGroupName String
    tags Map<String>
    A mapping of tags assigned to the Azure Data Factory.
    vstsConfigurations List<Property Map>
    A vsts_configuration block as defined below.

    Supporting Types

    GetFactoryGithubConfiguration

    AccountName string
    The VSTS account name.
    BranchName string
    The branch of the repository to get code from.
    GitUrl string
    The GitHub repository url.
    RepositoryName string
    The name of the git repository.
    RootFolder string
    The root folder within the repository.
    AccountName string
    The VSTS account name.
    BranchName string
    The branch of the repository to get code from.
    GitUrl string
    The GitHub repository url.
    RepositoryName string
    The name of the git repository.
    RootFolder string
    The root folder within the repository.
    accountName String
    The VSTS account name.
    branchName String
    The branch of the repository to get code from.
    gitUrl String
    The GitHub repository url.
    repositoryName String
    The name of the git repository.
    rootFolder String
    The root folder within the repository.
    accountName string
    The VSTS account name.
    branchName string
    The branch of the repository to get code from.
    gitUrl string
    The GitHub repository url.
    repositoryName string
    The name of the git repository.
    rootFolder string
    The root folder within the repository.
    account_name str
    The VSTS account name.
    branch_name str
    The branch of the repository to get code from.
    git_url str
    The GitHub repository url.
    repository_name str
    The name of the git repository.
    root_folder str
    The root folder within the repository.
    accountName String
    The VSTS account name.
    branchName String
    The branch of the repository to get code from.
    gitUrl String
    The GitHub repository url.
    repositoryName String
    The name of the git repository.
    rootFolder String
    The root folder within the repository.

    GetFactoryIdentity

    IdentityIds List<string>
    The list of User Assigned Managed Identity IDs assigned to this Data Factory.
    PrincipalId string
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Data Factory.
    TenantId string
    The Tenant ID associated with the VSTS account.
    Type string
    The type of Managed Service Identity that is configured on this Data Factory.
    IdentityIds []string
    The list of User Assigned Managed Identity IDs assigned to this Data Factory.
    PrincipalId string
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Data Factory.
    TenantId string
    The Tenant ID associated with the VSTS account.
    Type string
    The type of Managed Service Identity that is configured on this Data Factory.
    identityIds List<String>
    The list of User Assigned Managed Identity IDs assigned to this Data Factory.
    principalId String
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Data Factory.
    tenantId String
    The Tenant ID associated with the VSTS account.
    type String
    The type of Managed Service Identity that is configured on this Data Factory.
    identityIds string[]
    The list of User Assigned Managed Identity IDs assigned to this Data Factory.
    principalId string
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Data Factory.
    tenantId string
    The Tenant ID associated with the VSTS account.
    type string
    The type of Managed Service Identity that is configured on this Data Factory.
    identity_ids Sequence[str]
    The list of User Assigned Managed Identity IDs assigned to this Data Factory.
    principal_id str
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Data Factory.
    tenant_id str
    The Tenant ID associated with the VSTS account.
    type str
    The type of Managed Service Identity that is configured on this Data Factory.
    identityIds List<String>
    The list of User Assigned Managed Identity IDs assigned to this Data Factory.
    principalId String
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Data Factory.
    tenantId String
    The Tenant ID associated with the VSTS account.
    type String
    The type of Managed Service Identity that is configured on this Data Factory.

    GetFactoryVstsConfiguration

    AccountName string
    The VSTS account name.
    BranchName string
    The branch of the repository to get code from.
    ProjectName string
    The name of the VSTS project.
    RepositoryName string
    The name of the git repository.
    RootFolder string
    The root folder within the repository.
    TenantId string
    The Tenant ID associated with the VSTS account.
    AccountName string
    The VSTS account name.
    BranchName string
    The branch of the repository to get code from.
    ProjectName string
    The name of the VSTS project.
    RepositoryName string
    The name of the git repository.
    RootFolder string
    The root folder within the repository.
    TenantId string
    The Tenant ID associated with the VSTS account.
    accountName String
    The VSTS account name.
    branchName String
    The branch of the repository to get code from.
    projectName String
    The name of the VSTS project.
    repositoryName String
    The name of the git repository.
    rootFolder String
    The root folder within the repository.
    tenantId String
    The Tenant ID associated with the VSTS account.
    accountName string
    The VSTS account name.
    branchName string
    The branch of the repository to get code from.
    projectName string
    The name of the VSTS project.
    repositoryName string
    The name of the git repository.
    rootFolder string
    The root folder within the repository.
    tenantId string
    The Tenant ID associated with the VSTS account.
    account_name str
    The VSTS account name.
    branch_name str
    The branch of the repository to get code from.
    project_name str
    The name of the VSTS project.
    repository_name str
    The name of the git repository.
    root_folder str
    The root folder within the repository.
    tenant_id str
    The Tenant ID associated with the VSTS account.
    accountName String
    The VSTS account name.
    branchName String
    The branch of the repository to get code from.
    projectName String
    The name of the VSTS project.
    repositoryName String
    The name of the git repository.
    rootFolder String
    The root folder within the repository.
    tenantId String
    The Tenant ID associated with the VSTS account.

    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.67.0 published on Wednesday, Feb 21, 2024 by Pulumi