Azure Classic

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

LinkedServiceAzureSqlDatabase

Manages a Linked Service (connection) between Azure SQL Database 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 exampleLinkedServiceAzureSqlDatabase = new Azure.DataFactory.LinkedServiceAzureSqlDatabase("exampleLinkedServiceAzureSqlDatabase", new()
    {
        DataFactoryId = exampleFactory.Id,
        ConnectionString = "data source=serverhostname;initial catalog=master;user id=testUser;Password=test;integrated security=False;encrypt=True;connection timeout=30",
    });

});
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.NewLinkedServiceAzureSqlDatabase(ctx, "exampleLinkedServiceAzureSqlDatabase", &datafactory.LinkedServiceAzureSqlDatabaseArgs{
			DataFactoryId:    exampleFactory.ID(),
			ConnectionString: pulumi.String("data source=serverhostname;initial catalog=master;user id=testUser;Password=test;integrated security=False;encrypt=True;connection timeout=30"),
		})
		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.LinkedServiceAzureSqlDatabase;
import com.pulumi.azure.datafactory.LinkedServiceAzureSqlDatabaseArgs;
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 exampleLinkedServiceAzureSqlDatabase = new LinkedServiceAzureSqlDatabase("exampleLinkedServiceAzureSqlDatabase", LinkedServiceAzureSqlDatabaseArgs.builder()        
            .dataFactoryId(exampleFactory.id())
            .connectionString("data source=serverhostname;initial catalog=master;user id=testUser;Password=test;integrated security=False;encrypt=True;connection timeout=30")
            .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_azure_sql_database = azure.datafactory.LinkedServiceAzureSqlDatabase("exampleLinkedServiceAzureSqlDatabase",
    data_factory_id=example_factory.id,
    connection_string="data source=serverhostname;initial catalog=master;user id=testUser;Password=test;integrated security=False;encrypt=True;connection timeout=30")
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 exampleLinkedServiceAzureSqlDatabase = new azure.datafactory.LinkedServiceAzureSqlDatabase("exampleLinkedServiceAzureSqlDatabase", {
    dataFactoryId: exampleFactory.id,
    connectionString: "data source=serverhostname;initial catalog=master;user id=testUser;Password=test;integrated security=False;encrypt=True;connection timeout=30",
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleLinkedServiceAzureSqlDatabase:
    type: azure:datafactory:LinkedServiceAzureSqlDatabase
    properties:
      dataFactoryId: ${exampleFactory.id}
      connectionString: data source=serverhostname;initial catalog=master;user id=testUser;Password=test;integrated security=False;encrypt=True;connection timeout=30

Create LinkedServiceAzureSqlDatabase Resource

new LinkedServiceAzureSqlDatabase(name: string, args: LinkedServiceAzureSqlDatabaseArgs, opts?: CustomResourceOptions);
@overload
def LinkedServiceAzureSqlDatabase(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[LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs] = None,
                                  key_vault_password: Optional[LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs] = None,
                                  name: Optional[str] = None,
                                  parameters: Optional[Mapping[str, str]] = None,
                                  service_principal_id: Optional[str] = None,
                                  service_principal_key: Optional[str] = None,
                                  tenant_id: Optional[str] = None,
                                  use_managed_identity: Optional[bool] = None)
@overload
def LinkedServiceAzureSqlDatabase(resource_name: str,
                                  args: LinkedServiceAzureSqlDatabaseArgs,
                                  opts: Optional[ResourceOptions] = None)
func NewLinkedServiceAzureSqlDatabase(ctx *Context, name string, args LinkedServiceAzureSqlDatabaseArgs, opts ...ResourceOption) (*LinkedServiceAzureSqlDatabase, error)
public LinkedServiceAzureSqlDatabase(string name, LinkedServiceAzureSqlDatabaseArgs args, CustomResourceOptions? opts = null)
public LinkedServiceAzureSqlDatabase(String name, LinkedServiceAzureSqlDatabaseArgs args)
public LinkedServiceAzureSqlDatabase(String name, LinkedServiceAzureSqlDatabaseArgs args, CustomResourceOptions options)
type: azure:datafactory:LinkedServiceAzureSqlDatabase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

LinkedServiceAzureSqlDatabase 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 LinkedServiceAzureSqlDatabase 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 Azure SQL Database.

Annotations List<string>

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

ConnectionString string

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

Description string

The description for the Data Factory Linked Service Azure SQL Database.

IntegrationRuntimeName string

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

KeyVaultConnectionString LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store Azure SQL Database 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 LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs

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 Azure SQL Database. 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 Azure SQL Database.

ServicePrincipalId string

The service principal id in which to authenticate against the Azure SQL Database. Required if service_principal_key is set.

ServicePrincipalKey string

The service principal key in which to authenticate against the Azure SQL Database. Required if service_principal_id is set.

TenantId string

The tenant id or name in which to authenticate against the Azure SQL Database.

UseManagedIdentity bool

Whether to use the Data Factory's managed identity to authenticate against the Azure SQL Database. Incompatible with service_principal_id and service_principal_key

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 Azure SQL Database.

Annotations []string

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

ConnectionString string

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

Description string

The description for the Data Factory Linked Service Azure SQL Database.

IntegrationRuntimeName string

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

KeyVaultConnectionString LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store Azure SQL Database 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 LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs

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 Azure SQL Database. 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 Azure SQL Database.

ServicePrincipalId string

The service principal id in which to authenticate against the Azure SQL Database. Required if service_principal_key is set.

ServicePrincipalKey string

The service principal key in which to authenticate against the Azure SQL Database. Required if service_principal_id is set.

TenantId string

The tenant id or name in which to authenticate against the Azure SQL Database.

UseManagedIdentity bool

Whether to use the Data Factory's managed identity to authenticate against the Azure SQL Database. Incompatible with service_principal_id and service_principal_key

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 Azure SQL Database.

annotations List<String>

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

connectionString String

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

description String

The description for the Data Factory Linked Service Azure SQL Database.

integrationRuntimeName String

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

keyVaultConnectionString LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store Azure SQL Database 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 LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs

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 Azure SQL Database. 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 Azure SQL Database.

servicePrincipalId String

The service principal id in which to authenticate against the Azure SQL Database. Required if service_principal_key is set.

servicePrincipalKey String

The service principal key in which to authenticate against the Azure SQL Database. Required if service_principal_id is set.

tenantId String

The tenant id or name in which to authenticate against the Azure SQL Database.

useManagedIdentity Boolean

Whether to use the Data Factory's managed identity to authenticate against the Azure SQL Database. Incompatible with service_principal_id and service_principal_key

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 Azure SQL Database.

annotations string[]

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

connectionString string

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

description string

The description for the Data Factory Linked Service Azure SQL Database.

integrationRuntimeName string

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

keyVaultConnectionString LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store Azure SQL Database 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 LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs

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 Azure SQL Database. 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 Azure SQL Database.

servicePrincipalId string

The service principal id in which to authenticate against the Azure SQL Database. Required if service_principal_key is set.

servicePrincipalKey string

The service principal key in which to authenticate against the Azure SQL Database. Required if service_principal_id is set.

tenantId string

The tenant id or name in which to authenticate against the Azure SQL Database.

useManagedIdentity boolean

Whether to use the Data Factory's managed identity to authenticate against the Azure SQL Database. Incompatible with service_principal_id and service_principal_key

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 Azure SQL Database.

annotations Sequence[str]

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

connection_string str

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

description str

The description for the Data Factory Linked Service Azure SQL Database.

integration_runtime_name str

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

key_vault_connection_string LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store Azure SQL Database 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 LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs

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 Azure SQL Database. 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 Azure SQL Database.

service_principal_id str

The service principal id in which to authenticate against the Azure SQL Database. Required if service_principal_key is set.

service_principal_key str

The service principal key in which to authenticate against the Azure SQL Database. Required if service_principal_id is set.

tenant_id str

The tenant id or name in which to authenticate against the Azure SQL Database.

use_managed_identity bool

Whether to use the Data Factory's managed identity to authenticate against the Azure SQL Database. Incompatible with service_principal_id and service_principal_key

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 Azure SQL Database.

annotations List<String>

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

connectionString String

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

description String

The description for the Data Factory Linked Service Azure SQL Database.

integrationRuntimeName String

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

keyVaultConnectionString Property Map

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

servicePrincipalId String

The service principal id in which to authenticate against the Azure SQL Database. Required if service_principal_key is set.

servicePrincipalKey String

The service principal key in which to authenticate against the Azure SQL Database. Required if service_principal_id is set.

tenantId String

The tenant id or name in which to authenticate against the Azure SQL Database.

useManagedIdentity Boolean

Whether to use the Data Factory's managed identity to authenticate against the Azure SQL Database. Incompatible with service_principal_id and service_principal_key

Outputs

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

Get an existing LinkedServiceAzureSqlDatabase 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?: LinkedServiceAzureSqlDatabaseState, opts?: CustomResourceOptions): LinkedServiceAzureSqlDatabase
@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[LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs] = None,
        key_vault_password: Optional[LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        service_principal_id: Optional[str] = None,
        service_principal_key: Optional[str] = None,
        tenant_id: Optional[str] = None,
        use_managed_identity: Optional[bool] = None) -> LinkedServiceAzureSqlDatabase
func GetLinkedServiceAzureSqlDatabase(ctx *Context, name string, id IDInput, state *LinkedServiceAzureSqlDatabaseState, opts ...ResourceOption) (*LinkedServiceAzureSqlDatabase, error)
public static LinkedServiceAzureSqlDatabase Get(string name, Input<string> id, LinkedServiceAzureSqlDatabaseState? state, CustomResourceOptions? opts = null)
public static LinkedServiceAzureSqlDatabase get(String name, Output<String> id, LinkedServiceAzureSqlDatabaseState 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 Azure SQL Database.

Annotations List<string>

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

ConnectionString string

The connection string in which to authenticate with Azure SQL Database. 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 Azure SQL Database.

IntegrationRuntimeName string

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

KeyVaultConnectionString LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store Azure SQL Database 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 LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs

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 Azure SQL Database. 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 Azure SQL Database.

ServicePrincipalId string

The service principal id in which to authenticate against the Azure SQL Database. Required if service_principal_key is set.

ServicePrincipalKey string

The service principal key in which to authenticate against the Azure SQL Database. Required if service_principal_id is set.

TenantId string

The tenant id or name in which to authenticate against the Azure SQL Database.

UseManagedIdentity bool

Whether to use the Data Factory's managed identity to authenticate against the Azure SQL Database. Incompatible with service_principal_id and service_principal_key

AdditionalProperties map[string]string

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

Annotations []string

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

ConnectionString string

The connection string in which to authenticate with Azure SQL Database. 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 Azure SQL Database.

IntegrationRuntimeName string

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

KeyVaultConnectionString LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store Azure SQL Database 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 LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs

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 Azure SQL Database. 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 Azure SQL Database.

ServicePrincipalId string

The service principal id in which to authenticate against the Azure SQL Database. Required if service_principal_key is set.

ServicePrincipalKey string

The service principal key in which to authenticate against the Azure SQL Database. Required if service_principal_id is set.

TenantId string

The tenant id or name in which to authenticate against the Azure SQL Database.

UseManagedIdentity bool

Whether to use the Data Factory's managed identity to authenticate against the Azure SQL Database. Incompatible with service_principal_id and service_principal_key

additionalProperties Map<String,String>

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

annotations List<String>

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

connectionString String

The connection string in which to authenticate with Azure SQL Database. 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 Azure SQL Database.

integrationRuntimeName String

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

keyVaultConnectionString LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store Azure SQL Database 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 LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs

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 Azure SQL Database. 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 Azure SQL Database.

servicePrincipalId String

The service principal id in which to authenticate against the Azure SQL Database. Required if service_principal_key is set.

servicePrincipalKey String

The service principal key in which to authenticate against the Azure SQL Database. Required if service_principal_id is set.

tenantId String

The tenant id or name in which to authenticate against the Azure SQL Database.

useManagedIdentity Boolean

Whether to use the Data Factory's managed identity to authenticate against the Azure SQL Database. Incompatible with service_principal_id and service_principal_key

additionalProperties {[key: string]: string}

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

annotations string[]

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

connectionString string

The connection string in which to authenticate with Azure SQL Database. 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 Azure SQL Database.

integrationRuntimeName string

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

keyVaultConnectionString LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store Azure SQL Database 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 LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs

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 Azure SQL Database. 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 Azure SQL Database.

servicePrincipalId string

The service principal id in which to authenticate against the Azure SQL Database. Required if service_principal_key is set.

servicePrincipalKey string

The service principal key in which to authenticate against the Azure SQL Database. Required if service_principal_id is set.

tenantId string

The tenant id or name in which to authenticate against the Azure SQL Database.

useManagedIdentity boolean

Whether to use the Data Factory's managed identity to authenticate against the Azure SQL Database. Incompatible with service_principal_id and service_principal_key

additional_properties Mapping[str, str]

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

annotations Sequence[str]

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

connection_string str

The connection string in which to authenticate with Azure SQL Database. 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 Azure SQL Database.

integration_runtime_name str

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

key_vault_connection_string LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs

A key_vault_connection_string block as defined below. Use this argument to store Azure SQL Database 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 LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs

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 Azure SQL Database. 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 Azure SQL Database.

service_principal_id str

The service principal id in which to authenticate against the Azure SQL Database. Required if service_principal_key is set.

service_principal_key str

The service principal key in which to authenticate against the Azure SQL Database. Required if service_principal_id is set.

tenant_id str

The tenant id or name in which to authenticate against the Azure SQL Database.

use_managed_identity bool

Whether to use the Data Factory's managed identity to authenticate against the Azure SQL Database. Incompatible with service_principal_id and service_principal_key

additionalProperties Map<String>

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

annotations List<String>

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

connectionString String

The connection string in which to authenticate with Azure SQL Database. 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 Azure SQL Database.

integrationRuntimeName String

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

keyVaultConnectionString Property Map

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

servicePrincipalId String

The service principal id in which to authenticate against the Azure SQL Database. Required if service_principal_key is set.

servicePrincipalKey String

The service principal key in which to authenticate against the Azure SQL Database. Required if service_principal_id is set.

tenantId String

The tenant id or name in which to authenticate against the Azure SQL Database.

useManagedIdentity Boolean

Whether to use the Data Factory's managed identity to authenticate against the Azure SQL Database. Incompatible with service_principal_id and service_principal_key

Supporting Types

LinkedServiceAzureSqlDatabaseKeyVaultConnectionString

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.

LinkedServiceAzureSqlDatabaseKeyVaultPassword

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 Azure SQL Database Linked Service’s can be imported using the resource id, e.g.

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