com.pulumi.azure.datafactory.kotlin.LinkedServiceDataLakeStorageGen2Args.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.LinkedServiceDataLakeStorageGen2Args.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* Manages a Linked Service (connection) between Data Lake Storage Gen2 and Azure Data Factory.
* ## 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,
* });
* const current = azure.core.getClientConfig({});
* const exampleLinkedServiceDataLakeStorageGen2 = new azure.datafactory.LinkedServiceDataLakeStorageGen2("example", {
* name: "example",
* dataFactoryId: exampleFactory.id,
* servicePrincipalId: current.then(current => current.clientId),
* servicePrincipalKey: "exampleKey",
* tenant: "11111111-1111-1111-1111-111111111111",
* url: "https://datalakestoragegen2",
* });
* ```
* ```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)
* current = azure.core.get_client_config()
* example_linked_service_data_lake_storage_gen2 = azure.datafactory.LinkedServiceDataLakeStorageGen2("example",
* name="example",
* data_factory_id=example_factory.id,
* service_principal_id=current.client_id,
* service_principal_key="exampleKey",
* tenant="11111111-1111-1111-1111-111111111111",
* url="https://datalakestoragegen2")
* ```
* ```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,
* });
* var current = Azure.Core.GetClientConfig.Invoke();
* var exampleLinkedServiceDataLakeStorageGen2 = new Azure.DataFactory.LinkedServiceDataLakeStorageGen2("example", new()
* {
* Name = "example",
* DataFactoryId = exampleFactory.Id,
* ServicePrincipalId = current.Apply(getClientConfigResult => getClientConfigResult.ClientId),
* ServicePrincipalKey = "exampleKey",
* Tenant = "11111111-1111-1111-1111-111111111111",
* Url = "https://datalakestoragegen2",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
* "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,
* })
* if err != nil {
* return err
* }
* current, err := core.GetClientConfig(ctx, nil, nil)
* if err != nil {
* return err
* }
* _, err = datafactory.NewLinkedServiceDataLakeStorageGen2(ctx, "example", &datafactory.LinkedServiceDataLakeStorageGen2Args{
* Name: pulumi.String("example"),
* DataFactoryId: exampleFactory.ID(),
* ServicePrincipalId: pulumi.String(current.ClientId),
* ServicePrincipalKey: pulumi.String("exampleKey"),
* Tenant: pulumi.String("11111111-1111-1111-1111-111111111111"),
* Url: pulumi.String("https://datalakestoragegen2"),
* })
* 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.core.CoreFunctions;
* import com.pulumi.azure.datafactory.LinkedServiceDataLakeStorageGen2;
* import com.pulumi.azure.datafactory.LinkedServiceDataLakeStorageGen2Args;
* 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())
* .build());
* final var current = CoreFunctions.getClientConfig();
* var exampleLinkedServiceDataLakeStorageGen2 = new LinkedServiceDataLakeStorageGen2("exampleLinkedServiceDataLakeStorageGen2", LinkedServiceDataLakeStorageGen2Args.builder()
* .name("example")
* .dataFactoryId(exampleFactory.id())
* .servicePrincipalId(current.applyValue(getClientConfigResult -> getClientConfigResult.clientId()))
* .servicePrincipalKey("exampleKey")
* .tenant("11111111-1111-1111-1111-111111111111")
* .url("https://datalakestoragegen2")
* .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}
* exampleLinkedServiceDataLakeStorageGen2:
* type: azure:datafactory:LinkedServiceDataLakeStorageGen2
* name: example
* properties:
* name: example
* dataFactoryId: ${exampleFactory.id}
* servicePrincipalId: ${current.clientId}
* servicePrincipalKey: exampleKey
* tenant: 11111111-1111-1111-1111-111111111111
* url: https://datalakestoragegen2
* variables:
* current:
* fn::invoke:
* Function: azure:core:getClientConfig
* Arguments: {}
* ```
*
* ## Import
* Data Factory Data Lake Storage Gen2 Linked Services can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:datafactory/linkedServiceDataLakeStorageGen2:LinkedServiceDataLakeStorageGen2 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.
* The following supported arguments are specific to Data Lake Storage Gen2 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 integrationRuntimeName The integration runtime reference to associate with the Data Factory Linked Service.
* @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 servicePrincipalId The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `storage_account_key` and `use_managed_identity`.
* @property servicePrincipalKey The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
* @property storageAccountKey The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `service_principal_id`, `service_principal_key`, `tenant` and `use_managed_identity`.
* @property tenant The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.
* > **NOTE** If `service_principal_id` is used, `service_principal_key` and `tenant` are also required.
* @property url The endpoint for the Azure Data Lake Storage Gen2 service.
* > **NOTE** Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.
* @property useManagedIdentity Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `service_principal_id`, `service_principal_key`, `tenant` and `storage_account_key`.
*/
public data class LinkedServiceDataLakeStorageGen2Args(
public val additionalProperties: Output>? = null,
public val annotations: Output>? = null,
public val dataFactoryId: Output? = null,
public val description: Output? = null,
public val integrationRuntimeName: Output? = null,
public val name: Output? = null,
public val parameters: Output>? = null,
public val servicePrincipalId: Output? = null,
public val servicePrincipalKey: Output? = null,
public val storageAccountKey: Output? = null,
public val tenant: Output? = null,
public val url: Output? = null,
public val useManagedIdentity: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.datafactory.LinkedServiceDataLakeStorageGen2Args =
com.pulumi.azure.datafactory.LinkedServiceDataLakeStorageGen2Args.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 }))
.integrationRuntimeName(integrationRuntimeName?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.parameters(
parameters?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
)
.servicePrincipalId(servicePrincipalId?.applyValue({ args0 -> args0 }))
.servicePrincipalKey(servicePrincipalKey?.applyValue({ args0 -> args0 }))
.storageAccountKey(storageAccountKey?.applyValue({ args0 -> args0 }))
.tenant(tenant?.applyValue({ args0 -> args0 }))
.url(url?.applyValue({ args0 -> args0 }))
.useManagedIdentity(useManagedIdentity?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [LinkedServiceDataLakeStorageGen2Args].
*/
@PulumiTagMarker
public class LinkedServiceDataLakeStorageGen2ArgsBuilder internal constructor() {
private var additionalProperties: Output>? = null
private var annotations: Output>? = null
private var dataFactoryId: Output? = null
private var description: Output? = null
private var integrationRuntimeName: Output? = null
private var name: Output? = null
private var parameters: Output>? = null
private var servicePrincipalId: Output? = null
private var servicePrincipalKey: Output? = null
private var storageAccountKey: Output? = null
private var tenant: Output? = null
private var url: Output? = null
private var useManagedIdentity: Output? = null
/**
* @param value A map of additional properties to associate with the Data Factory Linked Service.
* The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:
*/
@JvmName("ndwgptmoppwvumre")
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("qxgbgqggifteiwev")
public suspend fun annotations(`value`: Output>) {
this.annotations = value
}
@JvmName("rkomvuvmywlblpkl")
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("ygpcgonmguausfkp")
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("unxhpbiyaigpoewp")
public suspend fun dataFactoryId(`value`: Output) {
this.dataFactoryId = value
}
/**
* @param value The description for the Data Factory Linked Service.
*/
@JvmName("xcvvenblmtqjwxmf")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value The integration runtime reference to associate with the Data Factory Linked Service.
*/
@JvmName("vevraojpbbqgoloi")
public suspend fun integrationRuntimeName(`value`: Output) {
this.integrationRuntimeName = 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("krhyseivtkvvxjgg")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value A map of parameters to associate with the Data Factory Linked Service.
*/
@JvmName("clnkirpgxrxgnuwu")
public suspend fun parameters(`value`: Output>) {
this.parameters = value
}
/**
* @param value The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `storage_account_key` and `use_managed_identity`.
*/
@JvmName("qvkdesgmwqcfthlu")
public suspend fun servicePrincipalId(`value`: Output) {
this.servicePrincipalId = value
}
/**
* @param value The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
*/
@JvmName("shcwowbsewdsfxjb")
public suspend fun servicePrincipalKey(`value`: Output) {
this.servicePrincipalKey = value
}
/**
* @param value The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `service_principal_id`, `service_principal_key`, `tenant` and `use_managed_identity`.
*/
@JvmName("doplehompejyumpd")
public suspend fun storageAccountKey(`value`: Output) {
this.storageAccountKey = value
}
/**
* @param value The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.
* > **NOTE** If `service_principal_id` is used, `service_principal_key` and `tenant` are also required.
*/
@JvmName("kqgjqupckyifesqs")
public suspend fun tenant(`value`: Output) {
this.tenant = value
}
/**
* @param value The endpoint for the Azure Data Lake Storage Gen2 service.
* > **NOTE** Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.
*/
@JvmName("pdpeixpywjptlswl")
public suspend fun url(`value`: Output) {
this.url = value
}
/**
* @param value Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `service_principal_id`, `service_principal_key`, `tenant` and `storage_account_key`.
*/
@JvmName("pfmawekilfwpxwus")
public suspend fun useManagedIdentity(`value`: Output) {
this.useManagedIdentity = value
}
/**
* @param value A map of additional properties to associate with the Data Factory Linked Service.
* The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:
*/
@JvmName("oayjwbqefndhkriu")
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.
* The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:
*/
@JvmName("ukayvgnmbxrlbmot")
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("ljgmrhwovmqbwycv")
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("xkognblqbasrsjmb")
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("qsypmtvaolgtreul")
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("hunuiwtmsyoivnvf")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value The integration runtime reference to associate with the Data Factory Linked Service.
*/
@JvmName("gwslpulopbnolufc")
public suspend fun integrationRuntimeName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.integrationRuntimeName = 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("caxdxhudbtksqlgp")
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("nepoxmxkgryhbfri")
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("hvhpamgnotygihdw")
public fun parameters(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.parameters = mapped
}
/**
* @param value The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `storage_account_key` and `use_managed_identity`.
*/
@JvmName("ciitloflujcojelj")
public suspend fun servicePrincipalId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.servicePrincipalId = mapped
}
/**
* @param value The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
*/
@JvmName("muenexixyttskcco")
public suspend fun servicePrincipalKey(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.servicePrincipalKey = mapped
}
/**
* @param value The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `service_principal_id`, `service_principal_key`, `tenant` and `use_managed_identity`.
*/
@JvmName("lseivsdwcqqdablc")
public suspend fun storageAccountKey(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.storageAccountKey = mapped
}
/**
* @param value The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.
* > **NOTE** If `service_principal_id` is used, `service_principal_key` and `tenant` are also required.
*/
@JvmName("mthuenynhspmpskg")
public suspend fun tenant(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tenant = mapped
}
/**
* @param value The endpoint for the Azure Data Lake Storage Gen2 service.
* > **NOTE** Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.
*/
@JvmName("glrjamnkxstegawo")
public suspend fun url(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.url = mapped
}
/**
* @param value Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `service_principal_id`, `service_principal_key`, `tenant` and `storage_account_key`.
*/
@JvmName("wxupletfuysfvngc")
public suspend fun useManagedIdentity(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.useManagedIdentity = mapped
}
internal fun build(): LinkedServiceDataLakeStorageGen2Args = LinkedServiceDataLakeStorageGen2Args(
additionalProperties = additionalProperties,
annotations = annotations,
dataFactoryId = dataFactoryId,
description = description,
integrationRuntimeName = integrationRuntimeName,
name = name,
parameters = parameters,
servicePrincipalId = servicePrincipalId,
servicePrincipalKey = servicePrincipalKey,
storageAccountKey = storageAccountKey,
tenant = tenant,
url = url,
useManagedIdentity = useManagedIdentity,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy