com.pulumi.azure.datafactory.kotlin.LinkedCustomServiceArgs.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.LinkedCustomServiceArgs.builder
import com.pulumi.azure.datafactory.kotlin.inputs.LinkedCustomServiceIntegrationRuntimeArgs
import com.pulumi.azure.datafactory.kotlin.inputs.LinkedCustomServiceIntegrationRuntimeArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* 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=azure.datafactory.FactoryIdentityArgs(
* 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
* ```
* @property additionalProperties A map of additional properties to associate with the Data Factory Linked Service.
* @property annotations List of tags that can be used for describing the Data Factory Linked Service.
* @property dataFactoryId The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
* @property description The description for the Data Factory Linked Service.
* @property integrationRuntime An `integration_runtime` block as defined below.
* @property name 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.
* @property parameters A map of parameters to associate with the Data Factory Linked Service.
* @property type 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.
* @property typePropertiesJson A JSON object that contains the properties of the Data Factory Linked Service.
*/
public data class LinkedCustomServiceArgs(
public val additionalProperties: Output>? = null,
public val annotations: Output>? = null,
public val dataFactoryId: Output? = null,
public val description: Output? = null,
public val integrationRuntime: Output? = null,
public val name: Output? = null,
public val parameters: Output>? = null,
public val type: Output? = null,
public val typePropertiesJson: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.datafactory.LinkedCustomServiceArgs =
com.pulumi.azure.datafactory.LinkedCustomServiceArgs.builder()
.additionalProperties(
additionalProperties?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
)
.annotations(annotations?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.dataFactoryId(dataFactoryId?.applyValue({ args0 -> args0 }))
.description(description?.applyValue({ args0 -> args0 }))
.integrationRuntime(
integrationRuntime?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.name(name?.applyValue({ args0 -> args0 }))
.parameters(
parameters?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
)
.type(type?.applyValue({ args0 -> args0 }))
.typePropertiesJson(typePropertiesJson?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [LinkedCustomServiceArgs].
*/
@PulumiTagMarker
public class LinkedCustomServiceArgsBuilder internal constructor() {
private var additionalProperties: Output>? = null
private var annotations: Output>? = null
private var dataFactoryId: Output? = null
private var description: Output? = null
private var integrationRuntime: Output? = null
private var name: Output? = null
private var parameters: Output>? = null
private var type: Output? = null
private var typePropertiesJson: Output? = null
/**
* @param value A map of additional properties to associate with the Data Factory Linked Service.
*/
@JvmName("kqrvqybkalmwrlwf")
public suspend fun additionalProperties(`value`: Output>) {
this.additionalProperties = value
}
/**
* @param value List of tags that can be used for describing the Data Factory Linked Service.
*/
@JvmName("ktdidtluqwmjdwfq")
public suspend fun annotations(`value`: Output>) {
this.annotations = value
}
@JvmName("vwcrngasgndjfyrw")
public suspend fun annotations(vararg values: Output) {
this.annotations = Output.all(values.asList())
}
/**
* @param values List of tags that can be used for describing the Data Factory Linked Service.
*/
@JvmName("tokqotwrpgulljtp")
public suspend fun annotations(values: List>) {
this.annotations = Output.all(values)
}
/**
* @param value The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*/
@JvmName("esnykbbjqdypiehc")
public suspend fun dataFactoryId(`value`: Output) {
this.dataFactoryId = value
}
/**
* @param value The description for the Data Factory Linked Service.
*/
@JvmName("gafjqyjakkailric")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value An `integration_runtime` block as defined below.
*/
@JvmName("dwxlwcamefboeobu")
public suspend
fun integrationRuntime(`value`: Output) {
this.integrationRuntime = value
}
/**
* @param value 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.
*/
@JvmName("juxijabxdrqohnpv")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value A map of parameters to associate with the Data Factory Linked Service.
*/
@JvmName("ilfnlyksldwbwgsj")
public suspend fun parameters(`value`: Output>) {
this.parameters = value
}
/**
* @param value 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.
*/
@JvmName("euoamlfvjkokrxoi")
public suspend fun type(`value`: Output) {
this.type = value
}
/**
* @param value A JSON object that contains the properties of the Data Factory Linked Service.
*/
@JvmName("ldmqbpohnnvuxyfc")
public suspend fun typePropertiesJson(`value`: Output) {
this.typePropertiesJson = value
}
/**
* @param value A map of additional properties to associate with the Data Factory Linked Service.
*/
@JvmName("swycvtfqhklueubv")
public suspend fun additionalProperties(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.additionalProperties = mapped
}
/**
* @param values A map of additional properties to associate with the Data Factory Linked Service.
*/
@JvmName("woxbeyjgyejsyjkc")
public fun additionalProperties(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.additionalProperties = mapped
}
/**
* @param value List of tags that can be used for describing the Data Factory Linked Service.
*/
@JvmName("pmlrkiijxnubehqq")
public suspend fun annotations(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.annotations = mapped
}
/**
* @param values List of tags that can be used for describing the Data Factory Linked Service.
*/
@JvmName("dtbofpdlemwcppvf")
public suspend fun annotations(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.annotations = mapped
}
/**
* @param value The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*/
@JvmName("yynxvsfkjuocacvk")
public suspend fun dataFactoryId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.dataFactoryId = mapped
}
/**
* @param value The description for the Data Factory Linked Service.
*/
@JvmName("nealyapwpudakjgv")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value An `integration_runtime` block as defined below.
*/
@JvmName("rsmptucueobqjfxm")
public suspend fun integrationRuntime(`value`: LinkedCustomServiceIntegrationRuntimeArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.integrationRuntime = mapped
}
/**
* @param argument An `integration_runtime` block as defined below.
*/
@JvmName("fcymncjthaekwwmu")
public suspend
fun integrationRuntime(argument: suspend LinkedCustomServiceIntegrationRuntimeArgsBuilder.() -> Unit) {
val toBeMapped = LinkedCustomServiceIntegrationRuntimeArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.integrationRuntime = mapped
}
/**
* @param value 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.
*/
@JvmName("ouiraorjimqbceia")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value A map of parameters to associate with the Data Factory Linked Service.
*/
@JvmName("nhpxyjlnhmfbcyka")
public suspend fun parameters(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.parameters = mapped
}
/**
* @param values A map of parameters to associate with the Data Factory Linked Service.
*/
@JvmName("wflfmhmxynquehin")
public fun parameters(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.parameters = mapped
}
/**
* @param value 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.
*/
@JvmName("lfdbuikbmfnemicd")
public suspend fun type(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.type = mapped
}
/**
* @param value A JSON object that contains the properties of the Data Factory Linked Service.
*/
@JvmName("hfuacppskufmjdwe")
public suspend fun typePropertiesJson(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.typePropertiesJson = mapped
}
internal fun build(): LinkedCustomServiceArgs = LinkedCustomServiceArgs(
additionalProperties = additionalProperties,
annotations = annotations,
dataFactoryId = dataFactoryId,
description = description,
integrationRuntime = integrationRuntime,
name = name,
parameters = parameters,
type = type,
typePropertiesJson = typePropertiesJson,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy