Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. datafactory
  5. LinkedServiceDataLakeStorageGen2

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.datafactory.LinkedServiceDataLakeStorageGen2

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

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

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

    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)
current = azure.core.get_client_config()
example_linked_service_data_lake_storage_gen2 = azure.datafactory.LinkedServiceDataLakeStorageGen2("example",
    name="example",
    data_factory_id=example_factory.id,
    service_principal_id=current.client_id,
    service_principal_key="exampleKey",
    tenant="11111111-1111-1111-1111-111111111111",
    url="https://datalakestoragegen2")

    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
		}
		exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
			Name:              pulumi.String("example"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		current, err := core.GetClientConfig(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		_, err = datafactory.NewLinkedServiceDataLakeStorageGen2(ctx, "example", &datafactory.LinkedServiceDataLakeStorageGen2Args{
			Name:                pulumi.String("example"),
			DataFactoryId:       exampleFactory.ID(),
			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
	})
}

    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,
    });

    var current = Azure.Core.GetClientConfig.Invoke();

    var exampleLinkedServiceDataLakeStorageGen2 = new Azure.DataFactory.LinkedServiceDataLakeStorageGen2("example", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        ServicePrincipalId = current.Apply(getClientConfigResult => getClientConfigResult.ClientId),
        ServicePrincipalKey = "exampleKey",
        Tenant = "11111111-1111-1111-1111-111111111111",
        Url = "https://datalakestoragegen2",
    });

});

    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 com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.datafactory.LinkedServiceDataLakeStorageGen2;
import com.pulumi.azure.datafactory.LinkedServiceDataLakeStorageGen2Args;
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());

        final var current = CoreFunctions.getClientConfig();

        var exampleLinkedServiceDataLakeStorageGen2 = new LinkedServiceDataLakeStorageGen2("exampleLinkedServiceDataLakeStorageGen2", LinkedServiceDataLakeStorageGen2Args.builder()
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .servicePrincipalId(current.applyValue(getClientConfigResult -> getClientConfigResult.clientId()))
            .servicePrincipalKey("exampleKey")
            .tenant("11111111-1111-1111-1111-111111111111")
            .url("https://datalakestoragegen2")
            .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}
  exampleLinkedServiceDataLakeStorageGen2:
    type: azure:datafactory:LinkedServiceDataLakeStorageGen2
    name: example
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      servicePrincipalId: ${current.clientId}
      servicePrincipalKey: exampleKey
      tenant: 11111111-1111-1111-1111-111111111111
      url: https://datalakestoragegen2
variables:
  current:
    fn::invoke:
      Function: azure:core:getClientConfig
      Arguments: {}

    Create LinkedServiceDataLakeStorageGen2 Resource

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

    Constructor syntax

    new LinkedServiceDataLakeStorageGen2(name: string, args: LinkedServiceDataLakeStorageGen2Args, opts?: CustomResourceOptions);
    @overload
def LinkedServiceDataLakeStorageGen2(resource_name: str,
                                     args: LinkedServiceDataLakeStorageGen2Args,
                                     opts: Optional[ResourceOptions] = None)

@overload
def LinkedServiceDataLakeStorageGen2(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     data_factory_id: Optional[str] = None,
                                     url: Optional[str] = None,
                                     parameters: Optional[Mapping[str, str]] = None,
                                     description: Optional[str] = None,
                                     integration_runtime_name: Optional[str] = None,
                                     name: Optional[str] = None,
                                     additional_properties: Optional[Mapping[str, str]] = None,
                                     service_principal_id: Optional[str] = None,
                                     service_principal_key: Optional[str] = None,
                                     storage_account_key: Optional[str] = None,
                                     tenant: Optional[str] = None,
                                     annotations: Optional[Sequence[str]] = None,
                                     use_managed_identity: Optional[bool] = None)
    func NewLinkedServiceDataLakeStorageGen2(ctx *Context, name string, args LinkedServiceDataLakeStorageGen2Args, opts ...ResourceOption) (*LinkedServiceDataLakeStorageGen2, error)
    public LinkedServiceDataLakeStorageGen2(string name, LinkedServiceDataLakeStorageGen2Args args, CustomResourceOptions? opts = null)
    public LinkedServiceDataLakeStorageGen2(String name, LinkedServiceDataLakeStorageGen2Args args)
