import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages a Linked Service (connection) between a SFTP Server and Azure Data Factory. * * ## Example Usage * * ```typescript * 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 * * Data Factory Linked Service's can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:datafactory/linkedServiceSftp:LinkedServiceSftp example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example * ``` */ export declare class LinkedServiceSftp extends pulumi.CustomResource { /** * Get an existing LinkedServiceSftp resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: LinkedServiceSftpState, opts?: pulumi.CustomResourceOptions): LinkedServiceSftp; /** * Returns true if the given object is an instance of LinkedServiceSftp. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is LinkedServiceSftp; /** * A map of additional properties to associate with the Data Factory Linked Service. * * The following supported arguments are specific to SFTP Linked Service: */ readonly additionalProperties: pulumi.Output<{ [key: string]: string; } | undefined>; /** * List of tags that can be used for describing the Data Factory Linked Service. */ readonly annotations: pulumi.Output; /** * The type of authentication used to connect to the SFTP server. Valid options are `MultiFactor`, `Basic` and `SshPublicKey`. */ readonly authenticationType: pulumi.Output; /** * The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource. */ readonly dataFactoryId: pulumi.Output; /** * The description for the Data Factory Linked Service. */ readonly description: pulumi.Output; /** * The SFTP server hostname. */ readonly host: pulumi.Output; /** * The host key fingerprint of the SFTP server. */ readonly hostKeyFingerprint: pulumi.Output; /** * The name of the integration runtime to associate with the Data Factory Linked Service. */ readonly integrationRuntimeName: pulumi.Output; /** * A `keyVaultPassword` block as defined below. * * > **Note:** Either `password` or `keyVaultPassword` is required when `authenticationType` is set to `Basic`. */ readonly keyVaultPasswords: pulumi.Output; /** * A `keyVaultPrivateKeyContentBase64` block as defined below. */ readonly keyVaultPrivateKeyContentBase64: pulumi.Output; /** * A `keyVaultPrivateKeyPassphrase` block as defined below. * * > **Note:** One of `privateKeyContentBase64` or `privateKeyPath` (or their Key Vault equivalent) is required when `authenticationType` is set to `SshPublicKey`. */ readonly keyVaultPrivateKeyPassphrase: pulumi.Output; /** * 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](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions. */ readonly name: pulumi.Output; /** * A map of parameters to associate with the Data Factory Linked Service. */ readonly parameters: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Password to log on to the SFTP Server for Basic Authentication. */ readonly password: pulumi.Output; /** * The TCP port number that the SFTP server uses to listen for client connection. Default value is 22. */ readonly port: pulumi.Output; /** * The Base64 encoded private key content in OpenSSH format used to log on to the SFTP server. */ readonly privateKeyContentBase64: pulumi.Output; /** * The passphrase for the private key if the key is encrypted. */ readonly privateKeyPassphrase: pulumi.Output; /** * The absolute path to the private key file that the self-hosted integration runtime can access. * * > **Note:** `privateKeyPath` only applies when using a self-hosted integration runtime (instead of the default Azure provided runtime), as indicated by supplying a value for `integrationRuntimeName`. */ readonly privateKeyPath: pulumi.Output; /** * Whether to validate host key fingerprint while connecting. If set to `false`, `hostKeyFingerprint` must also be set. */ readonly skipHostKeyValidation: pulumi.Output; /** * The username used to log on to the SFTP server. */ readonly username: pulumi.Output; /** * Create a LinkedServiceSftp resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: LinkedServiceSftpArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering LinkedServiceSftp resources. */ export interface LinkedServiceSftpState { /** * A map of additional properties to associate with the Data Factory Linked Service. * * The following supported arguments are specific to SFTP Linked Service: */ additionalProperties?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * List of tags that can be used for describing the Data Factory Linked Service. */ annotations?: pulumi.Input[]>; /** * The type of authentication used to connect to the SFTP server. Valid options are `MultiFactor`, `Basic` and `SshPublicKey`. */ authenticationType?: pulumi.Input; /** * The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource. */ dataFactoryId?: pulumi.Input; /** * The description for the Data Factory Linked Service. */ description?: pulumi.Input; /** * The SFTP server hostname. */ host?: pulumi.Input; /** * The host key fingerprint of the SFTP server. */ hostKeyFingerprint?: pulumi.Input; /** * The name of the integration runtime to associate with the Data Factory Linked Service. */ integrationRuntimeName?: pulumi.Input; /** * A `keyVaultPassword` block as defined below. * * > **Note:** Either `password` or `keyVaultPassword` is required when `authenticationType` is set to `Basic`. */ keyVaultPasswords?: pulumi.Input[]>; /** * A `keyVaultPrivateKeyContentBase64` block as defined below. */ keyVaultPrivateKeyContentBase64?: pulumi.Input; /** * A `keyVaultPrivateKeyPassphrase` block as defined below. * * > **Note:** One of `privateKeyContentBase64` or `privateKeyPath` (or their Key Vault equivalent) is required when `authenticationType` is set to `SshPublicKey`. */ keyVaultPrivateKeyPassphrase?: pulumi.Input; /** * 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](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions. */ name?: pulumi.Input; /** * A map of parameters to associate with the Data Factory Linked Service. */ parameters?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Password to log on to the SFTP Server for Basic Authentication. */ password?: pulumi.Input; /** * The TCP port number that the SFTP server uses to listen for client connection. Default value is 22. */ port?: pulumi.Input; /** * The Base64 encoded private key content in OpenSSH format used to log on to the SFTP server. */ privateKeyContentBase64?: pulumi.Input; /** * The passphrase for the private key if the key is encrypted. */ privateKeyPassphrase?: pulumi.Input; /** * The absolute path to the private key file that the self-hosted integration runtime can access. * * > **Note:** `privateKeyPath` only applies when using a self-hosted integration runtime (instead of the default Azure provided runtime), as indicated by supplying a value for `integrationRuntimeName`. */ privateKeyPath?: pulumi.Input; /** * Whether to validate host key fingerprint while connecting. If set to `false`, `hostKeyFingerprint` must also be set. */ skipHostKeyValidation?: pulumi.Input; /** * The username used to log on to the SFTP server. */ username?: pulumi.Input; } /** * The set of arguments for constructing a LinkedServiceSftp resource. */ export interface LinkedServiceSftpArgs { /** * A map of additional properties to associate with the Data Factory Linked Service. * * The following supported arguments are specific to SFTP Linked Service: */ additionalProperties?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * List of tags that can be used for describing the Data Factory Linked Service. */ annotations?: pulumi.Input[]>; /** * The type of authentication used to connect to the SFTP server. Valid options are `MultiFactor`, `Basic` and `SshPublicKey`. */ authenticationType: pulumi.Input; /** * The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource. */ dataFactoryId: pulumi.Input; /** * The description for the Data Factory Linked Service. */ description?: pulumi.Input; /** * The SFTP server hostname. */ host: pulumi.Input; /** * The host key fingerprint of the SFTP server. */ hostKeyFingerprint?: pulumi.Input; /** * The name of the integration runtime to associate with the Data Factory Linked Service. */ integrationRuntimeName?: pulumi.Input; /** * A `keyVaultPassword` block as defined below. * * > **Note:** Either `password` or `keyVaultPassword` is required when `authenticationType` is set to `Basic`. */ keyVaultPasswords?: pulumi.Input[]>; /** * A `keyVaultPrivateKeyContentBase64` block as defined below. */ keyVaultPrivateKeyContentBase64?: pulumi.Input; /** * A `keyVaultPrivateKeyPassphrase` block as defined below. * * > **Note:** One of `privateKeyContentBase64` or `privateKeyPath` (or their Key Vault equivalent) is required when `authenticationType` is set to `SshPublicKey`. */ keyVaultPrivateKeyPassphrase?: pulumi.Input; /** * 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](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions. */ name?: pulumi.Input; /** * A map of parameters to associate with the Data Factory Linked Service. */ parameters?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Password to log on to the SFTP Server for Basic Authentication. */ password?: pulumi.Input; /** * The TCP port number that the SFTP server uses to listen for client connection. Default value is 22. */ port: pulumi.Input; /** * The Base64 encoded private key content in OpenSSH format used to log on to the SFTP server. */ privateKeyContentBase64?: pulumi.Input; /** * The passphrase for the private key if the key is encrypted. */ privateKeyPassphrase?: pulumi.Input; /** * The absolute path to the private key file that the self-hosted integration runtime can access. * * > **Note:** `privateKeyPath` only applies when using a self-hosted integration runtime (instead of the default Azure provided runtime), as indicated by supplying a value for `integrationRuntimeName`. */ privateKeyPath?: pulumi.Input; /** * Whether to validate host key fingerprint while connecting. If set to `false`, `hostKeyFingerprint` must also be set. */ skipHostKeyValidation?: pulumi.Input; /** * The username used to log on to the SFTP server. */ username: pulumi.Input; }