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 keyVaultPasswords: Output<List<LinkedServiceSftpKeyVaultPasswordArgs>>? = null, val keyVaultPrivateKeyContentBase64: Output<LinkedServiceSftpKeyVaultPrivateKeyContentBase64Args>? = null, val keyVaultPrivateKeyPassphrase: Output<LinkedServiceSftpKeyVaultPrivateKeyPassphraseArgs>? = null, val name: Output<String>? = null, val parameters: Output<Map<String, String>>? = null, val password: Output<String>? = null, val port: Output<Int>? = null, val privateKeyContentBase64: Output<String>? = null, val privateKeyPassphrase: Output<String>? = null, val privateKeyPath: Output<String>? = 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

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

Constructors

Link copied to clipboard
constructor(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, keyVaultPasswords: Output<List<LinkedServiceSftpKeyVaultPasswordArgs>>? = null, keyVaultPrivateKeyContentBase64: Output<LinkedServiceSftpKeyVaultPrivateKeyContentBase64Args>? = null, keyVaultPrivateKeyPassphrase: Output<LinkedServiceSftpKeyVaultPrivateKeyPassphraseArgs>? = null, name: Output<String>? = null, parameters: Output<Map<String, String>>? = null, password: Output<String>? = null, port: Output<Int>? = null, privateKeyContentBase64: Output<String>? = null, privateKeyPassphrase: Output<String>? = null, privateKeyPath: Output<String>? = null, skipHostKeyValidation: Output<Boolean>? = null, username: Output<String>? = null)

Properties

Link copied to clipboard
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:

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

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

Link copied to clipboard
val authenticationType: Output<String>? = null

The type of authentication used to connect to the SFTP server. Valid options are MultiFactor, Basic and SshPublicKey.

Link copied to clipboard
val dataFactoryId: Output<String>? = null

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>? = null

The description for the Data Factory Linked Service.

Link copied to clipboard
val host: Output<String>? = null

The SFTP server hostname.

Link copied to clipboard
val hostKeyFingerprint: Output<String>? = null

The host key fingerprint of the SFTP server.

Link copied to clipboard
val integrationRuntimeName: Output<String>? = null

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

Link copied to clipboard

A key_vault_password block as defined below.

Link copied to clipboard

A key_vault_private_key_content_base64 block as defined below.

Link copied to clipboard

A key_vault_private_key_passphrase block as defined below.

Link copied to clipboard
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.

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

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

Link copied to clipboard
val password: Output<String>? = null

Password to log on to the SFTP Server for Basic Authentication.

Link copied to clipboard
val port: Output<Int>? = null

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

Link copied to clipboard
val privateKeyContentBase64: Output<String>? = null

The Base64 encoded private key content in OpenSSH format used to log on to the SFTP server.

Link copied to clipboard
val privateKeyPassphrase: Output<String>? = null

The passphrase for the private key if the key is encrypted.

Link copied to clipboard
val privateKeyPath: Output<String>? = null

The absolute path to the private key file that the self-hosted integration runtime can access.

Link copied to clipboard
val skipHostKeyValidation: Output<Boolean>? = null

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

Link copied to clipboard
val username: Output<String>? = null

The username used to log on to the SFTP server.

Functions

Link copied to clipboard
open override fun toJava(): LinkedServiceSftpArgs