public LinkedServiceDataLakeStorageGen2(String name, LinkedServiceDataLakeStorageGen2Args args, CustomResourceOptions options)

    type: azure:datafactory:LinkedServiceDataLakeStorageGen2
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 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.
    args LinkedServiceDataLakeStorageGen2Args
    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 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.
    name String
    The unique name of the resource.
    args LinkedServiceDataLakeStorageGen2Args
    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 linkedServiceDataLakeStorageGen2Resource = new Azure.DataFactory.LinkedServiceDataLakeStorageGen2("linkedServiceDataLakeStorageGen2Resource", new()
{
    DataFactoryId = "string",
    Url = "string",
    Parameters = 
    {
        { "string", "string" },
    },
    Description = "string",
    IntegrationRuntimeName = "string",
    Name = "string",
    AdditionalProperties = 
    {
        { "string", "string" },
    },
    ServicePrincipalId = "string",
    ServicePrincipalKey = "string",
    StorageAccountKey = "string",
    Tenant = "string",
    Annotations = new[]
    {
        "string",
    },
    UseManagedIdentity = false,
});

    example, err := datafactory.NewLinkedServiceDataLakeStorageGen2(ctx, "linkedServiceDataLakeStorageGen2Resource", &datafactory.LinkedServiceDataLakeStorageGen2Args{
	DataFactoryId: pulumi.String("string"),
	Url:           pulumi.String("string"),
	Parameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description:            pulumi.String("string"),
	IntegrationRuntimeName: pulumi.String("string"),
	Name:                   pulumi.String("string"),
	AdditionalProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ServicePrincipalId:  pulumi.String("string"),
	ServicePrincipalKey: pulumi.String("string"),
	StorageAccountKey:   pulumi.String("string"),
	Tenant:              pulumi.String("string"),
	Annotations: pulumi.StringArray{
		pulumi.String("string"),
	},
	UseManagedIdentity: pulumi.Bool(false),
})

    var linkedServiceDataLakeStorageGen2Resource = new LinkedServiceDataLakeStorageGen2("linkedServiceDataLakeStorageGen2Resource", LinkedServiceDataLakeStorageGen2Args.builder()
    .dataFactoryId("string")
    .url("string")
    .parameters(Map.of("string", "string"))
    .description("string")
    .integrationRuntimeName("string")
    .name("string")
    .additionalProperties(Map.of("string", "string"))
    .servicePrincipalId("string")
    .servicePrincipalKey("string")
    .storageAccountKey("string")
    .tenant("string")
    .annotations("string")
    .useManagedIdentity(false)
    .build());

    linked_service_data_lake_storage_gen2_resource = azure.datafactory.LinkedServiceDataLakeStorageGen2("linkedServiceDataLakeStorageGen2Resource",
    data_factory_id="string",
    url="string",
    parameters={
        "string": "string",
    },
    description="string",
    integration_runtime_name="string",
    name="string",
    additional_properties={
        "string": "string",
    },
    service_principal_id="string",
    service_principal_key="string",
    storage_account_key="string",
    tenant="string",
    annotations=["string"],
    use_managed_identity=False)

    const linkedServiceDataLakeStorageGen2Resource = new azure.datafactory.LinkedServiceDataLakeStorageGen2("linkedServiceDataLakeStorageGen2Resource", {
    dataFactoryId: "string",
    url: "string",
    parameters: {
        string: "string",
    },
    description: "string",
    integrationRuntimeName: "string",
    name: "string",
    additionalProperties: {
        string: "string",
    },
    servicePrincipalId: "string",
    servicePrincipalKey: "string",
    storageAccountKey: "string",
    tenant: "string",
    annotations: ["string"],
    useManagedIdentity: false,
});

    type: azure:datafactory:LinkedServiceDataLakeStorageGen2
properties:
    additionalProperties:
        string: string
    annotations:
        - string
    dataFactoryId: string
    description: string
    integrationRuntimeName: string
    name: string
    parameters:
        string: string
    servicePrincipalId: string
    servicePrincipalKey: string
    storageAccountKey: string
    tenant: string
    url: string
    useManagedIdentity: false

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

    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Url string

    The endpoint for the Azure Data Lake Storage Gen2 service.

    NOTE Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.

    AdditionalProperties Dictionary<string, string>

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:

    Annotations List<string>
    List of tags that can be used for describing the Data Factory Linked Service.
    Description string
    The description for the Data Factory Linked Service.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    Name string
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    Parameters Dictionary<string, string>
    A map of parameters to associate with the Data Factory Linked Service.
    ServicePrincipalId string
    The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with storage_account_key and use_managed_identity.
    ServicePrincipalKey string
    The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
    StorageAccountKey string
    The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and use_managed_identity.
    Tenant string

    The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.

    NOTE If service_principal_id is used, service_principal_key and tenant are also required.

    UseManagedIdentity bool
    Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and storage_account_key.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Url string

    The endpoint for the Azure Data Lake Storage Gen2 service.

    NOTE Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.

    AdditionalProperties map[string]string

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:

    Annotations []string
    List of tags that can be used for describing the Data Factory Linked Service.
    Description string
    The description for the Data Factory Linked Service.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    Name string
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    Parameters map[string]string
    A map of parameters to associate with the Data Factory Linked Service.
    ServicePrincipalId string
    The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with storage_account_key and use_managed_identity.
    ServicePrincipalKey string
    The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
    StorageAccountKey string
    The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and use_managed_identity.
    Tenant string

    The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.

    NOTE If service_principal_id is used, service_principal_key and tenant are also required.

    UseManagedIdentity bool
    Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and storage_account_key.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    url String

    The endpoint for the Azure Data Lake Storage Gen2 service.

    NOTE Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.

    additionalProperties Map<String,String>

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    description String
    The description for the Data Factory Linked Service.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service.
    name String
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters Map<String,String>
    A map of parameters to associate with the Data Factory Linked Service.
    servicePrincipalId String
    The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with storage_account_key and use_managed_identity.
    servicePrincipalKey String
    The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
    storageAccountKey String
    The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and use_managed_identity.
    tenant String

    The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.

    NOTE If service_principal_id is used, service_principal_key and tenant are also required.

    useManagedIdentity Boolean
    Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and storage_account_key.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    url string

    The endpoint for the Azure Data Lake Storage Gen2 service.

    NOTE Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.

    additionalProperties {[key: string]: string}

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:

    annotations string[]
    List of tags that can be used for describing the Data Factory Linked Service.
    description string
    The description for the Data Factory Linked Service.
    integrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    name string
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters {[key: string]: string}
    A map of parameters to associate with the Data Factory Linked Service.
    servicePrincipalId string
    The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with storage_account_key and use_managed_identity.
    servicePrincipalKey string
    The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
    storageAccountKey string
    The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and use_managed_identity.
    tenant string

    The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.

    NOTE If service_principal_id is used, service_principal_key and tenant are also required.

    useManagedIdentity boolean
    Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and storage_account_key.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    url str

    The endpoint for the Azure Data Lake Storage Gen2 service.

    NOTE Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.

    additional_properties Mapping[str, str]

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:

    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Linked Service.
    description str
    The description for the Data Factory Linked Service.
    integration_runtime_name str
    The integration runtime reference to associate with the Data Factory Linked Service.
    name str
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters Mapping[str, str]
    A map of parameters to associate with the Data Factory Linked Service.
    service_principal_id str
    The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with storage_account_key and use_managed_identity.
    service_principal_key str
    The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
    storage_account_key str
    The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and use_managed_identity.
    tenant str

    The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.

    NOTE If service_principal_id is used, service_principal_key and tenant are also required.

    use_managed_identity bool
    Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and storage_account_key.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    url String

    The endpoint for the Azure Data Lake Storage Gen2 service.

    NOTE Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.

    additionalProperties Map<String>

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    description String
    The description for the Data Factory Linked Service.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service.
    name String
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters Map<String>
    A map of parameters to associate with the Data Factory Linked Service.
    servicePrincipalId String
    The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with storage_account_key and use_managed_identity.
    servicePrincipalKey String
    The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
    storageAccountKey String
    The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and use_managed_identity.
    tenant String

    The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.

    NOTE If service_principal_id is used, service_principal_key and tenant are also required.

    useManagedIdentity Boolean
    Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and storage_account_key.

    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 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 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_properties: Optional[Mapping[str, str]] = None,
        annotations: Optional[Sequence[str]] = None,
        data_factory_id: Optional[str] = None,
        description: Optional[str] = None,
        integration_runtime_name: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        service_principal_id: Optional[str] = None,
        service_principal_key: Optional[str] = None,
        storage_account_key: Optional[str] = None,
        tenant: Optional[str] = None,
        url: Optional[str] = None,
        use_managed_identity: Optional[bool] = None) -> LinkedServiceDataLakeStorageGen2
    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)
    public static LinkedServiceDataLakeStorageGen2 get(String name, Output<String> id, LinkedServiceDataLakeStorageGen2State state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdditionalProperties Dictionary<string, string>

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:

    Annotations List<string>
    List of tags that can be used for describing the Data Factory Linked Service.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Description string
    The description for the Data Factory Linked Service.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    Name string
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    Parameters Dictionary<string, string>
    A map of parameters to associate with the Data Factory Linked Service.
    ServicePrincipalId string
    The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with storage_account_key and use_managed_identity.
    ServicePrincipalKey string
    The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
    StorageAccountKey string
    The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and use_managed_identity.
    Tenant string

    The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.

    NOTE If service_principal_id is used, service_principal_key and tenant are also required.

    Url string

    The endpoint for the Azure Data Lake Storage Gen2 service.

    NOTE Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.

    UseManagedIdentity bool
    Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and storage_account_key.
    AdditionalProperties map[string]string

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:

    Annotations []string
    List of tags that can be used for describing the Data Factory Linked Service.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Description string
    The description for the Data Factory Linked Service.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    Name string
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    Parameters map[string]string
    A map of parameters to associate with the Data Factory Linked Service.
    ServicePrincipalId string
    The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with storage_account_key and use_managed_identity.
    ServicePrincipalKey string
    The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
    StorageAccountKey string
    The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and use_managed_identity.
    Tenant string

    The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.

    NOTE If service_principal_id is used, service_principal_key and tenant are also required.

    Url string

    The endpoint for the Azure Data Lake Storage Gen2 service.

    NOTE Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.

    UseManagedIdentity bool
    Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and storage_account_key.
    additionalProperties Map<String,String>

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description String
    The description for the Data Factory Linked Service.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service.
    name String
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters Map<String,String>
    A map of parameters to associate with the Data Factory Linked Service.
    servicePrincipalId String
    The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with storage_account_key and use_managed_identity.
    servicePrincipalKey String
    The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
    storageAccountKey String
    The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and use_managed_identity.
    tenant String

    The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.

    NOTE If service_principal_id is used, service_principal_key and tenant are also required.

    url String

    The endpoint for the Azure Data Lake Storage Gen2 service.

    NOTE Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.

    useManagedIdentity Boolean
    Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and storage_account_key.
    additionalProperties {[key: string]: string}

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:

    annotations string[]
    List of tags that can be used for describing the Data Factory Linked Service.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description string
    The description for the Data Factory Linked Service.
    integrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    name string
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters {[key: string]: string}
    A map of parameters to associate with the Data Factory Linked Service.
    servicePrincipalId string
    The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with storage_account_key and use_managed_identity.
    servicePrincipalKey string
    The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
    storageAccountKey string
    The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and use_managed_identity.
    tenant string

    The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.

    NOTE If service_principal_id is used, service_principal_key and tenant are also required.

    url string

    The endpoint for the Azure Data Lake Storage Gen2 service.

    NOTE Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.

    useManagedIdentity boolean
    Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and storage_account_key.
    additional_properties Mapping[str, str]

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:

    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Linked Service.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description str
    The description for the Data Factory Linked Service.
    integration_runtime_name str
    The integration runtime reference to associate with the Data Factory Linked Service.
    name str
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters Mapping[str, str]
    A map of parameters to associate with the Data Factory Linked Service.
    service_principal_id str
    The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with storage_account_key and use_managed_identity.
    service_principal_key str
    The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
    storage_account_key str
    The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and use_managed_identity.
    tenant str

    The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.

    NOTE If service_principal_id is used, service_principal_key and tenant are also required.

    url str

    The endpoint for the Azure Data Lake Storage Gen2 service.

    NOTE Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.

    use_managed_identity bool
    Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and storage_account_key.
    additionalProperties Map<String>

    A map of additional properties to associate with the Data Factory Linked Service.

    The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description String
    The description for the Data Factory Linked Service.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service.
    name String
    Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
    parameters Map<String>
    A map of parameters to associate with the Data Factory Linked Service.
    servicePrincipalId String
    The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with storage_account_key and use_managed_identity.
    servicePrincipalKey String
    The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
    storageAccountKey String
    The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and use_managed_identity.
    tenant String

    The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.

    NOTE If service_principal_id is used, service_principal_key and tenant are also required.

    url String

    The endpoint for the Azure Data Lake Storage Gen2 service.

    NOTE Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.

    useManagedIdentity Boolean
    Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with service_principal_id, service_principal_key, tenant and storage_account_key.

    Import

    Data Factory Data Lake Storage Gen2 Linked Services can be imported using the resource id, e.g.

    $ pulumi import azure:datafactory/linkedServiceDataLakeStorageGen2:LinkedServiceDataLakeStorageGen2 example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example

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

    Package Details

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

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure