pulumi-azure-kotlin/com.pulumi.azure.datafactory.kotlin/LinkedServiceAzureSqlDatabase

LinkedServiceAzureSqlDatabase

class LinkedServiceAzureSqlDatabase : KotlinCustomResource

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

Example Usage

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

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

Properties

additionalProperties

val additionalProperties: Output<Map<String, String>>?

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

annotations

val annotations: Output<List<String>>?

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

connectionString

val connectionString: Output<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

val dataFactoryId: Output<String>

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

description

val description: Output<String>?

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

val id: Output<String>

integrationRuntimeName

val integrationRuntimeName: Output<String>?

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

keyVaultConnectionString

val keyVaultConnectionString: Output<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

val keyVaultPassword: Output<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

val name: Output<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

val parameters: Output<Map<String, String>>?

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

servicePrincipalId

val servicePrincipalId: Output<String>?

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

servicePrincipalKey

val servicePrincipalKey: Output<String>?

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

tenantId

val tenantId: Output<String>?

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

urn

val urn: Output<String>

useManagedIdentity

val useManagedIdentity: Output<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