We recommend using Azure Native.
azure.datafactory.LinkedServiceSqlServer
Explore with Pulumi AI
Manages a Linked Service (connection) between a SQL Server 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 exampleLinkedServiceSqlServer = new azure.datafactory.LinkedServiceSqlServer("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_sql_server = azure.datafactory.LinkedServiceSqlServer("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/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/datafactory"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
Name: pulumi.String("example"),
Location: example.Location,
ResourceGroupName: example.Name,
})
if err != nil {
return err
}
_, err = datafactory.NewLinkedServiceSqlServer(ctx, "example", &datafactory.LinkedServiceSqlServerArgs{
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 exampleLinkedServiceSqlServer = new Azure.DataFactory.LinkedServiceSqlServer("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.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 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 exampleLinkedServiceSqlServer = new LinkedServiceSqlServer("exampleLinkedServiceSqlServer", LinkedServiceSqlServerArgs.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}
exampleLinkedServiceSqlServer:
type: azure:datafactory:LinkedServiceSqlServer
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 exampleLinkedServiceSqlServer = new azure.datafactory.LinkedServiceSqlServer("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_sql_server = azure.datafactory.LinkedServiceSqlServer("example",
name="example",
data_factory_id=example_factory.id,
connection_string="Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;",
key_vault_password={
"linked_service_name": example_linked_service_key_vault.name,
"secret_name": "secret",
})
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/datafactory"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/keyvault"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
current, err := core.GetClientConfig(ctx, map[string]interface{}{}, nil)
if err != nil {
return err
}
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleKeyVault, err := keyvault.NewKeyVault(ctx, "example", &keyvault.KeyVaultArgs{
Name: pulumi.String("example"),
Location: example.Location,
ResourceGroupName: example.Name,
TenantId: pulumi.String(current.TenantId),
SkuName: pulumi.String("standard"),
})
if err != nil {
return err
}
exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
Name: pulumi.String("example"),
Location: example.Location,
ResourceGroupName: example.Name,
})
if err != nil {
return err
}
exampleLinkedServiceKeyVault, err := datafactory.NewLinkedServiceKeyVault(ctx, "example", &datafactory.LinkedServiceKeyVaultArgs{
Name: pulumi.String("kvlink"),
DataFactoryId: exampleFactory.ID(),
KeyVaultId: exampleKeyVault.ID(),
})
if err != nil {
return err
}
_, err = datafactory.NewLinkedServiceSqlServer(ctx, "example", &datafactory.LinkedServiceSqlServerArgs{
Name: pulumi.String("example"),
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
})
}
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 exampleLinkedServiceSqlServer = new Azure.DataFactory.LinkedServiceSqlServer("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.LinkedServiceSqlServerKeyVaultPasswordArgs
{
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.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 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 exampleLinkedServiceSqlServer = new LinkedServiceSqlServer("exampleLinkedServiceSqlServer", LinkedServiceSqlServerArgs.builder()
.name("example")
.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());
}
}
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}
exampleLinkedServiceSqlServer:
type: azure:datafactory:LinkedServiceSqlServer
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 LinkedServiceSqlServer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LinkedServiceSqlServer(name: string, args: LinkedServiceSqlServerArgs, opts?: CustomResourceOptions);
@overload
def LinkedServiceSqlServer(resource_name: str,
args: LinkedServiceSqlServerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def LinkedServiceSqlServer(resource_name: str,
opts: Optional[ResourceOptions] = None,
data_factory_id: Optional[str] = None,
additional_properties: Optional[Mapping[str, str]] = None,
annotations: Optional[Sequence[str]] = None,
connection_string: 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)
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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var linkedServiceSqlServerResource = new Azure.DataFactory.LinkedServiceSqlServer("linkedServiceSqlServerResource", new()
{
DataFactoryId = "string",
AdditionalProperties =
{
{ "string", "string" },
},
Annotations = new[]
{
"string",
},
ConnectionString = "string",
Description = "string",
IntegrationRuntimeName = "string",
KeyVaultConnectionString = new Azure.DataFactory.Inputs.LinkedServiceSqlServerKeyVaultConnectionStringArgs
{
LinkedServiceName = "string",
SecretName = "string",
},
KeyVaultPassword = new Azure.DataFactory.Inputs.LinkedServiceSqlServerKeyVaultPasswordArgs
{
LinkedServiceName = "string",
SecretName = "string",
},
Name = "string",
Parameters =
{
{ "string", "string" },
},
UserName = "string",
});
example, err := datafactory.NewLinkedServiceSqlServer(ctx, "linkedServiceSqlServerResource", &datafactory.LinkedServiceSqlServerArgs{
DataFactoryId: pulumi.String("string"),
AdditionalProperties: pulumi.StringMap{
"string": pulumi.String("string"),
},
Annotations: pulumi.StringArray{
pulumi.String("string"),
},
ConnectionString: pulumi.String("string"),
Description: pulumi.String("string"),
IntegrationRuntimeName: pulumi.String("string"),
KeyVaultConnectionString: &datafactory.LinkedServiceSqlServerKeyVaultConnectionStringArgs{
LinkedServiceName: pulumi.String("string"),
SecretName: pulumi.String("string"),
},
KeyVaultPassword: &datafactory.LinkedServiceSqlServerKeyVaultPasswordArgs{
LinkedServiceName: pulumi.String("string"),
SecretName: pulumi.String("string"),
},
Name: pulumi.String("string"),
Parameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
UserName: pulumi.String("string"),
})
var linkedServiceSqlServerResource = new LinkedServiceSqlServer("linkedServiceSqlServerResource", LinkedServiceSqlServerArgs.builder()
.dataFactoryId("string")
.additionalProperties(Map.of("string", "string"))
.annotations("string")
.connectionString("string")
.description("string")
.integrationRuntimeName("string")
.keyVaultConnectionString(LinkedServiceSqlServerKeyVaultConnectionStringArgs.builder()
.linkedServiceName("string")
.secretName("string")
.build())
.keyVaultPassword(LinkedServiceSqlServerKeyVaultPasswordArgs.builder()
.linkedServiceName("string")
.secretName("string")
.build())
.name("string")
.parameters(Map.of("string", "string"))
.userName("string")
.build());
linked_service_sql_server_resource = azure.datafactory.LinkedServiceSqlServer("linkedServiceSqlServerResource",
data_factory_id="string",
additional_properties={
"string": "string",
},
annotations=["string"],
connection_string="string",
description="string",
integration_runtime_name="string",
key_vault_connection_string={
"linked_service_name": "string",
"secret_name": "string",
},
key_vault_password={
"linked_service_name": "string",
"secret_name": "string",
},
name="string",
parameters={
"string": "string",
},
user_name="string")
const linkedServiceSqlServerResource = new azure.datafactory.LinkedServiceSqlServer("linkedServiceSqlServerResource", {
dataFactoryId: "string",
additionalProperties: {
string: "string",
},
annotations: ["string"],
connectionString: "string",
description: "string",
integrationRuntimeName: "string",
keyVaultConnectionString: {
linkedServiceName: "string",
secretName: "string",
},
keyVaultPassword: {
linkedServiceName: "string",
secretName: "string",
},
name: "string",
parameters: {
string: "string",
},
userName: "string",
});
type: azure:datafactory:LinkedServiceSqlServer
properties:
additionalProperties:
string: string
annotations:
- string
connectionString: string
dataFactoryId: string
description: string
integrationRuntimeName: string
keyVaultConnectionString:
linkedServiceName: string
secretName: string
keyVaultPassword:
linkedServiceName: string
secretName: string
name: string
parameters:
string: string
userName: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The LinkedServiceSqlServer resource accepts the following input properties:
- Data
Factory stringId - The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- Additional
Properties 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.
- Connection
String string - The connection string in which to authenticate with the SQL Server. Exactly one of either
connection_string
orkey_vault_connection_string
is required. - Description string
- The description for the Data Factory Linked Service SQL Server.
- Integration
Runtime stringName - The integration runtime reference to associate with the Data Factory Linked Service SQL Server.
- Key
Vault LinkedConnection String Service Sql Server Key Vault Connection String - 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 eitherconnection_string
orkey_vault_connection_string
is required. - Key
Vault LinkedPassword Service Sql Server Key Vault Password - 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.
- User
Name string - The on-premises Windows authentication user name.
- Data
Factory stringId - The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- Additional
Properties 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.
- Connection
String string - The connection string in which to authenticate with the SQL Server. Exactly one of either
connection_string
orkey_vault_connection_string
is required. - Description string
- The description for the Data Factory Linked Service SQL Server.
- Integration
Runtime stringName - The integration runtime reference to associate with the Data Factory Linked Service SQL Server.
- Key
Vault LinkedConnection String Service Sql Server Key Vault Connection String Args - 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 eitherconnection_string
orkey_vault_connection_string
is required. - Key
Vault LinkedPassword Service Sql Server Key Vault Password Args - 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.
- User
Name string - The on-premises Windows authentication user name.
- data
Factory StringId - The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- additional
Properties 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.
- connection
String String - The connection string in which to authenticate with the SQL Server. Exactly one of either
connection_string
orkey_vault_connection_string
is required. - description String
- The description for the Data Factory Linked Service SQL Server.
- integration
Runtime StringName - The integration runtime reference to associate with the Data Factory Linked Service SQL Server.
- key
Vault LinkedConnection String Service Sql Server Key Vault Connection String - 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 eitherconnection_string
orkey_vault_connection_string
is required. - key
Vault LinkedPassword Service Sql Server Key Vault Password - 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.
- user
Name String - The on-premises Windows authentication user name.
- data
Factory stringId - The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- additional
Properties {[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.
- connection
String string - The connection string in which to authenticate with the SQL Server. Exactly one of either
connection_string
orkey_vault_connection_string
is required. - description string
- The description for the Data Factory Linked Service SQL Server.
- integration
Runtime stringName - The integration runtime reference to associate with the Data Factory Linked Service SQL Server.
- key
Vault LinkedConnection String Service Sql Server Key Vault Connection String - 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 eitherconnection_string
orkey_vault_connection_string
is required. - key
Vault LinkedPassword Service Sql Server Key Vault Password - 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.
- user
Name string - The on-premises Windows authentication user name.
- data_
factory_ strid - 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
orkey_vault_connection_string
is required. - description str
- The description for the Data Factory Linked Service SQL Server.
- integration_
runtime_ strname - The integration runtime reference to associate with the Data Factory Linked Service SQL Server.
- key_
vault_ Linkedconnection_ string Service Sql Server Key Vault Connection String Args - 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 eitherconnection_string
orkey_vault_connection_string
is required. - key_
vault_ Linkedpassword Service Sql Server Key Vault Password Args - 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.
- data
Factory StringId - The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- additional
Properties 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.
- connection
String String - The connection string in which to authenticate with the SQL Server. Exactly one of either
connection_string
orkey_vault_connection_string
is required. - description String
- The description for the Data Factory Linked Service SQL Server.
- integration
Runtime StringName - The integration runtime reference to associate with the Data Factory Linked Service SQL Server.
- key
Vault Property MapConnection String - 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 eitherconnection_string
orkey_vault_connection_string
is required. - key
Vault Property MapPassword - 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.
- user
Name 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.
- Additional
Properties 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.
- Connection
String string - The connection string in which to authenticate with the SQL Server. Exactly one of either
connection_string
orkey_vault_connection_string
is required. - Data
Factory stringId - 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.
- Integration
Runtime stringName - The integration runtime reference to associate with the Data Factory Linked Service SQL Server.
- Key
Vault LinkedConnection String Service Sql Server Key Vault Connection String - 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 eitherconnection_string
orkey_vault_connection_string
is required. - Key
Vault LinkedPassword Service Sql Server Key Vault Password - 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.
- User
Name string - The on-premises Windows authentication user name.
- Additional
Properties 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.
- Connection
String string - The connection string in which to authenticate with the SQL Server. Exactly one of either
connection_string
orkey_vault_connection_string
is required. - Data
Factory stringId - 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.
- Integration
Runtime stringName - The integration runtime reference to associate with the Data Factory Linked Service SQL Server.
- Key
Vault LinkedConnection String Service Sql Server Key Vault Connection String Args - 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 eitherconnection_string
orkey_vault_connection_string
is required. - Key
Vault LinkedPassword Service Sql Server Key Vault Password Args - 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.
- User
Name string - The on-premises Windows authentication user name.
- additional
Properties 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.
- connection
String String - The connection string in which to authenticate with the SQL Server. Exactly one of either
connection_string
orkey_vault_connection_string
is required. - data
Factory StringId - 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.
- integration
Runtime StringName - The integration runtime reference to associate with the Data Factory Linked Service SQL Server.
- key
Vault LinkedConnection String Service Sql Server Key Vault Connection String - 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 eitherconnection_string
orkey_vault_connection_string
is required. - key
Vault LinkedPassword Service Sql Server Key Vault Password - 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.
- user
Name String - The on-premises Windows authentication user name.
- additional
Properties {[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.
- connection
String string - The connection string in which to authenticate with the SQL Server. Exactly one of either
connection_string
orkey_vault_connection_string
is required. - data
Factory stringId - 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.
- integration
Runtime stringName - The integration runtime reference to associate with the Data Factory Linked Service SQL Server.
- key
Vault LinkedConnection String Service Sql Server Key Vault Connection String - 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 eitherconnection_string
orkey_vault_connection_string
is required. - key
Vault LinkedPassword Service Sql Server Key Vault Password - 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.
- user
Name 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
orkey_vault_connection_string
is required. - data_
factory_ strid - 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_ strname - The integration runtime reference to associate with the Data Factory Linked Service SQL Server.
- key_
vault_ Linkedconnection_ string Service Sql Server Key Vault Connection String Args - 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 eitherconnection_string
orkey_vault_connection_string
is required. - key_
vault_ Linkedpassword Service Sql Server Key Vault Password Args - 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.
- additional
Properties 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.
- connection
String String - The connection string in which to authenticate with the SQL Server. Exactly one of either
connection_string
orkey_vault_connection_string
is required. - data
Factory StringId - 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.
- integration
Runtime StringName - The integration runtime reference to associate with the Data Factory Linked Service SQL Server.
- key
Vault Property MapConnection String - 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 eitherconnection_string
orkey_vault_connection_string
is required. - key
Vault Property MapPassword - 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.
- user
Name String - The on-premises Windows authentication user name.
Supporting Types
LinkedServiceSqlServerKeyVaultConnectionString, LinkedServiceSqlServerKeyVaultConnectionStringArgs
- Linked
Service stringName - Specifies the name of an existing Key Vault Data Factory Linked Service.
- Secret
Name string - Specifies the secret name in Azure Key Vault that stores SQL Server connection string.
- Linked
Service stringName - Specifies the name of an existing Key Vault Data Factory Linked Service.
- Secret
Name string - Specifies the secret name in Azure Key Vault that stores SQL Server connection string.
- linked
Service StringName - Specifies the name of an existing Key Vault Data Factory Linked Service.
- secret
Name String - Specifies the secret name in Azure Key Vault that stores SQL Server connection string.
- linked
Service stringName - Specifies the name of an existing Key Vault Data Factory Linked Service.
- secret
Name string - Specifies the secret name in Azure Key Vault that stores SQL Server connection string.
- linked_
service_ strname - 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.
- linked
Service StringName - Specifies the name of an existing Key Vault Data Factory Linked Service.
- secret
Name String - Specifies the secret name in Azure Key Vault that stores SQL Server connection string.
LinkedServiceSqlServerKeyVaultPassword, LinkedServiceSqlServerKeyVaultPasswordArgs
- Linked
Service stringName - Specifies the name of an existing Key Vault Data Factory Linked Service.
- Secret
Name string - Specifies the secret name in Azure Key Vault that stores SQL Server password.
- Linked
Service stringName - Specifies the name of an existing Key Vault Data Factory Linked Service.
- Secret
Name string - Specifies the secret name in Azure Key Vault that stores SQL Server password.
- linked
Service StringName - Specifies the name of an existing Key Vault Data Factory Linked Service.
- secret
Name String - Specifies the secret name in Azure Key Vault that stores SQL Server password.
- linked
Service stringName - Specifies the name of an existing Key Vault Data Factory Linked Service.
- secret
Name string - Specifies the secret name in Azure Key Vault that stores SQL Server password.
- linked_
service_ strname - 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.
- linked
Service StringName - Specifies the name of an existing Key Vault Data Factory Linked Service.
- secret
Name 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
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.