LinkedServiceArgs

data class LinkedServiceArgs(val additionalProperties: Output<Map<String, String>>? = null, val annotations: Output<List<String>>? = null, val description: Output<String>? = null, val integrationRuntime: Output<LinkedServiceIntegrationRuntimeArgs>? = null, val name: Output<String>? = null, val parameters: Output<Map<String, String>>? = null, val synapseWorkspaceId: Output<String>? = null, val type: Output<String>? = null, val typePropertiesJson: Output<String>? = null) : ConvertibleToJava<LinkedServiceArgs>

Manages a Synapse Linked Service.

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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.DataLakeGen2Filesystem;
import com.pulumi.azure.storage.DataLakeGen2FilesystemArgs;
import com.pulumi.azure.synapse.Workspace;
import com.pulumi.azure.synapse.WorkspaceArgs;
import com.pulumi.azure.synapse.inputs.WorkspaceIdentityArgs;
import com.pulumi.azure.synapse.FirewallRule;
import com.pulumi.azure.synapse.FirewallRuleArgs;
import com.pulumi.azure.synapse.IntegrationRuntimeAzure;
import com.pulumi.azure.synapse.IntegrationRuntimeAzureArgs;
import com.pulumi.azure.synapse.LinkedService;
import com.pulumi.azure.synapse.LinkedServiceArgs;
import com.pulumi.azure.synapse.inputs.LinkedServiceIntegrationRuntimeArgs;
import com.pulumi.resources.CustomResourceOptions;
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 exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.location(exampleResourceGroup.location())
.accountKind("BlobStorage")
.accountTier("Standard")
.accountReplicationType("LRS")
.build());
var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()
.storageAccountId(exampleAccount.id())
.build());
var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.location(exampleResourceGroup.location())
.storageDataLakeGen2FilesystemId(exampleDataLakeGen2Filesystem.id())
.sqlAdministratorLogin("sqladminuser")
.sqlAdministratorLoginPassword("H@Sh1CoR3!")
.managedVirtualNetworkEnabled(true)
.identity(WorkspaceIdentityArgs.builder()
.type("SystemAssigned")
.build())
.build());
var exampleFirewallRule = new FirewallRule("exampleFirewallRule", FirewallRuleArgs.builder()
.synapseWorkspaceId(exampleWorkspace.id())
.startIpAddress("0.0.0.0")
.endIpAddress("255.255.255.255")
.build());
var exampleIntegrationRuntimeAzure = new IntegrationRuntimeAzure("exampleIntegrationRuntimeAzure", IntegrationRuntimeAzureArgs.builder()
.synapseWorkspaceId(exampleWorkspace.id())
.location(exampleResourceGroup.location())
.build());
var exampleLinkedService = new LinkedService("exampleLinkedService", LinkedServiceArgs.builder()
.synapseWorkspaceId(exampleWorkspace.id())
.type("AzureBlobStorage")
.typePropertiesJson(exampleAccount.primaryConnectionString().applyValue(primaryConnectionString -> """
{
"connectionString": "%s"
}
", primaryConnectionString)))
.integrationRuntime(LinkedServiceIntegrationRuntimeArgs.builder()
.name(exampleIntegrationRuntimeAzure.name())
.build())
.build(), CustomResourceOptions.builder()
.dependsOn(exampleFirewallRule)
.build());
}
}

Import

Synapse Linked Services can be imported using the resource id, e.g.

$ pulumi import azure:synapse/linkedService:LinkedService example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.Synapse/workspaces/workspace1/linkedServices/linkedservice1

Constructors

Link copied to clipboard
fun LinkedServiceArgs(additionalProperties: Output<Map<String, String>>? = null, annotations: Output<List<String>>? = null, description: Output<String>? = null, integrationRuntime: Output<LinkedServiceIntegrationRuntimeArgs>? = null, name: Output<String>? = null, parameters: Output<Map<String, String>>? = null, synapseWorkspaceId: Output<String>? = null, type: Output<String>? = null, typePropertiesJson: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): LinkedServiceArgs

Properties

Link copied to clipboard
val additionalProperties: Output<Map<String, String>>? = null

A map of additional properties to associate with the Synapse Linked Service.

Link copied to clipboard
val annotations: Output<List<String>>? = null

List of tags that can be used for describing the Synapse Linked Service.

Link copied to clipboard
val description: Output<String>? = null

The description for the Synapse Linked Service.

Link copied to clipboard

A integration_runtime block as defined below.

Link copied to clipboard
val name: Output<String>? = null

The name which should be used for this Synapse Linked Service. Changing this forces a new Synapse Linked Service to be created.

Link copied to clipboard
val parameters: Output<Map<String, String>>? = null

A map of parameters to associate with the Synapse Linked Service.

Link copied to clipboard
val synapseWorkspaceId: Output<String>? = null

The Synapse Workspace ID in which to associate the Linked Service with. Changing this forces a new Synapse Linked Service to be created.

Link copied to clipboard
val type: Output<String>? = null

The type of data stores that will be connected to Synapse. Valid Values include AmazonMWS, AmazonRdsForOracle, AmazonRdsForSqlServer, AmazonRedshift, AmazonS3, AzureBatch. Changing this forces a new resource to be created. AzureBlobFS, AzureBlobStorage, AzureDataExplorer, AzureDataLakeAnalytics, AzureDataLakeStore, AzureDatabricks, AzureDatabricksDeltaLake, AzureFileStorage, AzureFunction, AzureKeyVault, AzureML, AzureMLService, AzureMariaDB, AzureMySql, AzurePostgreSql, AzureSqlDW, AzureSqlDatabase, AzureSqlMI, AzureSearch, AzureStorage, AzureTableStorage, Cassandra, CommonDataServiceForApps, Concur, CosmosDb, CosmosDbMongoDbApi, Couchbase, CustomDataSource, Db2, Drill, Dynamics, DynamicsAX, DynamicsCrm, Eloqua, FileServer, FtpServer, GoogleAdWords, GoogleBigQuery, GoogleCloudStorage, Greenplum, HBase, HDInsight, HDInsightOnDemand, HttpServer, Hdfs, Hive, Hubspot, Impala, Informix, Jira, LinkedService, Magento, MariaDB, Marketo, MicrosoftAccess, MongoDb, MongoDbAtlas, MongoDbV2, MySql, Netezza, OData, Odbc, Office365, Oracle, OracleServiceCloud, Paypal, Phoenix, PostgreSql, Presto, QuickBooks, Responsys, RestService, SqlServer, Salesforce, SalesforceMarketingCloud, SalesforceServiceCloud, SapBW, SapCloudForCustomer, SapEcc, SapHana, SapOpenHub, SapTable, ServiceNow, Sftp, SharePointOnlineList, Shopify, Snowflake, Spark, Square, Sybase, Teradata, Vertica, Web, Xero, Zoho.

Link copied to clipboard
val typePropertiesJson: Output<String>? = null

A JSON object that contains the properties of the Synapse Linked Service.