pulumi-azure-kotlin/com.pulumi.azure.datafactory.kotlin/LinkedServiceSftpArgs

LinkedServiceSftpArgs

data class LinkedServiceSftpArgs(val additionalProperties: Output<Map<String, String>>? = null, val annotations: Output<List<String>>? = null, val authenticationType: Output<String>? = null, val dataFactoryId: Output<String>? = null, val description: Output<String>? = null, val host: Output<String>? = null, val hostKeyFingerprint: Output<String>? = null, val integrationRuntimeName: Output<String>? = null, val name: Output<String>? = null, val parameters: Output<Map<String, String>>? = null, val password: Output<String>? = null, val port: Output<Int>? = null, val skipHostKeyValidation: Output<Boolean>? = null, val username: Output<String>? = null) : ConvertibleToJava<LinkedServiceSftpArgs>

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

Example Usage

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());
        var exampleLinkedServiceSftp = new LinkedServiceSftp("exampleLinkedServiceSftp", LinkedServiceSftpArgs.builder()
            .dataFactoryId(exampleFactory.id())
            .authenticationType("Basic")
            .host("http://www.bing.com")
            .port(22)
            .username("foo")
            .password("bar")
            .build());
    }
}

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

Constructors

LinkedServiceSftpArgs

fun LinkedServiceSftpArgs(additionalProperties: Output<Map<String, String>>? = null, annotations: Output<List<String>>? = null, authenticationType: Output<String>? = null, dataFactoryId: Output<String>? = null, description: Output<String>? = null, host: Output<String>? = null, hostKeyFingerprint: Output<String>? = null, integrationRuntimeName: Output<String>? = null, name: Output<String>? = null, parameters: Output<Map<String, String>>? = null, password: Output<String>? = null, port: Output<Int>? = null, skipHostKeyValidation: Output<Boolean>? = null, username: Output<String>? = null)

Functions

toJava

open override fun toJava(): LinkedServiceSftpArgs

Properties

additionalProperties

val additionalProperties: Output<Map<String, String>>? = null

A map of additional properties to associate with the Data Factory Linked Service. The following supported arguments are specific to SFTP Linked Service:

annotations

val annotations: Output<List<String>>? = null

List of tags that can be used for describing the Data Factory Linked Service.

authenticationType

val authenticationType: Output<String>? = null

The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.

dataFactoryId

val dataFactoryId: Output<String>? = null

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

description

val description: Output<String>? = null

The description for the Data Factory Linked Service.

host

val host: Output<String>? = null

The SFTP server hostname.

hostKeyFingerprint

val hostKeyFingerprint: Output<String>? = null

The host key fingerprint of the SFTP server.

integrationRuntimeName

val integrationRuntimeName: Output<String>? = null

The integration runtime reference to associate with the Data Factory Linked Service.

name

val name: Output<String>? = null

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

val parameters: Output<Map<String, String>>? = null

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

password

val password: Output<String>? = null

Password to logon to the SFTP Server for Basic Authentication.

port

val port: Output<Int>? = null

The TCP port number that the SFTP server uses to listen for client connection. Default value is 22.

skipHostKeyValidation

val skipHostKeyValidation: Output<Boolean>? = null

Whether to validate host key fingerprint while connecting. If set to false, host_key_fingerprint must also be set.

username

val username: Output<String>? = null

The username used to log on to the SFTP server.