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

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

azure.datafactory.LinkedServiceSftp

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 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 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 exampleLinkedServiceSftp = new azure.datafactory.LinkedServiceSftp("example", {
    name: "example",
    dataFactoryId: exampleFactory.id,
    authenticationType: "Basic",
    host: "http://www.bing.com",
    port: 22,
    username: "foo",
    password: "bar",
});

    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)
example_linked_service_sftp = azure.datafactory.LinkedServiceSftp("example",
    name="example",
    data_factory_id=example_factory.id,
    authentication_type="Basic",
    host="http://www.bing.com",
    port=22,
    username="foo",
    password="bar")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := 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
		}
		_, err = datafactory.NewLinkedServiceSftp(ctx, "example", &datafactory.LinkedServiceSftpArgs{
			Name:               pulumi.String("example"),
			DataFactoryId:      exampleFactory.ID(),
			AuthenticationType: pulumi.String("Basic"),
			Host:               pulumi.String("http://www.bing.com"),
			Port:               pulumi.Int(22),
			Username:           pulumi.String("foo"),
			Password:           pulumi.String("bar"),
		})
		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 exampleLinkedServiceSftp = new Azure.DataFactory.LinkedServiceSftp("example", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        AuthenticationType = "Basic",
        Host = "http://www.bing.com",
        Port = 22,
        Username = "foo",
        Password = "bar",
    });

});

    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.datafactory.LinkedServiceSftp;
import com.pulumi.azure.datafactory.LinkedServiceSftpArgs;
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());

        var exampleLinkedServiceSftp = new LinkedServiceSftp("exampleLinkedServiceSftp", LinkedServiceSftpArgs.builder()
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .authenticationType("Basic")
            .host("http://www.bing.com")
            .port(22)
            .username("foo")
            .password("bar")
            .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}
  exampleLinkedServiceSftp:
    type: azure:datafactory:LinkedServiceSftp
    name: example
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      authenticationType: Basic
      host: http://www.bing.com
      port: 22
      username: foo
      password: bar

    Create LinkedServiceSftp Resource

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

    Constructor syntax

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

@overload
def LinkedServiceSftp(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      password: Optional[str] = None,
                      username: Optional[str] = None,
                      authentication_type: Optional[str] = None,
                      data_factory_id: Optional[str] = None,
                      port: Optional[int] = None,
                      host: Optional[str] = None,
                      host_key_fingerprint: Optional[str] = None,
                      integration_runtime_name: Optional[str] = None,
                      name: Optional[str] = None,
                      parameters: Optional[Mapping[str, str]] = None,
                      additional_properties: Optional[Mapping[str, str]] = None,
                      description: Optional[str] = None,
                      skip_host_key_validation: Optional[bool] = None,
                      annotations: Optional[Sequence[str]] = None)
    func NewLinkedServiceSftp(ctx *Context, name string, args LinkedServiceSftpArgs, opts ...ResourceOption) (*LinkedServiceSftp, error)
    public LinkedServiceSftp(string name, LinkedServiceSftpArgs args, CustomResourceOptions? opts = null)
    public LinkedServiceSftp(String name, LinkedServiceSftpArgs args)
public LinkedServiceSftp(String name, LinkedServiceSftpArgs args, CustomResourceOptions options)

    type: azure:datafactory:LinkedServiceSftp
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 LinkedServiceSftpArgs
    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 LinkedServiceSftpArgs
    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 LinkedServiceSftpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkedServiceSftpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LinkedServiceSftpArgs
    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 linkedServiceSftpResource = new Azure.DataFactory.LinkedServiceSftp("linkedServiceSftpResource", new()
{
    Password = "string",
    Username = "string",
    AuthenticationType = "string",
    DataFactoryId = "string",
    Port = 0,
    Host = "string",
    HostKeyFingerprint = "string",
    IntegrationRuntimeName = "string",
    Name = "string",
    Parameters = 
    {
        { "string", "string" },
    },
    AdditionalProperties = 
    {
        { "string", "string" },
    },
    Description = "string",
    SkipHostKeyValidation = false,
    Annotations = new[]
    {
        "string",
    },
});

    example, err := datafactory.NewLinkedServiceSftp(ctx, "linkedServiceSftpResource", &datafactory.LinkedServiceSftpArgs{
	Password:               pulumi.String("string"),
	Username:               pulumi.String("string"),
	AuthenticationType:     pulumi.String("string"),
	DataFactoryId:          pulumi.String("string"),
	Port:                   pulumi.Int(0),
	Host:                   pulumi.String("string"),
	HostKeyFingerprint:     pulumi.String("string"),
	IntegrationRuntimeName: pulumi.String("string"),
	Name:                   pulumi.String("string"),
	Parameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AdditionalProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description:           pulumi.String("string"),
	SkipHostKeyValidation: pulumi.Bool(false),
	Annotations: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var linkedServiceSftpResource = new LinkedServiceSftp("linkedServiceSftpResource", LinkedServiceSftpArgs.builder()
    .password("string")
    .username("string")
    .authenticationType("string")
    .dataFactoryId("string")
    .port(0)
    .host("string")
    .hostKeyFingerprint("string")
    .integrationRuntimeName("string")
    .name("string")
    .parameters(Map.of("string", "string"))
    .additionalProperties(Map.of("string", "string"))
    .description("string")
    .skipHostKeyValidation(false)
    .annotations("string")
    .build());

    linked_service_sftp_resource = azure.datafactory.LinkedServiceSftp("linkedServiceSftpResource",
    password="string",
    username="string",
    authentication_type="string",
    data_factory_id="string",
    port=0,
    host="string",
    host_key_fingerprint="string",
    integration_runtime_name="string",
    name="string",
    parameters={
        "string": "string",
    },
    additional_properties={
        "string": "string",
    },
    description="string",
    skip_host_key_validation=False,
    annotations=["string"])

    const linkedServiceSftpResource = new azure.datafactory.LinkedServiceSftp("linkedServiceSftpResource", {
    password: "string",
    username: "string",
    authenticationType: "string",
    dataFactoryId: "string",
    port: 0,
    host: "string",
    hostKeyFingerprint: "string",
    integrationRuntimeName: "string",
    name: "string",
    parameters: {
        string: "string",
    },
    additionalProperties: {
        string: "string",
    },
    description: "string",
    skipHostKeyValidation: false,
    annotations: ["string"],
});

    type: azure:datafactory:LinkedServiceSftp
properties:
    additionalProperties:
        string: string
    annotations:
        - string
    authenticationType: string
    dataFactoryId: string
    description: string
    host: string
    hostKeyFingerprint: string
    integrationRuntimeName: string
    name: string
    parameters:
        string: string
    password: string
    port: 0
    skipHostKeyValidation: false
    username: string

    LinkedServiceSftp Resource Properties

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

    Inputs

    The LinkedServiceSftp resource accepts the following input properties:

    AuthenticationType string
    The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Host string
    The SFTP server hostname.
    Password string
    Password to logon to the SFTP Server for Basic Authentication.
    Port int
    The TCP port number that the SFTP server uses to listen for client connection. Default value is 22.
    Username string
    The username used to log on to the SFTP server.
    AdditionalProperties Dictionary<string, string>

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

    The following supported arguments are specific to SFTP 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.
    HostKeyFingerprint string
    The host key fingerprint of the SFTP server.
    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.
    SkipHostKeyValidation bool
    Whether to validate host key fingerprint while connecting. If set to false, host_key_fingerprint must also be set.
    AuthenticationType string
    The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Host string
    The SFTP server hostname.
    Password string
    Password to logon to the SFTP Server for Basic Authentication.
    Port int
    The TCP port number that the SFTP server uses to listen for client connection. Default value is 22.
    Username string
    The username used to log on to the SFTP 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 SFTP 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.
    HostKeyFingerprint string
    The host key fingerprint of the SFTP server.
    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.
    SkipHostKeyValidation bool
    Whether to validate host key fingerprint while connecting. If set to false, host_key_fingerprint must also be set.
    authenticationType String
    The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    host String
    The SFTP server hostname.
    password String
    Password to logon to the SFTP Server for Basic Authentication.
    port Integer
    The TCP port number that the SFTP server uses to listen for client connection. Default value is 22.
    username String
    The username used to log on to the SFTP 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 SFTP 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.
    hostKeyFingerprint String
    The host key fingerprint of the SFTP server.
    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.
    skipHostKeyValidation Boolean
    Whether to validate host key fingerprint while connecting. If set to false, host_key_fingerprint must also be set.
    authenticationType string
    The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    host string
    The SFTP server hostname.
    password string
    Password to logon to the SFTP Server for Basic Authentication.
    port number
    The TCP port number that the SFTP server uses to listen for client connection. Default value is 22.
    username string
    The username used to log on to the SFTP 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 SFTP 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.
    hostKeyFingerprint string
    The host key fingerprint of the SFTP server.
    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.
    skipHostKeyValidation boolean
    Whether to validate host key fingerprint while connecting. If set to false, host_key_fingerprint must also be set.
    authentication_type str
    The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    host str
    The SFTP server hostname.
    password str
    Password to logon to the SFTP Server for Basic Authentication.
    port int
    The TCP port number that the SFTP server uses to listen for client connection. Default value is 22.
    username str
    The username used to log on to the SFTP 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 SFTP 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.
    host_key_fingerprint str
    The host key fingerprint of the SFTP server.
    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.
    skip_host_key_validation bool
    Whether to validate host key fingerprint while connecting. If set to false, host_key_fingerprint must also be set.
    authenticationType String
    The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    host String
    The SFTP server hostname.
    password String
    Password to logon to the SFTP Server for Basic Authentication.
    port Number
    The TCP port number that the SFTP server uses to listen for client connection. Default value is 22.
    username String
    The username used to log on to the SFTP server.
    additionalProperties Map<String>

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

    The following supported arguments are specific to SFTP 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.
    hostKeyFingerprint String
    The host key fingerprint of the SFTP server.
    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.
    skipHostKeyValidation Boolean
    Whether to validate host key fingerprint while connecting. If set to false, host_key_fingerprint must also be set.

    Outputs

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

    Get an existing LinkedServiceSftp 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?: LinkedServiceSftpState, opts?: CustomResourceOptions): LinkedServiceSftp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_properties: Optional[Mapping[str, str]] = None,
        annotations: Optional[Sequence[str]] = None,
        authentication_type: Optional[str] = None,
        data_factory_id: Optional[str] = None,
        description: Optional[str] = None,
        host: Optional[str] = None,
        host_key_fingerprint: Optional[str] = None,
        integration_runtime_name: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        password: Optional[str] = None,
        port: Optional[int] = None,
        skip_host_key_validation: Optional[bool] = None,
        username: Optional[str] = None) -> LinkedServiceSftp
    func GetLinkedServiceSftp(ctx *Context, name string, id IDInput, state *LinkedServiceSftpState, opts ...ResourceOption) (*LinkedServiceSftp, error)
    public static LinkedServiceSftp Get(string name, Input<string> id, LinkedServiceSftpState? state, CustomResourceOptions? opts = null)
    public static LinkedServiceSftp get(String name, Output<String> id, LinkedServiceSftpState 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 SFTP Linked Service:

    Annotations List<string>
    List of tags that can be used for describing the Data Factory Linked Service.
    AuthenticationType string
    The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.
    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.
    Host string
    The SFTP server hostname.
    HostKeyFingerprint string
    The host key fingerprint of the SFTP server.
    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.
    Password string
    Password to logon to the SFTP Server for Basic Authentication.
    Port int
    The TCP port number that the SFTP server uses to listen for client connection. Default value is 22.
    SkipHostKeyValidation bool
    Whether to validate host key fingerprint while connecting. If set to false, host_key_fingerprint must also be set.
    Username string
    The username used to log on to the SFTP 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 SFTP Linked Service:

    Annotations []string
    List of tags that can be used for describing the Data Factory Linked Service.
    AuthenticationType string
    The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.
    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.
    Host string
    The SFTP server hostname.
    HostKeyFingerprint string
    The host key fingerprint of the SFTP server.
    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.
    Password string
    Password to logon to the SFTP Server for Basic Authentication.
    Port int
    The TCP port number that the SFTP server uses to listen for client connection. Default value is 22.
    SkipHostKeyValidation bool
    Whether to validate host key fingerprint while connecting. If set to false, host_key_fingerprint must also be set.
    Username string
    The username used to log on to the SFTP 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 SFTP Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    authenticationType String
    The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.
    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.
    host String
    The SFTP server hostname.
    hostKeyFingerprint String
    The host key fingerprint of the SFTP server.
    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.
    password String
    Password to logon to the SFTP Server for Basic Authentication.
    port Integer
    The TCP port number that the SFTP server uses to listen for client connection. Default value is 22.
    skipHostKeyValidation Boolean
    Whether to validate host key fingerprint while connecting. If set to false, host_key_fingerprint must also be set.
    username String
    The username used to log on to the SFTP 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 SFTP Linked Service:

    annotations string[]
    List of tags that can be used for describing the Data Factory Linked Service.
    authenticationType string
    The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.
    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.
    host string
    The SFTP server hostname.
    hostKeyFingerprint string
    The host key fingerprint of the SFTP server.
    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.
    password string
    Password to logon to the SFTP Server for Basic Authentication.
    port number
    The TCP port number that the SFTP server uses to listen for client connection. Default value is 22.
    skipHostKeyValidation boolean
    Whether to validate host key fingerprint while connecting. If set to false, host_key_fingerprint must also be set.
    username string
    The username used to log on to the SFTP 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 SFTP Linked Service:

    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Linked Service.
    authentication_type str
    The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.
    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.
    host str
    The SFTP server hostname.
    host_key_fingerprint str
    The host key fingerprint of the SFTP server.
    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.
    password str
    Password to logon to the SFTP Server for Basic Authentication.
    port int
    The TCP port number that the SFTP server uses to listen for client connection. Default value is 22.
    skip_host_key_validation bool
    Whether to validate host key fingerprint while connecting. If set to false, host_key_fingerprint must also be set.
    username str
    The username used to log on to the SFTP server.
    additionalProperties Map<String>

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

    The following supported arguments are specific to SFTP Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    authenticationType String
    The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.
    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.
    host String
    The SFTP server hostname.
    hostKeyFingerprint String
    The host key fingerprint of the SFTP server.
    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.
    password String
    Password to logon to the SFTP Server for Basic Authentication.
    port Number
    The TCP port number that the SFTP server uses to listen for client connection. Default value is 22.
    skipHostKeyValidation Boolean
    Whether to validate host key fingerprint while connecting. If set to false, host_key_fingerprint must also be set.
    username String
    The username used to log on to the SFTP server.

    Import

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

    $ pulumi import azure:datafactory/linkedServiceSftp:LinkedServiceSftp 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 Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure