Azure Classic

v5.24.0 published on Wednesday, Nov 9, 2022 by Pulumi

LinkedServiceSynapse

Manages a Linked Service (connection) between Synapse and Azure Data Factory.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleFactory = new Azure.DataFactory.Factory("exampleFactory", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleLinkedServiceSynapse = new Azure.DataFactory.LinkedServiceSynapse("exampleLinkedServiceSynapse", new()
    {
        DataFactoryId = exampleFactory.Id,
        ConnectionString = "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 {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleFactory, err := datafactory.NewFactory(ctx, "exampleFactory", &datafactory.FactoryArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewLinkedServiceSynapse(ctx, "exampleLinkedServiceSynapse", &datafactory.LinkedServiceSynapseArgs{
			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
	})
}
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());

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_synapse = azure.datafactory.LinkedServiceSynapse("exampleLinkedServiceSynapse",
    data_factory_id=example_factory.id,
    connection_string="Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleFactory = new azure.datafactory.Factory("exampleFactory", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleLinkedServiceSynapse = new azure.datafactory.LinkedServiceSynapse("exampleLinkedServiceSynapse", {
    dataFactoryId: exampleFactory.id,
    connectionString: "Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test",
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleLinkedServiceSynapse:
    type: azure:datafactory:LinkedServiceSynapse
    properties:
      dataFactoryId: ${exampleFactory.id}
      connectionString: Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test

With Password In Key Vault

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var current = Azure.Core.GetClientConfig.Invoke();

    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleKeyVault = new Azure.KeyVault.KeyVault("exampleKeyVault", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
        SkuName = "standard",
    });

    var exampleFactory = new Azure.DataFactory.Factory("exampleFactory", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleLinkedServiceKeyVault = new Azure.DataFactory.LinkedServiceKeyVault("exampleLinkedServiceKeyVault", new()
    {
        DataFactoryId = exampleFactory.Id,
        KeyVaultId = exampleKeyVault.Id,
    });

    var exampleLinkedServiceSynapse = new Azure.DataFactory.LinkedServiceSynapse("exampleLinkedServiceSynapse", new()
    {
        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 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
		}
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleKeyVault, err := keyvault.NewKeyVault(ctx, "exampleKeyVault", &keyvault.KeyVaultArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			TenantId:          pulumi.String(current.TenantId),
			SkuName:           pulumi.String("standard"),
		})
		if err != nil {
			return err
		}
		exampleFactory, err := datafactory.NewFactory(ctx, "exampleFactory", &datafactory.FactoryArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		exampleLinkedServiceKeyVault, err := datafactory.NewLinkedServiceKeyVault(ctx, "exampleLinkedServiceKeyVault", &datafactory.LinkedServiceKeyVaultArgs{
			DataFactoryId: exampleFactory.ID(),
			KeyVaultId:    exampleKeyVault.ID(),
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewLinkedServiceSynapse(ctx, "exampleLinkedServiceSynapse", &datafactory.LinkedServiceSynapseArgs{
			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
	})
}
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());

    }
}
import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_key_vault = azure.keyvault.KeyVault("exampleKeyVault",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    tenant_id=current.tenant_id,
    sku_name="standard")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_key_vault = azure.datafactory.LinkedServiceKeyVault("exampleLinkedServiceKeyVault",
    data_factory_id=example_factory.id,
    key_vault_id=example_key_vault.id)
example_linked_service_synapse = azure.datafactory.LinkedServiceSynapse("exampleLinkedServiceSynapse",
    data_factory_id=example_factory.id,
    connection_string="Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;",
    key_vault_password=azure.datafactory.LinkedServiceSynapseKeyVaultPasswordArgs(
        linked_service_name=example_linked_service_key_vault.name,
        secret_name="secret",
    ))
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const current = azure.core.getClientConfig({});
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleKeyVault = new azure.keyvault.KeyVault("exampleKeyVault", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    tenantId: current.then(current => current.tenantId),
    skuName: "standard",
});
const exampleFactory = new azure.datafactory.Factory("exampleFactory", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleLinkedServiceKeyVault = new azure.datafactory.LinkedServiceKeyVault("exampleLinkedServiceKeyVault", {
    dataFactoryId: exampleFactory.id,
    keyVaultId: exampleKeyVault.id,
});
const exampleLinkedServiceSynapse = new azure.datafactory.LinkedServiceSynapse("exampleLinkedServiceSynapse", {
    dataFactoryId: exampleFactory.id,
    connectionString: "Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;",
    keyVaultPassword: {
        linkedServiceName: exampleLinkedServiceKeyVault.name,
        secretName: "secret",
    },
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleKeyVault:
    type: azure:keyvault:KeyVault
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      tenantId: ${current.tenantId}
      skuName: standard
  exampleFactory:
    type: azure:datafactory:Factory
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleLinkedServiceKeyVault:
    type: azure:datafactory:LinkedServiceKeyVault
    properties:
      dataFactoryId: ${exampleFactory.id}
      keyVaultId: ${exampleKeyVault.id}
  exampleLinkedServiceSynapse:
    type: azure:datafactory:LinkedServiceSynapse
    properties:
      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

new LinkedServiceSynapse(name: string, args: LinkedServiceSynapseArgs, opts?: CustomResourceOptions);
@overload
def LinkedServiceSynapse(resource_name: 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)
@overload
def LinkedServiceSynapse(resource_name: str,
                         args: LinkedServiceSynapseArgs,
                         opts: Optional[ResourceOptions] = 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.

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.

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.

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

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.

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 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 {[key: string]: string}

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

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 {[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.

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.

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.

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

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.

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 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 {[key: string]: string}

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

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 {[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.

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.

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.