1. Packages
  2. Azure Classic
  3. API Docs
  4. datafactory
  5. LinkedServiceSynapse

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

azure.datafactory.LinkedServiceSynapse

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

    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",
    });
    
    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")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/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
    	})
    }
    
    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",
        });
    
    });
    
    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());
    
        }
    }
    
    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
    

    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",
        },
    });
    
    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={
            "linkedServiceName": example_linked_service_key_vault.name,
            "secretName": "secret",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
    	"github.com/pulumi/pulumi-azure/sdk/v5/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, nil, 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
    	})
    }
    
    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",
            },
        });
    
    });
    
    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());
    
        }
    }
    
    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: {}
    

    Create LinkedServiceSynapse Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LinkedServiceSynapse(name: string, args: LinkedServiceSynapseArgs, opts?: CustomResourceOptions);
    @overload
    def LinkedServiceSynapse(resource_name: str,
                             args: LinkedServiceSynapseArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def LinkedServiceSynapse(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             connection_string: Optional[str] = None,
                             data_factory_id: Optional[str] = None,
                             additional_properties: Optional[Mapping[str, str]] = None,
                             annotations: Optional[Sequence[str]] = None,
                             description: Optional[str] = None,
                             integration_runtime_name: Optional[str] = None,
                             key_vault_password: Optional[LinkedServiceSynapseKeyVaultPasswordArgs] = None,
                             name: Optional[str] = None,
                             parameters: Optional[Mapping[str, str]] = None)
    func NewLinkedServiceSynapse(ctx *Context, name string, args LinkedServiceSynapseArgs, opts ...ResourceOption) (*LinkedServiceSynapse, error)
    public LinkedServiceSynapse(string name, LinkedServiceSynapseArgs args, CustomResourceOptions? opts = null)
    public LinkedServiceSynapse(String name, LinkedServiceSynapseArgs args)
    public LinkedServiceSynapse(String name, LinkedServiceSynapseArgs args, CustomResourceOptions options)
    
    type: azure:datafactory:LinkedServiceSynapse
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args LinkedServiceSynapseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LinkedServiceSynapseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LinkedServiceSynapseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkedServiceSynapseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LinkedServiceSynapseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var linkedServiceSynapseResource = new Azure.DataFactory.LinkedServiceSynapse("linkedServiceSynapseResource", new()
    {
        ConnectionString = "string",
        DataFactoryId = "string",
        AdditionalProperties = 
        {
            { "string", "string" },
        },
        Annotations = new[]
        {
            "string",
        },
        Description = "string",
        IntegrationRuntimeName = "string",
        KeyVaultPassword = new Azure.DataFactory.Inputs.LinkedServiceSynapseKeyVaultPasswordArgs
        {
            LinkedServiceName = "string",
            SecretName = "string",
        },
        Name = "string",
        Parameters = 
        {
            { "string", "string" },
        },
    });
    
    example, err := datafactory.NewLinkedServiceSynapse(ctx, "linkedServiceSynapseResource", &datafactory.LinkedServiceSynapseArgs{
    	ConnectionString: pulumi.String("string"),
    	DataFactoryId:    pulumi.String("string"),
    	AdditionalProperties: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Annotations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description:            pulumi.String("string"),
    	IntegrationRuntimeName: pulumi.String("string"),
    	KeyVaultPassword: &datafactory.LinkedServiceSynapseKeyVaultPasswordArgs{
    		LinkedServiceName: pulumi.String("string"),
    		SecretName:        pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Parameters: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var linkedServiceSynapseResource = new LinkedServiceSynapse("linkedServiceSynapseResource", LinkedServiceSynapseArgs.builder()
        .connectionString("string")
        .dataFactoryId("string")
        .additionalProperties(Map.of("string", "string"))
        .annotations("string")
        .description("string")
        .integrationRuntimeName("string")
        .keyVaultPassword(LinkedServiceSynapseKeyVaultPasswordArgs.builder()
            .linkedServiceName("string")
            .secretName("string")
            .build())
        .name("string")
        .parameters(Map.of("string", "string"))
        .build());
    
    linked_service_synapse_resource = azure.datafactory.LinkedServiceSynapse("linkedServiceSynapseResource",
        connection_string="string",
        data_factory_id="string",
        additional_properties={
            "string": "string",
        },
        annotations=["string"],
        description="string",
        integration_runtime_name="string",
        key_vault_password={
            "linkedServiceName": "string",
            "secretName": "string",
        },
        name="string",
        parameters={
            "string": "string",
        })
    
    const linkedServiceSynapseResource = new azure.datafactory.LinkedServiceSynapse("linkedServiceSynapseResource", {
        connectionString: "string",
        dataFactoryId: "string",
        additionalProperties: {
            string: "string",
        },
        annotations: ["string"],
        description: "string",
        integrationRuntimeName: "string",
        keyVaultPassword: {
            linkedServiceName: "string",
            secretName: "string",
        },
        name: "string",
        parameters: {
            string: "string",
        },
    });
    
    type: azure:datafactory:LinkedServiceSynapse
    properties:
        additionalProperties:
            string: string
        annotations:
            - string
        connectionString: string
        dataFactoryId: string
        description: string
        integrationRuntimeName: string
        keyVaultPassword:
            linkedServiceName: string
            secretName: string
        name: string
        parameters:
            string: string
    

    LinkedServiceSynapse Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The LinkedServiceSynapse resource accepts the following input properties:

    ConnectionString string
    The connection string in which to authenticate with the Synapse.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    AdditionalProperties Dictionary<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:

    Annotations List<string>
    List of tags that can be used for describing the Data Factory Linked Service Synapse.
    Description string
    The description for the Data Factory Linked Service Synapse.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service Synapse.
    KeyVaultPassword 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.
    Name 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.
    Parameters Dictionary<string, string>
    A map of parameters to associate with the Data Factory Linked Service Synapse.
    ConnectionString string
    The connection string in which to authenticate with the Synapse.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    AdditionalProperties 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:

    Annotations []string
    List of tags that can be used for describing the Data Factory Linked Service Synapse.
    Description string
    The description for the Data Factory Linked Service Synapse.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service Synapse.
    KeyVaultPassword LinkedServiceSynapseKeyVaultPasswordArgs
    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.
    Name 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.
    Parameters map[string]string
    A map of parameters to associate with the Data Factory Linked Service Synapse.
    connectionString String
    The connection string in which to authenticate with the Synapse.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    additionalProperties 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:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service Synapse.
    description String
    The description for the Data Factory Linked Service Synapse.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service Synapse.
    keyVaultPassword 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.
    name 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.
    parameters Map<String,String>
    A map of parameters to associate with the Data Factory Linked Service Synapse.
    connectionString string
    The connection string in which to authenticate with the Synapse.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    additionalProperties {[key: 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:

    annotations string[]
    List of tags that can be used for describing the Data Factory Linked Service Synapse.
    description string
    The description for the Data Factory Linked Service Synapse.
    integrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service Synapse.
    keyVaultPassword 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.
    name 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.
    parameters {[key: string]: string}
    A map of parameters to associate with the Data Factory Linked Service Synapse.
    connection_string str
    The connection string in which to authenticate with the Synapse.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    additional_properties Mapping[str, str]

    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:

    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Linked Service Synapse.
    description str
    The description for the Data Factory Linked Service Synapse.
    integration_runtime_name str
    The integration runtime reference to associate with the Data Factory Linked Service Synapse.
    key_vault_password LinkedServiceSynapseKeyVaultPasswordArgs
    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.
    name str
    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.
    parameters Mapping[str, str]
    A map of parameters to associate with the Data Factory Linked Service Synapse.
    connectionString String
    The connection string in which to authenticate with the Synapse.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    additionalProperties Map<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:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service Synapse.
    description String
    The description for the Data Factory Linked Service Synapse.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service Synapse.
    keyVaultPassword Property Map
    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.
    name 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.
    parameters Map<String>
    A map of parameters to associate with the Data Factory Linked Service Synapse.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LinkedServiceSynapse resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing LinkedServiceSynapse Resource

    Get an existing LinkedServiceSynapse resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: LinkedServiceSynapseState, opts?: CustomResourceOptions): LinkedServiceSynapse
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            additional_properties: Optional[Mapping[str, str]] = None,
            annotations: Optional[Sequence[str]] = None,
            connection_string: Optional[str] = None,
            data_factory_id: Optional[str] = None,
            description: Optional[str] = None,
            integration_runtime_name: Optional[str] = None,
            key_vault_password: Optional[LinkedServiceSynapseKeyVaultPasswordArgs] = None,
            name: Optional[str] = None,
            parameters: Optional[Mapping[str, str]] = None) -> LinkedServiceSynapse
    func GetLinkedServiceSynapse(ctx *Context, name string, id IDInput, state *LinkedServiceSynapseState, opts ...ResourceOption) (*LinkedServiceSynapse, error)
    public static LinkedServiceSynapse Get(string name, Input<string> id, LinkedServiceSynapseState? state, CustomResourceOptions? opts = null)
    public static LinkedServiceSynapse get(String name, Output<String> id, LinkedServiceSynapseState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdditionalProperties Dictionary<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:

    Annotations List<string>
    List of tags that can be used for describing the Data Factory Linked Service Synapse.
    ConnectionString string
    The connection string in which to authenticate with the Synapse.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Description string
    The description for the Data Factory Linked Service Synapse.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service Synapse.
    KeyVaultPassword 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.
    Name 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.
    Parameters Dictionary<string, string>
    A map of parameters to associate with the Data Factory Linked Service Synapse.
    AdditionalProperties 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:

    Annotations []string
    List of tags that can be used for describing the Data Factory Linked Service Synapse.
    ConnectionString string
    The connection string in which to authenticate with the Synapse.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    Description string
    The description for the Data Factory Linked Service Synapse.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service Synapse.
    KeyVaultPassword LinkedServiceSynapseKeyVaultPasswordArgs
    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.
    Name 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.
    Parameters map[string]string
    A map of parameters to associate with the Data Factory Linked Service Synapse.
    additionalProperties 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:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service Synapse.
    connectionString String
    The connection string in which to authenticate with the Synapse.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description String
    The description for the Data Factory Linked Service Synapse.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service Synapse.
    keyVaultPassword 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.
    name 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.
    parameters Map<String,String>
    A map of parameters to associate with the Data Factory Linked Service Synapse.
    additionalProperties {[key: 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:

    annotations string[]
    List of tags that can be used for describing the Data Factory Linked Service Synapse.
    connectionString string
    The connection string in which to authenticate with the Synapse.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description string
    The description for the Data Factory Linked Service Synapse.
    integrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service Synapse.
    keyVaultPassword 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.
    name 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.
    parameters {[key: string]: string}
    A map of parameters to associate with the Data Factory Linked Service Synapse.
    additional_properties Mapping[str, str]

    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:

    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Linked Service Synapse.
    connection_string str
    The connection string in which to authenticate with the Synapse.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description str
    The description for the Data Factory Linked Service Synapse.
    integration_runtime_name str
    The integration runtime reference to associate with the Data Factory Linked Service Synapse.
    key_vault_password LinkedServiceSynapseKeyVaultPasswordArgs
    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.
    name str
    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.
    parameters Mapping[str, str]
    A map of parameters to associate with the Data Factory Linked Service Synapse.
    additionalProperties Map<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:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service Synapse.
    connectionString String
    The connection string in which to authenticate with the Synapse.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    description String
    The description for the Data Factory Linked Service Synapse.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service Synapse.
    keyVaultPassword Property Map
    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.
    name 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.
    parameters Map<String>
    A map of parameters to associate with the Data Factory Linked Service Synapse.

    Supporting Types

    LinkedServiceSynapseKeyVaultPassword, LinkedServiceSynapseKeyVaultPasswordArgs

    LinkedServiceName string
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    SecretName string
    Specifies the secret name in Azure Key Vault that stores Synapse password.
    LinkedServiceName string
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    SecretName string
    Specifies the secret name in Azure Key Vault that stores Synapse password.
    linkedServiceName String
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secretName String
    Specifies the secret name in Azure Key Vault that stores Synapse password.
    linkedServiceName string
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secretName string
    Specifies the secret name in Azure Key Vault that stores Synapse password.
    linked_service_name str
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secret_name str
    Specifies the secret name in Azure Key Vault that stores Synapse password.
    linkedServiceName String
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secretName String
    Specifies the secret name in Azure Key Vault that stores Synapse password.

    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
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi