Azure Classic

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

LinkedServiceSqlServer

Manages a Linked Service (connection) between a SQL Server 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 exampleLinkedServiceSqlServer = new Azure.DataFactory.LinkedServiceSqlServer("exampleLinkedServiceSqlServer", 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.NewLinkedServiceSqlServer(ctx, "exampleLinkedServiceSqlServer", &datafactory.LinkedServiceSqlServerArgs{
			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.LinkedServiceSqlServer;
import com.pulumi.azure.datafactory.LinkedServiceSqlServerArgs;
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 exampleLinkedServiceSqlServer = new LinkedServiceSqlServer("exampleLinkedServiceSqlServer", LinkedServiceSqlServerArgs.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_sql_server = azure.datafactory.LinkedServiceSqlServer("exampleLinkedServiceSqlServer",
    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 exampleLinkedServiceSqlServer = new azure.datafactory.LinkedServiceSqlServer("exampleLinkedServiceSqlServer", {
    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}
  exampleLinkedServiceSqlServer:
    type: azure:datafactory:LinkedServiceSqlServer
    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 exampleLinkedServiceSqlServer = new Azure.DataFactory.LinkedServiceSqlServer("exampleLinkedServiceSqlServer", new()
    {
        DataFactoryId = exampleFactory.Id,
        ConnectionString = "Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;",
        KeyVaultPassword = new Azure.DataFactory.Inputs.LinkedServiceSqlServerKeyVaultPasswordArgs
        {
            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.NewLinkedServiceSqlServer(ctx, "exampleLinkedServiceSqlServer", &datafactory.LinkedServiceSqlServerArgs{
			DataFactoryId:    exampleFactory.ID(),
			ConnectionString: pulumi.String("Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;"),
			KeyVaultPassword: &datafactory.LinkedServiceSqlServerKeyVaultPasswordArgs{
				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.LinkedServiceSqlServer;
import com.pulumi.azure.datafactory.LinkedServiceSqlServerArgs;
import com.pulumi.azure.datafactory.inputs.LinkedServiceSqlServerKeyVaultPasswordArgs;
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 exampleLinkedServiceSqlServer = new LinkedServiceSqlServer("exampleLinkedServiceSqlServer", LinkedServiceSqlServerArgs.builder()        
            .dataFactoryId(exampleFactory.id())
            .connectionString("Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;")
            .keyVaultPassword(LinkedServiceSqlServerKeyVaultPasswordArgs.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_sql_server = azure.datafactory.LinkedServiceSqlServer("exampleLinkedServiceSqlServer",
    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.LinkedServiceSqlServerKeyVaultPasswordArgs(
        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 exampleLinkedServiceSqlServer = new azure.datafactory.LinkedServiceSqlServer("exampleLinkedServiceSqlServer", {
    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}
  exampleLinkedServiceSqlServer:
    type: azure:datafactory:LinkedServiceSqlServer
    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 LinkedServiceSqlServer Resource

new LinkedServiceSqlServer(name: string, args: LinkedServiceSqlServerArgs, opts?: CustomResourceOptions);
@overload
def LinkedServiceSqlServer(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_connection_string: Optional[LinkedServiceSqlServerKeyVaultConnectionStringArgs] = None,
                           key_vault_password: Optional[LinkedServiceSqlServerKeyVaultPasswordArgs] = None,
                           name: Optional[str] = None,
                           parameters: Optional[Mapping[str, str]] = None,
                           user_name: Optional[str] = None)
@overload
def LinkedServiceSqlServer(resource_name: str,
                           args: LinkedServiceSqlServerArgs,
                           opts: Optional[ResourceOptions] = None)
func NewLinkedServiceSqlServer(ctx *Context, name string, args LinkedServiceSqlServerArgs, opts ...ResourceOption) (*LinkedServiceSqlServer, error)
public LinkedServiceSqlServer(string name, LinkedServiceSqlServerArgs args, CustomResourceOptions? opts = null)
public LinkedServiceSqlServer(String name, LinkedServiceSqlServerArgs args)
public LinkedServiceSqlServer(String name, LinkedServiceSqlServerArgs args, CustomResourceOptions options)
type: azure:datafactory:LinkedServiceSqlServer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args LinkedServiceSqlServerArgs
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 LinkedServiceSqlServerArgs
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 LinkedServiceSqlServerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args LinkedServiceSqlServerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args LinkedServiceSqlServerArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

LinkedServiceSqlServer 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 LinkedServiceSqlServer resource accepts the following input properties:

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

Annotations List<string>

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

ConnectionString string

The connection string in which to authenticate with the SQL Server. Exactly one of either connection_string or key_vault_connection_string is required.

Description string

The description for the Data Factory Linked Service SQL Server.

IntegrationRuntimeName string

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

KeyVaultConnectionString LinkedServiceSqlServerKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store SQL Server connection string in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either connection_string or key_vault_connection_string is required.

KeyVaultPassword LinkedServiceSqlServerKeyVaultPasswordArgs

A key_vault_password block as defined below. Use this argument to store SQL Server 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 SQL Server. 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 SQL Server.

UserName string

The on-premises Windows authentication user name.

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

Annotations []string

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

ConnectionString string

The connection string in which to authenticate with the SQL Server. Exactly one of either connection_string or key_vault_connection_string is required.

Description string

The description for the Data Factory Linked Service SQL Server.

IntegrationRuntimeName string

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

KeyVaultConnectionString LinkedServiceSqlServerKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store SQL Server connection string in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either connection_string or key_vault_connection_string is required.

KeyVaultPassword LinkedServiceSqlServerKeyVaultPasswordArgs

A key_vault_password block as defined below. Use this argument to store SQL Server 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 SQL Server. 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 SQL Server.

UserName string

The on-premises Windows authentication user name.

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

annotations List<String>

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

connectionString String

The connection string in which to authenticate with the SQL Server. Exactly one of either connection_string or key_vault_connection_string is required.

description String

The description for the Data Factory Linked Service SQL Server.

integrationRuntimeName String

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

keyVaultConnectionString LinkedServiceSqlServerKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store SQL Server connection string in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either connection_string or key_vault_connection_string is required.

keyVaultPassword LinkedServiceSqlServerKeyVaultPasswordArgs

A key_vault_password block as defined below. Use this argument to store SQL Server 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 SQL Server. 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 SQL Server.

userName String

The on-premises Windows authentication user name.

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

annotations string[]

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

connectionString string

The connection string in which to authenticate with the SQL Server. Exactly one of either connection_string or key_vault_connection_string is required.

description string

The description for the Data Factory Linked Service SQL Server.

integrationRuntimeName string

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

keyVaultConnectionString LinkedServiceSqlServerKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store SQL Server connection string in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either connection_string or key_vault_connection_string is required.

keyVaultPassword LinkedServiceSqlServerKeyVaultPasswordArgs

A key_vault_password block as defined below. Use this argument to store SQL Server 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 SQL Server. 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 SQL Server.

userName string

The on-premises Windows authentication user name.

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

annotations Sequence[str]

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

connection_string str

The connection string in which to authenticate with the SQL Server. Exactly one of either connection_string or key_vault_connection_string is required.

description str

The description for the Data Factory Linked Service SQL Server.

integration_runtime_name str

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

key_vault_connection_string LinkedServiceSqlServerKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store SQL Server connection string in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either connection_string or key_vault_connection_string is required.

key_vault_password LinkedServiceSqlServerKeyVaultPasswordArgs

A key_vault_password block as defined below. Use this argument to store SQL Server 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 SQL Server. 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 SQL Server.

user_name str

The on-premises Windows authentication user name.

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

annotations List<String>

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

connectionString String

The connection string in which to authenticate with the SQL Server. Exactly one of either connection_string or key_vault_connection_string is required.

description String

The description for the Data Factory Linked Service SQL Server.

integrationRuntimeName String

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

keyVaultConnectionString Property Map

A key_vault_connection_string block as defined below. Use this argument to store SQL Server connection string in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either connection_string or key_vault_connection_string is required.

keyVaultPassword Property Map

A key_vault_password block as defined below. Use this argument to store SQL Server 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 SQL Server. 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 SQL Server.

userName String

The on-premises Windows authentication user name.

Outputs

All input properties are implicitly available as output properties. Additionally, the LinkedServiceSqlServer 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 LinkedServiceSqlServer Resource

Get an existing LinkedServiceSqlServer 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?: LinkedServiceSqlServerState, opts?: CustomResourceOptions): LinkedServiceSqlServer
@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_connection_string: Optional[LinkedServiceSqlServerKeyVaultConnectionStringArgs] = None,
        key_vault_password: Optional[LinkedServiceSqlServerKeyVaultPasswordArgs] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        user_name: Optional[str] = None) -> LinkedServiceSqlServer
func GetLinkedServiceSqlServer(ctx *Context, name string, id IDInput, state *LinkedServiceSqlServerState, opts ...ResourceOption) (*LinkedServiceSqlServer, error)
public static LinkedServiceSqlServer Get(string name, Input<string> id, LinkedServiceSqlServerState? state, CustomResourceOptions? opts = null)
public static LinkedServiceSqlServer get(String name, Output<String> id, LinkedServiceSqlServerState 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 SQL Server.

Annotations List<string>

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

ConnectionString string

The connection string in which to authenticate with the SQL Server. Exactly one of either connection_string or key_vault_connection_string is required.

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

IntegrationRuntimeName string

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

KeyVaultConnectionString LinkedServiceSqlServerKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store SQL Server connection string in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either connection_string or key_vault_connection_string is required.

KeyVaultPassword LinkedServiceSqlServerKeyVaultPasswordArgs

A key_vault_password block as defined below. Use this argument to store SQL Server 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 SQL Server. 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 SQL Server.

UserName string

The on-premises Windows authentication user name.

AdditionalProperties map[string]string

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

Annotations []string

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

ConnectionString string

The connection string in which to authenticate with the SQL Server. Exactly one of either connection_string or key_vault_connection_string is required.

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

IntegrationRuntimeName string

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

KeyVaultConnectionString LinkedServiceSqlServerKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store SQL Server connection string in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either connection_string or key_vault_connection_string is required.

KeyVaultPassword LinkedServiceSqlServerKeyVaultPasswordArgs

A key_vault_password block as defined below. Use this argument to store SQL Server 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 SQL Server. 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 SQL Server.

UserName string

The on-premises Windows authentication user name.

additionalProperties Map<String,String>

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

annotations List<String>

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

connectionString String

The connection string in which to authenticate with the SQL Server. Exactly one of either connection_string or key_vault_connection_string is required.

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

integrationRuntimeName String

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

keyVaultConnectionString LinkedServiceSqlServerKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store SQL Server connection string in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either connection_string or key_vault_connection_string is required.

keyVaultPassword LinkedServiceSqlServerKeyVaultPasswordArgs

A key_vault_password block as defined below. Use this argument to store SQL Server 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 SQL Server. 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 SQL Server.

userName String

The on-premises Windows authentication user name.

additionalProperties {[key: string]: string}

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

annotations string[]

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

connectionString string

The connection string in which to authenticate with the SQL Server. Exactly one of either connection_string or key_vault_connection_string is required.

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

integrationRuntimeName string

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

keyVaultConnectionString LinkedServiceSqlServerKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store SQL Server connection string in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either connection_string or key_vault_connection_string is required.

keyVaultPassword LinkedServiceSqlServerKeyVaultPasswordArgs

A key_vault_password block as defined below. Use this argument to store SQL Server 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 SQL Server. 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 SQL Server.

userName string

The on-premises Windows authentication user name.

additional_properties Mapping[str, str]

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

annotations Sequence[str]

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

connection_string str

The connection string in which to authenticate with the SQL Server. Exactly one of either connection_string or key_vault_connection_string is required.

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

integration_runtime_name str

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

key_vault_connection_string LinkedServiceSqlServerKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store SQL Server connection string in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either connection_string or key_vault_connection_string is required.

key_vault_password LinkedServiceSqlServerKeyVaultPasswordArgs

A key_vault_password block as defined below. Use this argument to store SQL Server 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 SQL Server. 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 SQL Server.

user_name str

The on-premises Windows authentication user name.

additionalProperties Map<String>

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

annotations List<String>

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

connectionString String

The connection string in which to authenticate with the SQL Server. Exactly one of either connection_string or key_vault_connection_string is required.

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

integrationRuntimeName String

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

keyVaultConnectionString Property Map

A key_vault_connection_string block as defined below. Use this argument to store SQL Server connection string in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. Exactly one of either connection_string or key_vault_connection_string is required.

keyVaultPassword Property Map

A key_vault_password block as defined below. Use this argument to store SQL Server 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 SQL Server. 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 SQL Server.

userName String

The on-premises Windows authentication user name.

Supporting Types

LinkedServiceSqlServerKeyVaultConnectionString

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 SQL Server connection string.

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 SQL Server connection string.

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 SQL Server connection string.

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 SQL Server connection string.

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 SQL Server connection string.

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 SQL Server connection string.

LinkedServiceSqlServerKeyVaultPassword

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 SQL Server 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 SQL Server 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 SQL Server 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 SQL Server 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 SQL Server 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 SQL Server password.

Import

Data Factory SQL Server Linked Service’s can be imported using the resource id, e.g.

 $ pulumi import azure:datafactory/linkedServiceSqlServer:LinkedServiceSqlServer 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.