com.pulumi.azure.synapse.kotlin.LinkedService.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.synapse.kotlin
import com.pulumi.azure.synapse.kotlin.outputs.LinkedServiceIntegrationRuntime
import com.pulumi.azure.synapse.kotlin.outputs.LinkedServiceIntegrationRuntime.Companion.toKotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Builder for [LinkedService].
*/
@PulumiTagMarker
public class LinkedServiceResourceBuilder internal constructor() {
public var name: String? = null
public var args: LinkedServiceArgs = LinkedServiceArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend LinkedServiceArgsBuilder.() -> Unit) {
val builder = LinkedServiceArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): LinkedService {
val builtJavaResource = com.pulumi.azure.synapse.LinkedService(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return LinkedService(builtJavaResource)
}
}
/**
* Manages a Synapse Linked Service.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "example",
* location: "West Europe",
* });
* const exampleAccount = new azure.storage.Account("example", {
* name: "example",
* resourceGroupName: example.name,
* location: example.location,
* accountKind: "BlobStorage",
* accountTier: "Standard",
* accountReplicationType: "LRS",
* });
* const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("example", {
* name: "example",
* storageAccountId: exampleAccount.id,
* });
* const exampleWorkspace = new azure.synapse.Workspace("example", {
* name: "example",
* resourceGroupName: example.name,
* location: example.location,
* storageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.id,
* sqlAdministratorLogin: "sqladminuser",
* sqlAdministratorLoginPassword: "H@Sh1CoR3!",
* managedVirtualNetworkEnabled: true,
* identity: {
* type: "SystemAssigned",
* },
* });
* const exampleFirewallRule = new azure.synapse.FirewallRule("example", {
* name: "allowAll",
* synapseWorkspaceId: exampleWorkspace.id,
* startIpAddress: "0.0.0.0",
* endIpAddress: "255.255.255.255",
* });
* const exampleIntegrationRuntimeAzure = new azure.synapse.IntegrationRuntimeAzure("example", {
* name: "example",
* synapseWorkspaceId: exampleWorkspace.id,
* location: example.location,
* });
* const exampleLinkedService = new azure.synapse.LinkedService("example", {
* name: "example",
* synapseWorkspaceId: exampleWorkspace.id,
* type: "AzureBlobStorage",
* typePropertiesJson: pulumi.interpolate`{
* "connectionString": "${exampleAccount.primaryConnectionString}"
* }
* `,
* integrationRuntime: {
* name: exampleIntegrationRuntimeAzure.name,
* },
* }, {
* dependsOn: [exampleFirewallRule],
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example",
* location="West Europe")
* example_account = azure.storage.Account("example",
* name="example",
* resource_group_name=example.name,
* location=example.location,
* account_kind="BlobStorage",
* account_tier="Standard",
* account_replication_type="LRS")
* example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("example",
* name="example",
* storage_account_id=example_account.id)
* example_workspace = azure.synapse.Workspace("example",
* name="example",
* resource_group_name=example.name,
* location=example.location,
* storage_data_lake_gen2_filesystem_id=example_data_lake_gen2_filesystem.id,
* sql_administrator_login="sqladminuser",
* sql_administrator_login_password="H@Sh1CoR3!",
* managed_virtual_network_enabled=True,
* identity={
* "type": "SystemAssigned",
* })
* example_firewall_rule = azure.synapse.FirewallRule("example",
* name="allowAll",
* synapse_workspace_id=example_workspace.id,
* start_ip_address="0.0.0.0",
* end_ip_address="255.255.255.255")
* example_integration_runtime_azure = azure.synapse.IntegrationRuntimeAzure("example",
* name="example",
* synapse_workspace_id=example_workspace.id,
* location=example.location)
* example_linked_service = azure.synapse.LinkedService("example",
* name="example",
* synapse_workspace_id=example_workspace.id,
* type="AzureBlobStorage",
* type_properties_json=example_account.primary_connection_string.apply(lambda primary_connection_string: f"""{{
* "connectionString": "{primary_connection_string}"
* }}
* """),
* integration_runtime={
* "name": example_integration_runtime_azure.name,
* },
* opts = pulumi.ResourceOptions(depends_on=[example_firewall_rule]))
* ```
* ```csharp
* 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",
* Location = "West Europe",
* });
* var exampleAccount = new Azure.Storage.Account("example", new()
* {
* Name = "example",
* ResourceGroupName = example.Name,
* Location = example.Location,
* AccountKind = "BlobStorage",
* AccountTier = "Standard",
* AccountReplicationType = "LRS",
* });
* var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("example", new()
* {
* Name = "example",
* StorageAccountId = exampleAccount.Id,
* });
* var exampleWorkspace = new Azure.Synapse.Workspace("example", new()
* {
* Name = "example",
* ResourceGroupName = example.Name,
* Location = example.Location,
* StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
* SqlAdministratorLogin = "sqladminuser",
* SqlAdministratorLoginPassword = "H@Sh1CoR3!",
* ManagedVirtualNetworkEnabled = true,
* Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
* {
* Type = "SystemAssigned",
* },
* });
* var exampleFirewallRule = new Azure.Synapse.FirewallRule("example", new()
* {
* Name = "allowAll",
* SynapseWorkspaceId = exampleWorkspace.Id,
* StartIpAddress = "0.0.0.0",
* EndIpAddress = "255.255.255.255",
* });
* var exampleIntegrationRuntimeAzure = new Azure.Synapse.IntegrationRuntimeAzure("example", new()
* {
* Name = "example",
* SynapseWorkspaceId = exampleWorkspace.Id,
* Location = example.Location,
* });
* var exampleLinkedService = new Azure.Synapse.LinkedService("example", new()
* {
* Name = "example",
* SynapseWorkspaceId = exampleWorkspace.Id,
* Type = "AzureBlobStorage",
* TypePropertiesJson = exampleAccount.PrimaryConnectionString.Apply(primaryConnectionString => @$"{{
* ""connectionString"": ""{primaryConnectionString}""
* }}
* "),
* IntegrationRuntime = new Azure.Synapse.Inputs.LinkedServiceIntegrationRuntimeArgs
* {
* Name = exampleIntegrationRuntimeAzure.Name,
* },
* }, new CustomResourceOptions
* {
* DependsOn =
* {
* exampleFirewallRule,
* },
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/synapse"
* "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"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
* Name: pulumi.String("example"),
* ResourceGroupName: example.Name,
* Location: example.Location,
* AccountKind: pulumi.String("BlobStorage"),
* AccountTier: pulumi.String("Standard"),
* AccountReplicationType: pulumi.String("LRS"),
* })
* if err != nil {
* return err
* }
* exampleDataLakeGen2Filesystem, err := storage.NewDataLakeGen2Filesystem(ctx, "example", &storage.DataLakeGen2FilesystemArgs{
* Name: pulumi.String("example"),
* StorageAccountId: exampleAccount.ID(),
* })
* if err != nil {
* return err
* }
* exampleWorkspace, err := synapse.NewWorkspace(ctx, "example", &synapse.WorkspaceArgs{
* Name: pulumi.String("example"),
* ResourceGroupName: example.Name,
* Location: example.Location,
* StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
* SqlAdministratorLogin: pulumi.String("sqladminuser"),
* SqlAdministratorLoginPassword: pulumi.String("H@Sh1CoR3!"),
* ManagedVirtualNetworkEnabled: pulumi.Bool(true),
* Identity: &synapse.WorkspaceIdentityArgs{
* Type: pulumi.String("SystemAssigned"),
* },
* })
* if err != nil {
* return err
* }
* exampleFirewallRule, err := synapse.NewFirewallRule(ctx, "example", &synapse.FirewallRuleArgs{
* Name: pulumi.String("allowAll"),
* SynapseWorkspaceId: exampleWorkspace.ID(),
* StartIpAddress: pulumi.String("0.0.0.0"),
* EndIpAddress: pulumi.String("255.255.255.255"),
* })
* if err != nil {
* return err
* }
* exampleIntegrationRuntimeAzure, err := synapse.NewIntegrationRuntimeAzure(ctx, "example", &synapse.IntegrationRuntimeAzureArgs{
* Name: pulumi.String("example"),
* SynapseWorkspaceId: exampleWorkspace.ID(),
* Location: example.Location,
* })
* if err != nil {
* return err
* }
* _, err = synapse.NewLinkedService(ctx, "example", &synapse.LinkedServiceArgs{
* Name: pulumi.String("example"),
* SynapseWorkspaceId: exampleWorkspace.ID(),
* Type: pulumi.String("AzureBlobStorage"),
* TypePropertiesJson: exampleAccount.PrimaryConnectionString.ApplyT(func(primaryConnectionString string) (string, error) {
* return fmt.Sprintf("{\n \"connectionString\": \"%v\"\n}\n", primaryConnectionString), nil
* }).(pulumi.StringOutput),
* IntegrationRuntime: &synapse.LinkedServiceIntegrationRuntimeArgs{
* Name: exampleIntegrationRuntimeAzure.Name,
* },
* }, pulumi.DependsOn([]pulumi.Resource{
* exampleFirewallRule,
* }))
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
* .name("example")
* .location("West Europe")
* .build());
* var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
* .name("example")
* .resourceGroupName(example.name())
* .location(example.location())
* .accountKind("BlobStorage")
* .accountTier("Standard")
* .accountReplicationType("LRS")
* .build());
* var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()
* .name("example")
* .storageAccountId(exampleAccount.id())
* .build());
* var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
* .name("example")
* .resourceGroupName(example.name())
* .location(example.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()
* .name("allowAll")
* .synapseWorkspaceId(exampleWorkspace.id())
* .startIpAddress("0.0.0.0")
* .endIpAddress("255.255.255.255")
* .build());
* var exampleIntegrationRuntimeAzure = new IntegrationRuntimeAzure("exampleIntegrationRuntimeAzure", IntegrationRuntimeAzureArgs.builder()
* .name("example")
* .synapseWorkspaceId(exampleWorkspace.id())
* .location(example.location())
* .build());
* var exampleLinkedService = new LinkedService("exampleLinkedService", LinkedServiceArgs.builder()
* .name("example")
* .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());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example
* location: West Europe
* exampleAccount:
* type: azure:storage:Account
* name: example
* properties:
* name: example
* resourceGroupName: ${example.name}
* location: ${example.location}
* accountKind: BlobStorage
* accountTier: Standard
* accountReplicationType: LRS
* exampleDataLakeGen2Filesystem:
* type: azure:storage:DataLakeGen2Filesystem
* name: example
* properties:
* name: example
* storageAccountId: ${exampleAccount.id}
* exampleWorkspace:
* type: azure:synapse:Workspace
* name: example
* properties:
* name: example
* resourceGroupName: ${example.name}
* location: ${example.location}
* storageDataLakeGen2FilesystemId: ${exampleDataLakeGen2Filesystem.id}
* sqlAdministratorLogin: sqladminuser
* sqlAdministratorLoginPassword: H@Sh1CoR3!
* managedVirtualNetworkEnabled: true
* identity:
* type: SystemAssigned
* exampleFirewallRule:
* type: azure:synapse:FirewallRule
* name: example
* properties:
* name: allowAll
* synapseWorkspaceId: ${exampleWorkspace.id}
* startIpAddress: 0.0.0.0
* endIpAddress: 255.255.255.255
* exampleIntegrationRuntimeAzure:
* type: azure:synapse:IntegrationRuntimeAzure
* name: example
* properties:
* name: example
* synapseWorkspaceId: ${exampleWorkspace.id}
* location: ${example.location}
* exampleLinkedService:
* type: azure:synapse:LinkedService
* name: example
* properties:
* name: example
* synapseWorkspaceId: ${exampleWorkspace.id}
* type: AzureBlobStorage
* typePropertiesJson: |
* {
* "connectionString": "${exampleAccount.primaryConnectionString}"
* }
* integrationRuntime:
* name: ${exampleIntegrationRuntimeAzure.name}
* options:
* dependson:
* - ${exampleFirewallRule}
* ```
*
* ## Import
* Synapse Linked Services can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:synapse/linkedService:LinkedService example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.Synapse/workspaces/workspace1/linkedServices/linkedservice1
* ```
*/
public class LinkedService internal constructor(
override val javaResource: com.pulumi.azure.synapse.LinkedService,
) : KotlinCustomResource(javaResource, LinkedServiceMapper) {
/**
* A map of additional properties to associate with the Synapse Linked Service.
*/
public val additionalProperties: Output>?
get() = javaResource.additionalProperties().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0.key.to(args0.value) }).toMap()
}).orElse(null)
})
/**
* List of tags that can be used for describing the Synapse Linked Service.
*/
public val annotations: Output>?
get() = javaResource.annotations().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* The description for the Synapse Linked Service.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A `integration_runtime` block as defined below.
*/
public val integrationRuntime: Output?
get() = javaResource.integrationRuntime().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> toKotlin(args0) })
}).orElse(null)
})
/**
* The name which should be used for this Synapse Linked Service. Changing this forces a new Synapse Linked Service to be created.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* A map of parameters to associate with the Synapse Linked Service.
*/
public val parameters: Output>?
get() = javaResource.parameters().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* The Synapse Workspace ID in which to associate the Linked Service with. Changing this forces a new Synapse Linked Service to be created.
*/
public val synapseWorkspaceId: Output
get() = javaResource.synapseWorkspaceId().applyValue({ args0 -> args0 })
/**
* 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`.
*/
public val type: Output
get() = javaResource.type().applyValue({ args0 -> args0 })
/**
* A JSON object that contains the properties of the Synapse Linked Service.
*/
public val typePropertiesJson: Output
get() = javaResource.typePropertiesJson().applyValue({ args0 -> args0 })
}
public object LinkedServiceMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.synapse.LinkedService::class == javaResource::class
override fun map(javaResource: Resource): LinkedService = LinkedService(
javaResource as
com.pulumi.azure.synapse.LinkedService,
)
}
/**
* @see [LinkedService].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [LinkedService].
*/
public suspend fun linkedService(
name: String,
block: suspend LinkedServiceResourceBuilder.() -> Unit,
): LinkedService {
val builder = LinkedServiceResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [LinkedService].
* @param name The _unique_ name of the resulting resource.
*/
public fun linkedService(name: String): LinkedService {
val builder = LinkedServiceResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy