LinkedServiceSftp

class LinkedServiceSftp : KotlinCustomResource

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")
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 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
}
_, 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
})
}
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

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

Properties

Link copied to clipboard

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

Link copied to clipboard
val annotations: Output<List<String>>?

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

Link copied to clipboard

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

Link copied to clipboard
val dataFactoryId: Output<String>

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

Link copied to clipboard
val description: Output<String>?

The description for the Data Factory Linked Service.

Link copied to clipboard
val host: Output<String>

The SFTP server hostname.

Link copied to clipboard

The host key fingerprint of the SFTP server.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

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

Link copied to clipboard
val name: Output<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.

Link copied to clipboard
val parameters: Output<Map<String, String>>?

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

Link copied to clipboard
val password: Output<String>

Password to logon to the SFTP Server for Basic Authentication.

Link copied to clipboard
val port: Output<Int>

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

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val username: Output<String>

The username used to log on to the SFTP server.