com.pulumi.azure.datafactory.kotlin.LinkedCustomService.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.datafactory.kotlin
import com.pulumi.azure.datafactory.kotlin.outputs.LinkedCustomServiceIntegrationRuntime
import com.pulumi.azure.datafactory.kotlin.outputs.LinkedCustomServiceIntegrationRuntime.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 [LinkedCustomService].
*/
@PulumiTagMarker
public class LinkedCustomServiceResourceBuilder internal constructor() {
public var name: String? = null
public var args: LinkedCustomServiceArgs = LinkedCustomServiceArgs()
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 LinkedCustomServiceArgsBuilder.() -> Unit) {
val builder = LinkedCustomServiceArgsBuilder()
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(): LinkedCustomService {
val builtJavaResource =
com.pulumi.azure.datafactory.LinkedCustomService(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return LinkedCustomService(builtJavaResource)
}
}
/**
* Manages a Linked Service (connection) between a resource and Azure Data Factory. This is a generic resource that supports all different Linked Service Types.
* ## Example Usage
*
* ```typescript
* 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,
* identity: {
* type: "SystemAssigned",
* },
* });
* const exampleAccount = new azure.storage.Account("example", {
* name: "example",
* resourceGroupName: example.name,
* location: example.location,
* accountKind: "BlobStorage",
* accountTier: "Standard",
* accountReplicationType: "LRS",
* });
* const exampleLinkedCustomService = new azure.datafactory.LinkedCustomService("example", {
* name: "example",
* dataFactoryId: exampleFactory.id,
* type: "AzureBlobStorage",
* description: "test description",
* typePropertiesJson: pulumi.interpolate`{
* "connectionString":"${exampleAccount.primaryConnectionString}"
* }
* `,
* parameters: {
* foo: "bar",
* Env: "Test",
* },
* annotations: [
* "test1",
* "test2",
* "test3",
* ],
* });
* ```
* ```python
* 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,
* identity={
* "type": "SystemAssigned",
* })
* 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_linked_custom_service = azure.datafactory.LinkedCustomService("example",
* name="example",
* data_factory_id=example_factory.id,
* type="AzureBlobStorage",
* description="test description",
* type_properties_json=example_account.primary_connection_string.apply(lambda primary_connection_string: f"""{{
* "connectionString":"{primary_connection_string}"
* }}
* """),
* parameters={
* "foo": "bar",
* "Env": "Test",
* },
* annotations=[
* "test1",
* "test2",
* "test3",
* ])
* ```
* ```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-resources",
* Location = "West Europe",
* });
* var exampleFactory = new Azure.DataFactory.Factory("example", new()
* {
* Name = "example",
* Location = example.Location,
* ResourceGroupName = example.Name,
* Identity = new Azure.DataFactory.Inputs.FactoryIdentityArgs
* {
* Type = "SystemAssigned",
* },
* });
* var exampleAccount = new Azure.Storage.Account("example", new()
* {
* Name = "example",
* ResourceGroupName = example.Name,
* Location = example.Location,
* AccountKind = "BlobStorage",
* AccountTier = "Standard",
* AccountReplicationType = "LRS",
* });
* var exampleLinkedCustomService = new Azure.DataFactory.LinkedCustomService("example", new()
* {
* Name = "example",
* DataFactoryId = exampleFactory.Id,
* Type = "AzureBlobStorage",
* Description = "test description",
* TypePropertiesJson = exampleAccount.PrimaryConnectionString.Apply(primaryConnectionString => @$"{{
* ""connectionString"":""{primaryConnectionString}""
* }}
* "),
* Parameters =
* {
* { "foo", "bar" },
* { "Env", "Test" },
* },
* Annotations = new[]
* {
* "test1",
* "test2",
* "test3",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
* "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,
* Identity: &datafactory.FactoryIdentityArgs{
* Type: pulumi.String("SystemAssigned"),
* },
* })
* 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
* }
* _, err = datafactory.NewLinkedCustomService(ctx, "example", &datafactory.LinkedCustomServiceArgs{
* Name: pulumi.String("example"),
* DataFactoryId: exampleFactory.ID(),
* Type: pulumi.String("AzureBlobStorage"),
* Description: pulumi.String("test description"),
* TypePropertiesJson: exampleAccount.PrimaryConnectionString.ApplyT(func(primaryConnectionString string) (string, error) {
* return fmt.Sprintf("{\n \"connectionString\":\"%v\"\n}\n", primaryConnectionString), nil
* }).(pulumi.StringOutput),
* Parameters: pulumi.StringMap{
* "foo": pulumi.String("bar"),
* "Env": pulumi.String("Test"),
* },
* Annotations: pulumi.StringArray{
* pulumi.String("test1"),
* pulumi.String("test2"),
* pulumi.String("test3"),
* },
* })
* 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.datafactory.Factory;
* import com.pulumi.azure.datafactory.FactoryArgs;
* import com.pulumi.azure.datafactory.inputs.FactoryIdentityArgs;
* import com.pulumi.azure.storage.Account;
* import com.pulumi.azure.storage.AccountArgs;
* import com.pulumi.azure.datafactory.LinkedCustomService;
* import com.pulumi.azure.datafactory.LinkedCustomServiceArgs;
* 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())
* .identity(FactoryIdentityArgs.builder()
* .type("SystemAssigned")
* .build())
* .build());
* var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
* .name("example")
* .resourceGroupName(example.name())
* .location(example.location())
* .accountKind("BlobStorage")
* .accountTier("Standard")
* .accountReplicationType("LRS")
* .build());
* var exampleLinkedCustomService = new LinkedCustomService("exampleLinkedCustomService", LinkedCustomServiceArgs.builder()
* .name("example")
* .dataFactoryId(exampleFactory.id())
* .type("AzureBlobStorage")
* .description("test description")
* .typePropertiesJson(exampleAccount.primaryConnectionString().applyValue(primaryConnectionString -> """
* {
* "connectionString":"%s"
* }
* ", primaryConnectionString)))
* .parameters(Map.ofEntries(
* Map.entry("foo", "bar"),
* Map.entry("Env", "Test")
* ))
* .annotations(
* "test1",
* "test2",
* "test3")
* .build());
* }
* }
* ```
* ```yaml
* 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}
* identity:
* type: SystemAssigned
* exampleAccount:
* type: azure:storage:Account
* name: example
* properties:
* name: example
* resourceGroupName: ${example.name}
* location: ${example.location}
* accountKind: BlobStorage
* accountTier: Standard
* accountReplicationType: LRS
* exampleLinkedCustomService:
* type: azure:datafactory:LinkedCustomService
* name: example
* properties:
* name: example
* dataFactoryId: ${exampleFactory.id}
* type: AzureBlobStorage
* description: test description
* typePropertiesJson: |
* {
* "connectionString":"${exampleAccount.primaryConnectionString}"
* }
* parameters:
* foo: bar
* Env: Test
* annotations:
* - test1
* - test2
* - test3
* ```
*
* ## Import
* Data Factory Linked Service's can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:datafactory/linkedCustomService:LinkedCustomService example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example
* ```
*/
public class LinkedCustomService internal constructor(
override val javaResource: com.pulumi.azure.datafactory.LinkedCustomService,
) : KotlinCustomResource(javaResource, LinkedCustomServiceMapper) {
/**
* A map of additional properties to associate with the Data Factory 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 Data Factory Linked Service.
*/
public val annotations: Output>?
get() = javaResource.annotations().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*/
public val dataFactoryId: Output
get() = javaResource.dataFactoryId().applyValue({ args0 -> args0 })
/**
* The description for the Data Factory Linked Service.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* An `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)
})
/**
* Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the [Microsoft documentation](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* A map of parameters to associate with the Data Factory 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 type of data stores that will be connected to Data Factory. For full list of supported data stores, please refer to [Azure Data Factory connector](https://docs.microsoft.com/azure/data-factory/connector-overview). Changing this forces a new resource to be created.
*/
public val type: Output
get() = javaResource.type().applyValue({ args0 -> args0 })
/**
* A JSON object that contains the properties of the Data Factory Linked Service.
*/
public val typePropertiesJson: Output
get() = javaResource.typePropertiesJson().applyValue({ args0 -> args0 })
}
public object LinkedCustomServiceMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.datafactory.LinkedCustomService::class == javaResource::class
override fun map(javaResource: Resource): LinkedCustomService = LinkedCustomService(
javaResource
as com.pulumi.azure.datafactory.LinkedCustomService,
)
}
/**
* @see [LinkedCustomService].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [LinkedCustomService].
*/
public suspend fun linkedCustomService(
name: String,
block: suspend LinkedCustomServiceResourceBuilder.() -> Unit,
): LinkedCustomService {
val builder = LinkedCustomServiceResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [LinkedCustomService].
* @param name The _unique_ name of the resulting resource.
*/
public fun linkedCustomService(name: String): LinkedCustomService {
val builder = LinkedCustomServiceResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy