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

We recommend using Azure Native.

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

azure.datafactory.LinkedServiceAzureSqlDatabase

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

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

    Manages a Linked Service (connection) between Azure SQL Database 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 exampleLinkedServiceAzureSqlDatabase = new azure.datafactory.LinkedServiceAzureSqlDatabase("example", {
        name: "example",
        dataFactoryId: exampleFactory.id,
        connectionString: "data source=serverhostname;initial catalog=master;user id=testUser;Password=test;integrated security=False;encrypt=True;connection timeout=30",
    });
    
    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_azure_sql_database = azure.datafactory.LinkedServiceAzureSqlDatabase("example",
        name="example",
        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")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
    			Name:              pulumi.String("example"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datafactory.NewLinkedServiceAzureSqlDatabase(ctx, "example", &datafactory.LinkedServiceAzureSqlDatabaseArgs{
    			Name:             pulumi.String("example"),
    			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
    	})
    }
    
    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 exampleLinkedServiceAzureSqlDatabase = new Azure.DataFactory.LinkedServiceAzureSqlDatabase("example", new()
        {
            Name = "example",
            DataFactoryId = exampleFactory.Id,
            ConnectionString = "data source=serverhostname;initial catalog=master;user id=testUser;Password=test;integrated security=False;encrypt=True;connection timeout=30",
        });
    
    });
    
    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 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 exampleLinkedServiceAzureSqlDatabase = new LinkedServiceAzureSqlDatabase("exampleLinkedServiceAzureSqlDatabase", LinkedServiceAzureSqlDatabaseArgs.builder()
                .name("example")
                .dataFactoryId(exampleFactory.id())
                .connectionString("data source=serverhostname;initial catalog=master;user id=testUser;Password=test;integrated security=False;encrypt=True;connection timeout=30")
                .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}
      exampleLinkedServiceAzureSqlDatabase:
        type: azure:datafactory:LinkedServiceAzureSqlDatabase
        name: example
        properties:
          name: example
          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

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

    Constructor syntax

    new LinkedServiceAzureSqlDatabase(name: string, args: LinkedServiceAzureSqlDatabaseArgs, opts?: CustomResourceOptions);
    @overload
    def LinkedServiceAzureSqlDatabase(resource_name: str,
                                      args: LinkedServiceAzureSqlDatabaseArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def LinkedServiceAzureSqlDatabase(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      data_factory_id: Optional[str] = None,
                                      key_vault_connection_string: Optional[LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs] = None,
                                      connection_string: Optional[str] = None,
                                      annotations: Optional[Sequence[str]] = None,
                                      description: Optional[str] = None,
                                      integration_runtime_name: Optional[str] = None,
                                      additional_properties: Optional[Mapping[str, str]] = 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)
    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.
    
    

    Parameters

    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.

    Constructor example

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

    var linkedServiceAzureSqlDatabaseResource = new Azure.DataFactory.LinkedServiceAzureSqlDatabase("linkedServiceAzureSqlDatabaseResource", new()
    {
        DataFactoryId = "string",
        KeyVaultConnectionString = new Azure.DataFactory.Inputs.LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs
        {
            LinkedServiceName = "string",
            SecretName = "string",
        },
        ConnectionString = "string",
        Annotations = new[]
        {
            "string",
        },
        Description = "string",
        IntegrationRuntimeName = "string",
        AdditionalProperties = 
        {
            { "string", "string" },
        },
        KeyVaultPassword = new Azure.DataFactory.Inputs.LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs
        {
            LinkedServiceName = "string",
            SecretName = "string",
        },
        Name = "string",
        Parameters = 
        {
            { "string", "string" },
        },
        ServicePrincipalId = "string",
        ServicePrincipalKey = "string",
        TenantId = "string",
        UseManagedIdentity = false,
    });
    
    example, err := datafactory.NewLinkedServiceAzureSqlDatabase(ctx, "linkedServiceAzureSqlDatabaseResource", &datafactory.LinkedServiceAzureSqlDatabaseArgs{
    	DataFactoryId: pulumi.String("string"),
    	KeyVaultConnectionString: &datafactory.LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs{
    		LinkedServiceName: pulumi.String("string"),
    		SecretName:        pulumi.String("string"),
    	},
    	ConnectionString: pulumi.String("string"),
    	Annotations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description:            pulumi.String("string"),
    	IntegrationRuntimeName: pulumi.String("string"),
    	AdditionalProperties: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	KeyVaultPassword: &datafactory.LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs{
    		LinkedServiceName: pulumi.String("string"),
    		SecretName:        pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Parameters: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	ServicePrincipalId:  pulumi.String("string"),
    	ServicePrincipalKey: pulumi.String("string"),
    	TenantId:            pulumi.String("string"),
    	UseManagedIdentity:  pulumi.Bool(false),
    })
    
    var linkedServiceAzureSqlDatabaseResource = new LinkedServiceAzureSqlDatabase("linkedServiceAzureSqlDatabaseResource", LinkedServiceAzureSqlDatabaseArgs.builder()
        .dataFactoryId("string")
        .keyVaultConnectionString(LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs.builder()
            .linkedServiceName("string")
            .secretName("string")
            .build())
        .connectionString("string")
        .annotations("string")
        .description("string")
        .integrationRuntimeName("string")
        .additionalProperties(Map.of("string", "string"))
        .keyVaultPassword(LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs.builder()
            .linkedServiceName("string")
            .secretName("string")
            .build())
        .name("string")
        .parameters(Map.of("string", "string"))
        .servicePrincipalId("string")
        .servicePrincipalKey("string")
        .tenantId("string")
        .useManagedIdentity(false)
        .build());
    
    linked_service_azure_sql_database_resource = azure.datafactory.LinkedServiceAzureSqlDatabase("linkedServiceAzureSqlDatabaseResource",
        data_factory_id="string",
        key_vault_connection_string={
            "linkedServiceName": "string",
            "secretName": "string",
        },
        connection_string="string",
        annotations=["string"],
        description="string",
        integration_runtime_name="string",
        additional_properties={
            "string": "string",
        },
        key_vault_password={
            "linkedServiceName": "string",
            "secretName": "string",
        },
        name="string",
        parameters={
            "string": "string",
        },
        service_principal_id="string",
        service_principal_key="string",
        tenant_id="string",
        use_managed_identity=False)
    
    const linkedServiceAzureSqlDatabaseResource = new azure.datafactory.LinkedServiceAzureSqlDatabase("linkedServiceAzureSqlDatabaseResource", {
        dataFactoryId: "string",
        keyVaultConnectionString: {
            linkedServiceName: "string",
            secretName: "string",
        },
        connectionString: "string",
        annotations: ["string"],
        description: "string",
        integrationRuntimeName: "string",
        additionalProperties: {
            string: "string",
        },
        keyVaultPassword: {
            linkedServiceName: "string",
            secretName: "string",
        },
        name: "string",
        parameters: {
            string: "string",
        },
        servicePrincipalId: "string",
        servicePrincipalKey: "string",
        tenantId: "string",
        useManagedIdentity: false,
    });
    
    type: azure:datafactory:LinkedServiceAzureSqlDatabase
    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
        servicePrincipalId: string
        servicePrincipalKey: string
        tenantId: string
        useManagedIdentity: false
    

    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 LinkedServiceAzureSqlDatabaseKeyVaultConnectionString
    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 LinkedServiceAzureSqlDatabaseKeyVaultPassword
    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 LinkedServiceAzureSqlDatabaseKeyVaultConnectionString
    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 LinkedServiceAzureSqlDatabaseKeyVaultPassword
    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 LinkedServiceAzureSqlDatabaseKeyVaultConnectionString
    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 LinkedServiceAzureSqlDatabaseKeyVaultPassword
    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 LinkedServiceAzureSqlDatabaseKeyVaultConnectionString
    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 LinkedServiceAzureSqlDatabaseKeyVaultPassword
    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 LinkedServiceAzureSqlDatabaseKeyVaultConnectionString
    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 LinkedServiceAzureSqlDatabaseKeyVaultPassword
    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 LinkedServiceAzureSqlDatabaseKeyVaultConnectionString
    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 LinkedServiceAzureSqlDatabaseKeyVaultPassword
    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, LinkedServiceAzureSqlDatabaseKeyVaultConnectionStringArgs

    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, LinkedServiceAzureSqlDatabaseKeyVaultPasswordArgs

    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
    

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

    Package Details

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

    We recommend using Azure Native.

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