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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.datafactory.LinkedServiceAzureFileStorage

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Linked Service (connection) between a SFTP Server and Azure Data Factory.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const example = azure.storage.getAccountOutput({
    name: "storageaccountname",
    resourceGroupName: exampleResourceGroup.name,
});
const exampleFactory = new azure.datafactory.Factory("example", {
    name: "example",
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleLinkedServiceAzureFileStorage = new azure.datafactory.LinkedServiceAzureFileStorage("example", {
    name: "example",
    dataFactoryId: exampleFactory.id,
    connectionString: example.apply(example => example.primaryConnectionString),
});
Copy
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example = azure.storage.get_account_output(name="storageaccountname",
    resource_group_name=example_resource_group.name)
example_factory = azure.datafactory.Factory("example",
    name="example",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_azure_file_storage = azure.datafactory.LinkedServiceAzureFileStorage("example",
    name="example",
    data_factory_id=example_factory.id,
    connection_string=example.primary_connection_string)
Copy
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-azure/sdk/v6/go/azure/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		example := storage.LookupAccountOutput(ctx, storage.GetAccountOutputArgs{
			Name:              pulumi.String("storageaccountname"),
			ResourceGroupName: exampleResourceGroup.Name,
		}, nil)
		exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
			Name:              pulumi.String("example"),
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewLinkedServiceAzureFileStorage(ctx, "example", &datafactory.LinkedServiceAzureFileStorageArgs{
			Name:          pulumi.String("example"),
			DataFactoryId: exampleFactory.ID(),
			ConnectionString: pulumi.String(example.ApplyT(func(example storage.GetAccountResult) (*string, error) {
				return &example.PrimaryConnectionString, nil
			}).(pulumi.StringPtrOutput)),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var example = Azure.Storage.GetAccount.Invoke(new()
    {
        Name = "storageaccountname",
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleFactory = new Azure.DataFactory.Factory("example", new()
    {
        Name = "example",
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleLinkedServiceAzureFileStorage = new Azure.DataFactory.LinkedServiceAzureFileStorage("example", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        ConnectionString = example.Apply(getAccountResult => getAccountResult.PrimaryConnectionString),
    });

});
Copy
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.storage.StorageFunctions;
import com.pulumi.azure.storage.inputs.GetAccountArgs;
import com.pulumi.azure.datafactory.Factory;
import com.pulumi.azure.datafactory.FactoryArgs;
import com.pulumi.azure.datafactory.LinkedServiceAzureFileStorage;
import com.pulumi.azure.datafactory.LinkedServiceAzureFileStorageArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        final var example = StorageFunctions.getAccount(GetAccountArgs.builder()
            .name("storageaccountname")
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
            .name("example")
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var exampleLinkedServiceAzureFileStorage = new LinkedServiceAzureFileStorage("exampleLinkedServiceAzureFileStorage", LinkedServiceAzureFileStorageArgs.builder()
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .connectionString(example.applyValue(getAccountResult -> getAccountResult).applyValue(example -> example.applyValue(getAccountResult -> getAccountResult.primaryConnectionString())))
            .build());

    }
}
Copy
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    name: example
    properties:
      name: example-resources
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    name: example
    properties:
      name: example
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleLinkedServiceAzureFileStorage:
    type: azure:datafactory:LinkedServiceAzureFileStorage
    name: example
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      connectionString: ${example.primaryConnectionString}
variables:
  example:
    fn::invoke:
      function: azure:storage:getAccount
      arguments:
        name: storageaccountname
        resourceGroupName: ${exampleResourceGroup.name}
Copy

Create LinkedServiceAzureFileStorage Resource

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

Constructor syntax

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

@overload
def LinkedServiceAzureFileStorage(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  connection_string: Optional[str] = None,
                                  data_factory_id: Optional[str] = None,
                                  host: Optional[str] = None,
                                  annotations: Optional[Sequence[str]] = None,
                                  description: Optional[str] = None,
                                  file_share: Optional[str] = None,
                                  additional_properties: Optional[Mapping[str, str]] = None,
                                  integration_runtime_name: Optional[str] = None,
                                  key_vault_password: Optional[LinkedServiceAzureFileStorageKeyVaultPasswordArgs] = None,
                                  name: Optional[str] = None,
                                  parameters: Optional[Mapping[str, str]] = None,
                                  password: Optional[str] = None,
                                  user_id: Optional[str] = None)
func NewLinkedServiceAzureFileStorage(ctx *Context, name string, args LinkedServiceAzureFileStorageArgs, opts ...ResourceOption) (*LinkedServiceAzureFileStorage, error)
public LinkedServiceAzureFileStorage(string name, LinkedServiceAzureFileStorageArgs args, CustomResourceOptions? opts = null)
public LinkedServiceAzureFileStorage(String name, LinkedServiceAzureFileStorageArgs args)
public LinkedServiceAzureFileStorage(String name, LinkedServiceAzureFileStorageArgs args, CustomResourceOptions options)

type: azure:datafactory:LinkedServiceAzureFileStorage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LinkedServiceAzureFileStorageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LinkedServiceAzureFileStorageArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LinkedServiceAzureFileStorageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LinkedServiceAzureFileStorageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LinkedServiceAzureFileStorageArgs
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 linkedServiceAzureFileStorageResource = new Azure.DataFactory.LinkedServiceAzureFileStorage("linkedServiceAzureFileStorageResource", new()
{
    ConnectionString = "string",
    DataFactoryId = "string",
    Host = "string",
    Annotations = new[]
    {
        "string",
    },
    Description = "string",
    FileShare = "string",
    AdditionalProperties = 
    {
        { "string", "string" },
    },
    IntegrationRuntimeName = "string",
    KeyVaultPassword = new Azure.DataFactory.Inputs.LinkedServiceAzureFileStorageKeyVaultPasswordArgs
    {
        LinkedServiceName = "string",
        SecretName = "string",
    },
    Name = "string",
    Parameters = 
    {
        { "string", "string" },
    },
    Password = "string",
    UserId = "string",
});
Copy
example, err := datafactory.NewLinkedServiceAzureFileStorage(ctx, "linkedServiceAzureFileStorageResource", &datafactory.LinkedServiceAzureFileStorageArgs{
	ConnectionString: pulumi.String("string"),
	DataFactoryId:    pulumi.String("string"),
	Host:             pulumi.String("string"),
	Annotations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	FileShare:   pulumi.String("string"),
	AdditionalProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IntegrationRuntimeName: pulumi.String("string"),
	KeyVaultPassword: &datafactory.LinkedServiceAzureFileStorageKeyVaultPasswordArgs{
		LinkedServiceName: pulumi.String("string"),
		SecretName:        pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Parameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Password: pulumi.String("string"),
	UserId:   pulumi.String("string"),
})
Copy
var linkedServiceAzureFileStorageResource = new LinkedServiceAzureFileStorage("linkedServiceAzureFileStorageResource", LinkedServiceAzureFileStorageArgs.builder()
    .connectionString("string")
    .dataFactoryId("string")
    .host("string")
    .annotations("string")
    .description("string")
    .fileShare("string")
    .additionalProperties(Map.of("string", "string"))
    .integrationRuntimeName("string")
    .keyVaultPassword(LinkedServiceAzureFileStorageKeyVaultPasswordArgs.builder()
        .linkedServiceName("string")
        .secretName("string")
        .build())
    .name("string")
    .parameters(Map.of("string", "string"))
    .password("string")
    .userId("string")
    .build());
Copy
linked_service_azure_file_storage_resource = azure.datafactory.LinkedServiceAzureFileStorage("linkedServiceAzureFileStorageResource",
    connection_string="string",
    data_factory_id="string",
    host="string",
    annotations=["string"],
    description="string",
    file_share="string",
    additional_properties={
        "string": "string",
    },
    integration_runtime_name="string",
    key_vault_password={
        "linked_service_name": "string",
        "secret_name": "string",
    },
    name="string",
    parameters={
        "string": "string",
    },
    password="string",
    user_id="string")
Copy
const linkedServiceAzureFileStorageResource = new azure.datafactory.LinkedServiceAzureFileStorage("linkedServiceAzureFileStorageResource", {
    connectionString: "string",
    dataFactoryId: "string",
    host: "string",
    annotations: ["string"],
    description: "string",
    fileShare: "string",
    additionalProperties: {
        string: "string",
    },
    integrationRuntimeName: "string",
    keyVaultPassword: {
        linkedServiceName: "string",
        secretName: "string",
    },
    name: "string",
    parameters: {
        string: "string",
    },
    password: "string",
    userId: "string",
});
Copy
type: azure:datafactory:LinkedServiceAzureFileStorage
properties:
    additionalProperties:
        string: string
    annotations:
        - string
    connectionString: string
    dataFactoryId: string
    description: string
    fileShare: string
    host: string
    integrationRuntimeName: string
    keyVaultPassword:
        linkedServiceName: string
        secretName: string
    name: string
    parameters:
        string: string
    password: string
    userId: string
Copy

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

ConnectionString This property is required. string
The connection string.
DataFactoryId
This property is required.
Changes to this property will trigger replacement.
string
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
AdditionalProperties Dictionary<string, string>

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

The following supported arguments are specific to Azure File Storage 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.
FileShare string
The name of the file share.
Host string
The Host name of the server.
IntegrationRuntimeName string
The integration runtime reference to associate with the Data Factory Linked Service.
KeyVaultPassword LinkedServiceAzureFileStorageKeyVaultPassword
A key_vault_password block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
Name Changes to this property will trigger replacement. 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.
Password string
The password to log in the server.
UserId string
The user ID to log in the server.
ConnectionString This property is required. string
The connection string.
DataFactoryId
This property is required.
Changes to this property will trigger replacement.
string
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
AdditionalProperties map[string]string

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

The following supported arguments are specific to Azure File Storage 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.
FileShare string
The name of the file share.
Host string
The Host name of the server.
IntegrationRuntimeName string
The integration runtime reference to associate with the Data Factory Linked Service.
KeyVaultPassword LinkedServiceAzureFileStorageKeyVaultPasswordArgs
A key_vault_password block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
Name Changes to this property will trigger replacement. 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.
Password string
The password to log in the server.
UserId string
The user ID to log in the server.
connectionString This property is required. String
The connection string.
dataFactoryId
This property is required.
Changes to this property will trigger replacement.
String
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
additionalProperties Map<String,String>

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

The following supported arguments are specific to Azure File Storage 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.
fileShare String
The name of the file share.
host String
The Host name of the server.
integrationRuntimeName String
The integration runtime reference to associate with the Data Factory Linked Service.
keyVaultPassword LinkedServiceAzureFileStorageKeyVaultPassword
A key_vault_password block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
name Changes to this property will trigger replacement. 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.
password String
The password to log in the server.
userId String
The user ID to log in the server.
connectionString This property is required. string
The connection string.
dataFactoryId
This property is required.
Changes to this property will trigger replacement.
string
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
additionalProperties {[key: string]: string}

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

The following supported arguments are specific to Azure File Storage 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.
fileShare string
The name of the file share.
host string
The Host name of the server.
integrationRuntimeName string
The integration runtime reference to associate with the Data Factory Linked Service.
keyVaultPassword LinkedServiceAzureFileStorageKeyVaultPassword
A key_vault_password block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
name Changes to this property will trigger replacement. 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.
password string
The password to log in the server.
userId string
The user ID to log in the server.
connection_string This property is required. str
The connection string.
data_factory_id
This property is required.
Changes to this property will trigger replacement.
str
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
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 Azure File Storage 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.
file_share str
The name of the file share.
host str
The Host name of the server.
integration_runtime_name str
The integration runtime reference to associate with the Data Factory Linked Service.
key_vault_password LinkedServiceAzureFileStorageKeyVaultPasswordArgs
A key_vault_password block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
name Changes to this property will trigger replacement. 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.
password str
The password to log in the server.
user_id str
The user ID to log in the server.
connectionString This property is required. String
The connection string.
dataFactoryId
This property is required.
Changes to this property will trigger replacement.
String
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
additionalProperties Map<String>

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

The following supported arguments are specific to Azure File Storage 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.
fileShare String
The name of the file share.
host String
The Host name of the server.
integrationRuntimeName String
The integration runtime reference to associate with the Data Factory Linked Service.
keyVaultPassword Property Map
A key_vault_password block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
name Changes to this property will trigger replacement. 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.
password String
The password to log in the server.
userId String
The user ID to log in the server.

Outputs

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

Get an existing LinkedServiceAzureFileStorage 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?: LinkedServiceAzureFileStorageState, opts?: CustomResourceOptions): LinkedServiceAzureFileStorage
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_properties: Optional[Mapping[str, str]] = None,
        annotations: Optional[Sequence[str]] = None,
        connection_string: Optional[str] = None,
        data_factory_id: Optional[str] = None,
        description: Optional[str] = None,
        file_share: Optional[str] = None,
        host: Optional[str] = None,
        integration_runtime_name: Optional[str] = None,
        key_vault_password: Optional[LinkedServiceAzureFileStorageKeyVaultPasswordArgs] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        password: Optional[str] = None,
        user_id: Optional[str] = None) -> LinkedServiceAzureFileStorage
func GetLinkedServiceAzureFileStorage(ctx *Context, name string, id IDInput, state *LinkedServiceAzureFileStorageState, opts ...ResourceOption) (*LinkedServiceAzureFileStorage, error)
public static LinkedServiceAzureFileStorage Get(string name, Input<string> id, LinkedServiceAzureFileStorageState? state, CustomResourceOptions? opts = null)
public static LinkedServiceAzureFileStorage get(String name, Output<String> id, LinkedServiceAzureFileStorageState state, CustomResourceOptions options)
resources:  _:    type: azure:datafactory:LinkedServiceAzureFileStorage    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Azure File Storage Linked Service:

Annotations List<string>
List of tags that can be used for describing the Data Factory Linked Service.
ConnectionString string
The connection string.
DataFactoryId Changes to this property will trigger replacement. 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.
FileShare string
The name of the file share.
Host string
The Host name of the server.
IntegrationRuntimeName string
The integration runtime reference to associate with the Data Factory Linked Service.
KeyVaultPassword LinkedServiceAzureFileStorageKeyVaultPassword
A key_vault_password block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
Name Changes to this property will trigger replacement. 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.
Password string
The password to log in the server.
UserId string
The user ID to log in the server.
AdditionalProperties map[string]string

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

The following supported arguments are specific to Azure File Storage Linked Service:

Annotations []string
List of tags that can be used for describing the Data Factory Linked Service.
ConnectionString string
The connection string.
DataFactoryId Changes to this property will trigger replacement. 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.
FileShare string
The name of the file share.
Host string
The Host name of the server.
IntegrationRuntimeName string
The integration runtime reference to associate with the Data Factory Linked Service.
KeyVaultPassword LinkedServiceAzureFileStorageKeyVaultPasswordArgs
A key_vault_password block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
Name Changes to this property will trigger replacement. 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.
Password string
The password to log in the server.
UserId string
The user ID to log in the server.
additionalProperties Map<String,String>

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

The following supported arguments are specific to Azure File Storage Linked Service:

annotations List<String>
List of tags that can be used for describing the Data Factory Linked Service.
connectionString String
The connection string.
dataFactoryId Changes to this property will trigger replacement. 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.
fileShare String
The name of the file share.
host String
The Host name of the server.
integrationRuntimeName String
The integration runtime reference to associate with the Data Factory Linked Service.
keyVaultPassword LinkedServiceAzureFileStorageKeyVaultPassword
A key_vault_password block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
name Changes to this property will trigger replacement. 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.
password String
The password to log in the server.
userId String
The user ID to log in the server.
additionalProperties {[key: string]: string}

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

The following supported arguments are specific to Azure File Storage Linked Service:

annotations string[]
List of tags that can be used for describing the Data Factory Linked Service.
connectionString string
The connection string.
dataFactoryId Changes to this property will trigger replacement. 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.
fileShare string
The name of the file share.
host string
The Host name of the server.
integrationRuntimeName string
The integration runtime reference to associate with the Data Factory Linked Service.
keyVaultPassword LinkedServiceAzureFileStorageKeyVaultPassword
A key_vault_password block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
name Changes to this property will trigger replacement. 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.
password string
The password to log in the server.
userId string
The user ID to log in the server.
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 Azure File Storage Linked Service:

annotations Sequence[str]
List of tags that can be used for describing the Data Factory Linked Service.
connection_string str
The connection string.
data_factory_id Changes to this property will trigger replacement. 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.
file_share str
The name of the file share.
host str
The Host name of the server.
integration_runtime_name str
The integration runtime reference to associate with the Data Factory Linked Service.
key_vault_password LinkedServiceAzureFileStorageKeyVaultPasswordArgs
A key_vault_password block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
name Changes to this property will trigger replacement. 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.
password str
The password to log in the server.
user_id str
The user ID to log in the server.
additionalProperties Map<String>

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

The following supported arguments are specific to Azure File Storage Linked Service:

annotations List<String>
List of tags that can be used for describing the Data Factory Linked Service.
connectionString String
The connection string.
dataFactoryId Changes to this property will trigger replacement. 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.
fileShare String
The name of the file share.
host String
The Host name of the server.
integrationRuntimeName String
The integration runtime reference to associate with the Data Factory Linked Service.
keyVaultPassword Property Map
A key_vault_password block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
name Changes to this property will trigger replacement. 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.
password String
The password to log in the server.
userId String
The user ID to log in the server.

Supporting Types

LinkedServiceAzureFileStorageKeyVaultPassword
, LinkedServiceAzureFileStorageKeyVaultPasswordArgs

LinkedServiceName This property is required. string
Specifies the name of an existing Key Vault Data Factory Linked Service.
SecretName This property is required. string
Specifies the secret name in Azure Key Vault that stores Azure File Storage password.
LinkedServiceName This property is required. string
Specifies the name of an existing Key Vault Data Factory Linked Service.
SecretName This property is required. string
Specifies the secret name in Azure Key Vault that stores Azure File Storage password.
linkedServiceName This property is required. String
Specifies the name of an existing Key Vault Data Factory Linked Service.
secretName This property is required. String
Specifies the secret name in Azure Key Vault that stores Azure File Storage password.
linkedServiceName This property is required. string
Specifies the name of an existing Key Vault Data Factory Linked Service.
secretName This property is required. string
Specifies the secret name in Azure Key Vault that stores Azure File Storage password.
linked_service_name This property is required. str
Specifies the name of an existing Key Vault Data Factory Linked Service.
secret_name This property is required. str
Specifies the secret name in Azure Key Vault that stores Azure File Storage password.
linkedServiceName This property is required. String
Specifies the name of an existing Key Vault Data Factory Linked Service.
secretName This property is required. String
Specifies the secret name in Azure Key Vault that stores Azure File Storage password.

Import

Data Factory Linked Service’s can be imported using the resource id, e.g.

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

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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure