LinkedServiceDataLakeStorageGen2

Manages a Linked Service (connection) between Data Lake Storage Gen2 and Azure Data Factory.

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,
        });
        var current = Output.Create(Azure.Core.GetClientConfig.InvokeAsync());
        var exampleLinkedServiceDataLakeStorageGen2 = new Azure.DataFactory.LinkedServiceDataLakeStorageGen2("exampleLinkedServiceDataLakeStorageGen2", new Azure.DataFactory.LinkedServiceDataLakeStorageGen2Args
        {
            ResourceGroupName = exampleResourceGroup.Name,
            DataFactoryName = exampleFactory.Name,
            ServicePrincipalId = current.Apply(current => current.ClientId),
            ServicePrincipalKey = "exampleKey",
            Tenant = "11111111-1111-1111-1111-111111111111",
            Url = "https://datalakestoragegen2",
        });
    }

}

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
        }
        exampleFactory, err := datafactory.NewFactory(ctx, "exampleFactory", &datafactory.FactoryArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
        })
        if err != nil {
            return err
        }
        current, err := core.GetClientConfig(ctx, nil, nil)
        if err != nil {
            return err
        }
        _, err = datafactory.NewLinkedServiceDataLakeStorageGen2(ctx, "exampleLinkedServiceDataLakeStorageGen2", &datafactory.LinkedServiceDataLakeStorageGen2Args{
            ResourceGroupName:   exampleResourceGroup.Name,
            DataFactoryName:     exampleFactory.Name,
            ServicePrincipalId:  pulumi.String(current.ClientId),
            ServicePrincipalKey: pulumi.String("exampleKey"),
            Tenant:              pulumi.String("11111111-1111-1111-1111-111111111111"),
            Url:                 pulumi.String("https://datalakestoragegen2"),
        })
        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)
current = azure.core.get_client_config()
example_linked_service_data_lake_storage_gen2 = azure.datafactory.LinkedServiceDataLakeStorageGen2("exampleLinkedServiceDataLakeStorageGen2",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    service_principal_id=current.client_id,
    service_principal_key="exampleKey",
    tenant="11111111-1111-1111-1111-111111111111",
    url="https://datalakestoragegen2")

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,
});
const current = azure.core.getClientConfig({});
const exampleLinkedServiceDataLakeStorageGen2 = new azure.datafactory.LinkedServiceDataLakeStorageGen2("exampleLinkedServiceDataLakeStorageGen2", {
    resourceGroupName: exampleResourceGroup.name,
    dataFactoryName: exampleFactory.name,
    servicePrincipalId: current.then(current => current.clientId),
    servicePrincipalKey: "exampleKey",
    tenant: "11111111-1111-1111-1111-111111111111",
    url: "https://datalakestoragegen2",
});

Create a LinkedServiceDataLakeStorageGen2 Resource

new LinkedServiceDataLakeStorageGen2(name: string, args: LinkedServiceDataLakeStorageGen2Args, opts?: CustomResourceOptions);

def LinkedServiceDataLakeStorageGen2(resource_name, opts=None, additional_properties=None, annotations=None, data_factory_name=None, description=None, integration_runtime_name=None, name=None, parameters=None, resource_group_name=None, service_principal_id=None, service_principal_key=None, tenant=None, url=None, __props__=None);

func NewLinkedServiceDataLakeStorageGen2(ctx *Context, name string, args LinkedServiceDataLakeStorageGen2Args, opts ...ResourceOption) (*LinkedServiceDataLakeStorageGen2, error)

public LinkedServiceDataLakeStorageGen2(string name, LinkedServiceDataLakeStorageGen2Args args, CustomResourceOptions? opts = null)

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

name string: The unique name of the resource.
args LinkedServiceDataLakeStorageGen2Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

LinkedServiceDataLakeStorageGen2 Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The LinkedServiceDataLakeStorageGen2 resource accepts the following input properties:

DataFactoryName string: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Linked Service MySQL. Changing this forces a new resource
ServicePrincipalId string: The service principal id in which to authenticate against the Azure Data Lake Storage Gen2 account.
ServicePrincipalKey string: The service principal key in which to authenticate against the Azure Data Lake Storage Gen2 account.
Tenant string: The tenant id or name in which to authenticate against the Azure Data Lake Storage Gen2 account.
Url string: The endpoint for the Azure Data Lake Storage Gen2 service.
AdditionalProperties Dictionary<string, string>: A map of additional properties to associate with the Data Factory Linked Service MySQL.
Annotations List<string>: List of tags that can be used for describing the Data Factory Linked Service MySQL.
Description string: The description for the Data Factory Linked Service MySQL.
IntegrationRuntimeName string: The integration runtime reference to associate with the Data Factory Linked Service MySQL.
Name string: Specifies the name of the Data Factory Linked Service MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
Parameters Dictionary<string, string>: A map of parameters to associate with the Data Factory Linked Service MySQL.

DataFactoryName string: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Linked Service MySQL. Changing this forces a new resource
ServicePrincipalId string: The service principal id in which to authenticate against the Azure Data Lake Storage Gen2 account.
ServicePrincipalKey string: The service principal key in which to authenticate against the Azure Data Lake Storage Gen2 account.
Tenant string: The tenant id or name in which to authenticate against the Azure Data Lake Storage Gen2 account.
Url string: The endpoint for the Azure Data Lake Storage Gen2 service.
AdditionalProperties map[string]string: A map of additional properties to associate with the Data Factory Linked Service MySQL.
Annotations []string: List of tags that can be used for describing the Data Factory Linked Service MySQL.
Description string: The description for the Data Factory Linked Service MySQL.
IntegrationRuntimeName string: The integration runtime reference to associate with the Data Factory Linked Service MySQL.
Name string: Specifies the name of the Data Factory Linked Service MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
Parameters map[string]string: A map of parameters to associate with the Data Factory Linked Service MySQL.

dataFactoryName string: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
resourceGroupName string: The name of the resource group in which to create the Data Factory Linked Service MySQL. Changing this forces a new resource
servicePrincipalId string: The service principal id in which to authenticate against the Azure Data Lake Storage Gen2 account.
servicePrincipalKey string: The service principal key in which to authenticate against the Azure Data Lake Storage Gen2 account.
tenant string: The tenant id or name in which to authenticate against the Azure Data Lake Storage Gen2 account.
url string: The endpoint for the Azure Data Lake Storage Gen2 service.
additionalProperties {[key: string]: string}: A map of additional properties to associate with the Data Factory Linked Service MySQL.
annotations string[]: List of tags that can be used for describing the Data Factory Linked Service MySQL.
description string: The description for the Data Factory Linked Service MySQL.
integrationRuntimeName string: The integration runtime reference to associate with the Data Factory Linked Service MySQL.
name string: Specifies the name of the Data Factory Linked Service MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters {[key: string]: string}: A map of parameters to associate with the Data Factory Linked Service MySQL.

data_factory_name str: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
resource_group_name str: The name of the resource group in which to create the Data Factory Linked Service MySQL. Changing this forces a new resource
service_principal_id str: The service principal id in which to authenticate against the Azure Data Lake Storage Gen2 account.
service_principal_key str: The service principal key in which to authenticate against the Azure Data Lake Storage Gen2 account.
tenant str: The tenant id or name in which to authenticate against the Azure Data Lake Storage Gen2 account.
url str: The endpoint for the Azure Data Lake Storage Gen2 service.
additional_properties Dict[str, str]: A map of additional properties to associate with the Data Factory Linked Service MySQL.
annotations List[str]: List of tags that can be used for describing the Data Factory Linked Service MySQL.
description str: The description for the Data Factory Linked Service MySQL.
integration_runtime_name str: The integration runtime reference to associate with the Data Factory Linked Service MySQL.
name str: Specifies the name of the Data Factory Linked Service MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters Dict[str, str]: A map of parameters to associate with the Data Factory Linked Service MySQL.

Outputs

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

Get an existing LinkedServiceDataLakeStorageGen2 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?: LinkedServiceDataLakeStorageGen2State, opts?: CustomResourceOptions): LinkedServiceDataLakeStorageGen2

static get(resource_name, id, opts=None, additional_properties=None, annotations=None, data_factory_name=None, description=None, integration_runtime_name=None, name=None, parameters=None, resource_group_name=None, service_principal_id=None, service_principal_key=None, tenant=None, url=None, __props__=None);

func GetLinkedServiceDataLakeStorageGen2(ctx *Context, name string, id IDInput, state *LinkedServiceDataLakeStorageGen2State, opts ...ResourceOption) (*LinkedServiceDataLakeStorageGen2, error)

public static LinkedServiceDataLakeStorageGen2 Get(string name, Input<string> id, LinkedServiceDataLakeStorageGen2State? 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:

AdditionalProperties Dictionary<string, string>: A map of additional properties to associate with the Data Factory Linked Service MySQL.
Annotations List<string>: List of tags that can be used for describing the Data Factory Linked Service MySQL.
DataFactoryName string: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
Description string: The description for the Data Factory Linked Service MySQL.
IntegrationRuntimeName string: The integration runtime reference to associate with the Data Factory Linked Service MySQL.
Name string: Specifies the name of the Data Factory Linked Service MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
Parameters Dictionary<string, string>: A map of parameters to associate with the Data Factory Linked Service MySQL.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Linked Service MySQL. Changing this forces a new resource
ServicePrincipalId string: The service principal id in which to authenticate against the Azure Data Lake Storage Gen2 account.
ServicePrincipalKey string: The service principal key in which to authenticate against the Azure Data Lake Storage Gen2 account.
Tenant string: The tenant id or name in which to authenticate against the Azure Data Lake Storage Gen2 account.
Url string: The endpoint for the Azure Data Lake Storage Gen2 service.

AdditionalProperties map[string]string: A map of additional properties to associate with the Data Factory Linked Service MySQL.
Annotations []string: List of tags that can be used for describing the Data Factory Linked Service MySQL.
DataFactoryName string: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
Description string: The description for the Data Factory Linked Service MySQL.
IntegrationRuntimeName string: The integration runtime reference to associate with the Data Factory Linked Service MySQL.
Name string: Specifies the name of the Data Factory Linked Service MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
Parameters map[string]string: A map of parameters to associate with the Data Factory Linked Service MySQL.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Linked Service MySQL. Changing this forces a new resource
ServicePrincipalId string: The service principal id in which to authenticate against the Azure Data Lake Storage Gen2 account.
ServicePrincipalKey string: The service principal key in which to authenticate against the Azure Data Lake Storage Gen2 account.
Tenant string: The tenant id or name in which to authenticate against the Azure Data Lake Storage Gen2 account.
Url string: The endpoint for the Azure Data Lake Storage Gen2 service.

additionalProperties {[key: string]: string}: A map of additional properties to associate with the Data Factory Linked Service MySQL.
annotations string[]: List of tags that can be used for describing the Data Factory Linked Service MySQL.
dataFactoryName string: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
description string: The description for the Data Factory Linked Service MySQL.
integrationRuntimeName string: The integration runtime reference to associate with the Data Factory Linked Service MySQL.
name string: Specifies the name of the Data Factory Linked Service MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters {[key: string]: string}: A map of parameters to associate with the Data Factory Linked Service MySQL.
resourceGroupName string: The name of the resource group in which to create the Data Factory Linked Service MySQL. Changing this forces a new resource
servicePrincipalId string: The service principal id in which to authenticate against the Azure Data Lake Storage Gen2 account.
servicePrincipalKey string: The service principal key in which to authenticate against the Azure Data Lake Storage Gen2 account.
tenant string: The tenant id or name in which to authenticate against the Azure Data Lake Storage Gen2 account.
url string: The endpoint for the Azure Data Lake Storage Gen2 service.

additional_properties Dict[str, str]: A map of additional properties to associate with the Data Factory Linked Service MySQL.
annotations List[str]: List of tags that can be used for describing the Data Factory Linked Service MySQL.
data_factory_name str: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
description str: The description for the Data Factory Linked Service MySQL.
integration_runtime_name str: The integration runtime reference to associate with the Data Factory Linked Service MySQL.
name str: Specifies the name of the Data Factory Linked Service MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters Dict[str, str]: A map of parameters to associate with the Data Factory Linked Service MySQL.
resource_group_name str: The name of the resource group in which to create the Data Factory Linked Service MySQL. Changing this forces a new resource
service_principal_id str: The service principal id in which to authenticate against the Azure Data Lake Storage Gen2 account.
service_principal_key str: The service principal key in which to authenticate against the Azure Data Lake Storage Gen2 account.
tenant str: The tenant id or name in which to authenticate against the Azure Data Lake Storage Gen2 account.
url str: The endpoint for the Azure Data Lake Storage Gen2 service.

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