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

LinkedServiceSynapseArgs

data class LinkedServiceSynapseArgs(val additionalProperties: Output<Map<String, String>>? = null, val annotations: Output<List<String>>? = null, val connectionString: Output<String>? = null, val dataFactoryId: Output<String>? = null, val description: Output<String>? = null, val integrationRuntimeName: Output<String>? = null, val keyVaultPassword: Output<LinkedServiceSynapseKeyVaultPasswordArgs>? = null, val name: Output<String>? = null, val parameters: Output<Map<String, String>>? = null) : ConvertibleToJava<LinkedServiceSynapseArgs>

Manages a Linked Service (connection) between Synapse 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.LinkedServiceSynapse;
import com.pulumi.azure.datafactory.LinkedServiceSynapseArgs;
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 exampleLinkedServiceSynapse = new LinkedServiceSynapse("exampleLinkedServiceSynapse", LinkedServiceSynapseArgs.builder()
            .dataFactoryId(exampleFactory.id())
            .connectionString("Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test")
            .build());
    }
}
Content copied to clipboard

With Password In Key Vault

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.keyvault.KeyVault;
import com.pulumi.azure.keyvault.KeyVaultArgs;
import com.pulumi.azure.datafactory.Factory;
import com.pulumi.azure.datafactory.FactoryArgs;
import com.pulumi.azure.datafactory.LinkedServiceKeyVault;
import com.pulumi.azure.datafactory.LinkedServiceKeyVaultArgs;
import com.pulumi.azure.datafactory.LinkedServiceSynapse;
import com.pulumi.azure.datafactory.LinkedServiceSynapseArgs;
import com.pulumi.azure.datafactory.inputs.LinkedServiceSynapseKeyVaultPasswordArgs;
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) {
        final var current = CoreFunctions.getClientConfig();
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleKeyVault = new KeyVault("exampleKeyVault", KeyVaultArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
            .skuName("standard")
            .build());
        var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());
        var exampleLinkedServiceKeyVault = new LinkedServiceKeyVault("exampleLinkedServiceKeyVault", LinkedServiceKeyVaultArgs.builder()
            .dataFactoryId(exampleFactory.id())
            .keyVaultId(exampleKeyVault.id())
            .build());
        var exampleLinkedServiceSynapse = new LinkedServiceSynapse("exampleLinkedServiceSynapse", LinkedServiceSynapseArgs.builder()
            .dataFactoryId(exampleFactory.id())
            .connectionString("Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;")
            .keyVaultPassword(LinkedServiceSynapseKeyVaultPasswordArgs.builder()
                .linkedServiceName(exampleLinkedServiceKeyVault.name())
                .secretName("secret")
                .build())
            .build());
    }
}
Content copied to clipboard

Import

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

$ pulumi import azure:datafactory/linkedServiceSynapse:LinkedServiceSynapse example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example
Content copied to clipboard

Constructors

Link copied to clipboard
fun LinkedServiceSynapseArgs(additionalProperties: Output<Map<String, String>>? = null, annotations: Output<List<String>>? = null, connectionString: Output<String>? = null, dataFactoryId: Output<String>? = null, description: Output<String>? = null, integrationRuntimeName: Output<String>? = null, keyVaultPassword: Output<LinkedServiceSynapseKeyVaultPasswordArgs>? = null, name: Output<String>? = null, parameters: Output<Map<String, String>>? = null)

Functions

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

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 Synapse. The following supported arguments are specific to Data Factory Synapse 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 Synapse.

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

The connection string in which to authenticate with the Synapse.

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 Synapse.

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

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

Link copied to clipboard
val keyVaultPassword: Output<LinkedServiceSynapseKeyVaultPasswordArgs>? = null

A key_vault_password block as defined below. Use this argument to store Synapse password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.

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

Specifies the name of the Data Factory Linked Service Synapse. 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 Synapse.