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

LinkedServiceSynapse

class LinkedServiceSynapse : KotlinCustomResource

Manages a Linked Service (connection) between Synapse 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 exampleLinkedServiceSynapse = new azure.datafactory.LinkedServiceSynapse("example", {
    name: "example",
    dataFactoryId: exampleFactory.id,
    connectionString: "Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test",
});
Content copied to clipboard
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_synapse = azure.datafactory.LinkedServiceSynapse("example",
    name="example",
    data_factory_id=example_factory.id,
    connection_string="Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test")
Content copied to clipboard
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 exampleLinkedServiceSynapse = new Azure.DataFactory.LinkedServiceSynapse("example", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        ConnectionString = "Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test",
    });
});
Content copied to clipboard
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.NewLinkedServiceSynapse(ctx, "example", &datafactory.LinkedServiceSynapseArgs{
			Name:             pulumi.String("example"),
			DataFactoryId:    exampleFactory.ID(),
			ConnectionString: pulumi.String("Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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 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 exampleLinkedServiceSynapse = new LinkedServiceSynapse("exampleLinkedServiceSynapse", LinkedServiceSynapseArgs.builder()
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .connectionString("Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test")
            .build());
    }
}
Content copied to clipboard
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}
  exampleLinkedServiceSynapse:
    type: azure:datafactory:LinkedServiceSynapse
    name: example
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      connectionString: Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test
Content copied to clipboard

With Password In Key Vault

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const current = azure.core.getClientConfig({});
const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleKeyVault = new azure.keyvault.KeyVault("example", {
    name: "example",
    location: example.location,
    resourceGroupName: example.name,
    tenantId: current.then(current => current.tenantId),
    skuName: "standard",
});
const exampleFactory = new azure.datafactory.Factory("example", {
    name: "example",
    location: example.location,
    resourceGroupName: example.name,
});
const exampleLinkedServiceKeyVault = new azure.datafactory.LinkedServiceKeyVault("example", {
    name: "kvlink",
    dataFactoryId: exampleFactory.id,
    keyVaultId: exampleKeyVault.id,
});
const exampleLinkedServiceSynapse = new azure.datafactory.LinkedServiceSynapse("example", {
    name: "example",
    dataFactoryId: exampleFactory.id,
    connectionString: "Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;",
    keyVaultPassword: {
        linkedServiceName: exampleLinkedServiceKeyVault.name,
        secretName: "secret",
    },
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
current = azure.core.get_client_config()
example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_key_vault = azure.keyvault.KeyVault("example",
    name="example",
    location=example.location,
    resource_group_name=example.name,
    tenant_id=current.tenant_id,
    sku_name="standard")
example_factory = azure.datafactory.Factory("example",
    name="example",
    location=example.location,
    resource_group_name=example.name)
example_linked_service_key_vault = azure.datafactory.LinkedServiceKeyVault("example",
    name="kvlink",
    data_factory_id=example_factory.id,
    key_vault_id=example_key_vault.id)
example_linked_service_synapse = azure.datafactory.LinkedServiceSynapse("example",
    name="example",
    data_factory_id=example_factory.id,
    connection_string="Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;",
    key_vault_password={
        "linked_service_name": example_linked_service_key_vault.name,
        "secret_name": "secret",
    })
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
    var current = Azure.Core.GetClientConfig.Invoke();
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });
    var exampleKeyVault = new Azure.KeyVault.KeyVault("example", new()
    {
        Name = "example",
        Location = example.Location,
        ResourceGroupName = example.Name,
        TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
        SkuName = "standard",
    });
    var exampleFactory = new Azure.DataFactory.Factory("example", new()
    {
        Name = "example",
        Location = example.Location,
        ResourceGroupName = example.Name,
    });
    var exampleLinkedServiceKeyVault = new Azure.DataFactory.LinkedServiceKeyVault("example", new()
    {
        Name = "kvlink",
        DataFactoryId = exampleFactory.Id,
        KeyVaultId = exampleKeyVault.Id,
    });
    var exampleLinkedServiceSynapse = new Azure.DataFactory.LinkedServiceSynapse("example", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        ConnectionString = "Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;",
        KeyVaultPassword = new Azure.DataFactory.Inputs.LinkedServiceSynapseKeyVaultPasswordArgs
        {
            LinkedServiceName = exampleLinkedServiceKeyVault.Name,
            SecretName = "secret",
        },
    });
});
Content copied to clipboard
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-azure/sdk/v6/go/azure/keyvault"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := core.GetClientConfig(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleKeyVault, err := keyvault.NewKeyVault(ctx, "example", &keyvault.KeyVaultArgs{
			Name:              pulumi.String("example"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			TenantId:          pulumi.String(current.TenantId),
			SkuName:           pulumi.String("standard"),
		})
		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
		}
		exampleLinkedServiceKeyVault, err := datafactory.NewLinkedServiceKeyVault(ctx, "example", &datafactory.LinkedServiceKeyVaultArgs{
			Name:          pulumi.String("kvlink"),
			DataFactoryId: exampleFactory.ID(),
			KeyVaultId:    exampleKeyVault.ID(),
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewLinkedServiceSynapse(ctx, "example", &datafactory.LinkedServiceSynapseArgs{
			Name:             pulumi.String("example"),
			DataFactoryId:    exampleFactory.ID(),
			ConnectionString: pulumi.String("Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;"),
			KeyVaultPassword: &datafactory.LinkedServiceSynapseKeyVaultPasswordArgs{
				LinkedServiceName: exampleLinkedServiceKeyVault.Name,
				SecretName:        pulumi.String("secret"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());
        var exampleKeyVault = new KeyVault("exampleKeyVault", KeyVaultArgs.builder()
            .name("example")
            .location(example.location())
            .resourceGroupName(example.name())
            .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
            .skuName("standard")
            .build());
        var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
            .name("example")
            .location(example.location())
            .resourceGroupName(example.name())
            .build());
        var exampleLinkedServiceKeyVault = new LinkedServiceKeyVault("exampleLinkedServiceKeyVault", LinkedServiceKeyVaultArgs.builder()
            .name("kvlink")
            .dataFactoryId(exampleFactory.id())
            .keyVaultId(exampleKeyVault.id())
            .build());
        var exampleLinkedServiceSynapse = new LinkedServiceSynapse("exampleLinkedServiceSynapse", LinkedServiceSynapseArgs.builder()
            .name("example")
            .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
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleKeyVault:
    type: azure:keyvault:KeyVault
    name: example
    properties:
      name: example
      location: ${example.location}
      resourceGroupName: ${example.name}
      tenantId: ${current.tenantId}
      skuName: standard
  exampleFactory:
    type: azure:datafactory:Factory
    name: example
    properties:
      name: example
      location: ${example.location}
      resourceGroupName: ${example.name}
  exampleLinkedServiceKeyVault:
    type: azure:datafactory:LinkedServiceKeyVault
    name: example
    properties:
      name: kvlink
      dataFactoryId: ${exampleFactory.id}
      keyVaultId: ${exampleKeyVault.id}
  exampleLinkedServiceSynapse:
    type: azure:datafactory:LinkedServiceSynapse
    name: example
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      connectionString: Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;
      keyVaultPassword:
        linkedServiceName: ${exampleLinkedServiceKeyVault.name}
        secretName: secret
variables:
  current:
    fn::invoke:
      function: azure:core:getClientConfig
      arguments: {}
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

Properties

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

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

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

Link copied to clipboard
val connectionString: Output<String>

The connection string in which to authenticate with the Synapse.

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

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

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

Link copied to clipboard
val keyVaultPassword: Output<LinkedServiceSynapseKeyVaultPassword>?

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>

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

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

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val urn: Output<String>