com.pulumi.azure.datafactory.kotlin.LinkedServiceAzureFileStorageArgs.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.LinkedServiceAzureFileStorageArgs.builder
import com.pulumi.azure.datafactory.kotlin.inputs.LinkedServiceAzureFileStorageKeyVaultPasswordArgs
import com.pulumi.azure.datafactory.kotlin.inputs.LinkedServiceAzureFileStorageKeyVaultPasswordArgsBuilder
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 SFTP Server and Azure Data Factory.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const exampleResourceGroup = new azure.core.ResourceGroup("example", {
* name: "example-resources",
* location: "West Europe",
* });
* const example = azure.storage.getAccountOutput({
* name: "storageaccountname",
* resourceGroupName: exampleResourceGroup.name,
* });
* const exampleFactory = new azure.datafactory.Factory("example", {
* name: "example",
* location: exampleResourceGroup.location,
* resourceGroupName: exampleResourceGroup.name,
* });
* const exampleLinkedServiceAzureFileStorage = new azure.datafactory.LinkedServiceAzureFileStorage("example", {
* name: "example",
* dataFactoryId: exampleFactory.id,
* connectionString: example.apply(example => example.primaryConnectionString),
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example_resource_group = azure.core.ResourceGroup("example",
* name="example-resources",
* location="West Europe")
* example = azure.storage.get_account_output(name="storageaccountname",
* resource_group_name=example_resource_group.name)
* example_factory = azure.datafactory.Factory("example",
* name="example",
* location=example_resource_group.location,
* resource_group_name=example_resource_group.name)
* example_linked_service_azure_file_storage = azure.datafactory.LinkedServiceAzureFileStorage("example",
* name="example",
* data_factory_id=example_factory.id,
* connection_string=example.primary_connection_string)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var exampleResourceGroup = new Azure.Core.ResourceGroup("example", new()
* {
* Name = "example-resources",
* Location = "West Europe",
* });
* var example = Azure.Storage.GetAccount.Invoke(new()
* {
* Name = "storageaccountname",
* ResourceGroupName = exampleResourceGroup.Name,
* });
* var exampleFactory = new Azure.DataFactory.Factory("example", new()
* {
* Name = "example",
* Location = exampleResourceGroup.Location,
* ResourceGroupName = exampleResourceGroup.Name,
* });
* var exampleLinkedServiceAzureFileStorage = new Azure.DataFactory.LinkedServiceAzureFileStorage("example", new()
* {
* Name = "example",
* DataFactoryId = exampleFactory.Id,
* ConnectionString = example.Apply(getAccountResult => getAccountResult.PrimaryConnectionString),
* });
* });
* ```
* ```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-azure/sdk/v5/go/azure/storage"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* exampleResourceGroup, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("example-resources"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* example := storage.LookupAccountOutput(ctx, storage.GetAccountOutputArgs{
* Name: pulumi.String("storageaccountname"),
* ResourceGroupName: exampleResourceGroup.Name,
* }, nil)
* exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
* Name: pulumi.String("example"),
* Location: exampleResourceGroup.Location,
* ResourceGroupName: exampleResourceGroup.Name,
* })
* if err != nil {
* return err
* }
* _, err = datafactory.NewLinkedServiceAzureFileStorage(ctx, "example", &datafactory.LinkedServiceAzureFileStorageArgs{
* Name: pulumi.String("example"),
* DataFactoryId: exampleFactory.ID(),
* ConnectionString: example.ApplyT(func(example storage.GetAccountResult) (*string, error) {
* return &example.PrimaryConnectionString, nil
* }).(pulumi.StringPtrOutput),
* })
* 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.StorageFunctions;
* import com.pulumi.azure.storage.inputs.GetAccountArgs;
* import com.pulumi.azure.datafactory.Factory;
* import com.pulumi.azure.datafactory.FactoryArgs;
* import com.pulumi.azure.datafactory.LinkedServiceAzureFileStorage;
* import com.pulumi.azure.datafactory.LinkedServiceAzureFileStorageArgs;
* 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()
* .name("example-resources")
* .location("West Europe")
* .build());
* final var example = StorageFunctions.getAccount(GetAccountArgs.builder()
* .name("storageaccountname")
* .resourceGroupName(exampleResourceGroup.name())
* .build());
* var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
* .name("example")
* .location(exampleResourceGroup.location())
* .resourceGroupName(exampleResourceGroup.name())
* .build());
* var exampleLinkedServiceAzureFileStorage = new LinkedServiceAzureFileStorage("exampleLinkedServiceAzureFileStorage", LinkedServiceAzureFileStorageArgs.builder()
* .name("example")
* .dataFactoryId(exampleFactory.id())
* .connectionString(example.applyValue(getAccountResult -> getAccountResult).applyValue(example -> example.applyValue(getAccountResult -> getAccountResult.primaryConnectionString())))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* exampleResourceGroup:
* type: azure:core:ResourceGroup
* name: example
* properties:
* name: example-resources
* location: West Europe
* exampleFactory:
* type: azure:datafactory:Factory
* name: example
* properties:
* name: example
* location: ${exampleResourceGroup.location}
* resourceGroupName: ${exampleResourceGroup.name}
* exampleLinkedServiceAzureFileStorage:
* type: azure:datafactory:LinkedServiceAzureFileStorage
* name: example
* properties:
* name: example
* dataFactoryId: ${exampleFactory.id}
* connectionString: ${example.primaryConnectionString}
* variables:
* example:
* fn::invoke:
* Function: azure:storage:getAccount
* Arguments:
* name: storageaccountname
* resourceGroupName: ${exampleResourceGroup.name}
* ```
*
* ## Import
* Data Factory Linked Service's can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:datafactory/linkedServiceAzureFileStorage:LinkedServiceAzureFileStorage 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 Azure File Storage Linked Service:
* @property annotations List of tags that can be used for describing the Data Factory Linked Service.
* @property connectionString The connection string.
* @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 fileShare The name of the file share.
* @property host The Host name of the server.
* @property integrationRuntimeName The integration runtime reference to associate with the Data Factory Linked Service.
* @property keyVaultPassword A `key_vault_password` block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault 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 password The password to log in the server.
* @property userId The user ID to log in the server.
*/
public data class LinkedServiceAzureFileStorageArgs(
public val additionalProperties: Output>? = null,
public val annotations: Output>? = null,
public val connectionString: Output? = null,
public val dataFactoryId: Output? = null,
public val description: Output? = null,
public val fileShare: Output? = null,
public val host: Output? = null,
public val integrationRuntimeName: Output? = null,
public val keyVaultPassword: Output? = null,
public val name: Output? = null,
public val parameters: Output>? = null,
public val password: Output? = null,
public val userId: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.datafactory.LinkedServiceAzureFileStorageArgs =
com.pulumi.azure.datafactory.LinkedServiceAzureFileStorageArgs.builder()
.additionalProperties(
additionalProperties?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
)
.annotations(annotations?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.connectionString(connectionString?.applyValue({ args0 -> args0 }))
.dataFactoryId(dataFactoryId?.applyValue({ args0 -> args0 }))
.description(description?.applyValue({ args0 -> args0 }))
.fileShare(fileShare?.applyValue({ args0 -> args0 }))
.host(host?.applyValue({ args0 -> args0 }))
.integrationRuntimeName(integrationRuntimeName?.applyValue({ args0 -> args0 }))
.keyVaultPassword(keyVaultPassword?.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()
}),
)
.password(password?.applyValue({ args0 -> args0 }))
.userId(userId?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [LinkedServiceAzureFileStorageArgs].
*/
@PulumiTagMarker
public class LinkedServiceAzureFileStorageArgsBuilder internal constructor() {
private var additionalProperties: Output>? = null
private var annotations: Output>? = null
private var connectionString: Output? = null
private var dataFactoryId: Output? = null
private var description: Output? = null
private var fileShare: Output? = null
private var host: Output? = null
private var integrationRuntimeName: Output? = null
private var keyVaultPassword: Output? = null
private var name: Output? = null
private var parameters: Output>? = null
private var password: Output? = null
private var userId: Output? = null
/**
* @param value A map of additional properties to associate with the Data Factory Linked Service.
* The following supported arguments are specific to Azure File Storage Linked Service:
*/
@JvmName("jjtylsylohlmsfxr")
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("kwhvhynojufbhumb")
public suspend fun annotations(`value`: Output>) {
this.annotations = value
}
@JvmName("doehehvjrwyqwaie")
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("lyhcuknteupossru")
public suspend fun annotations(values: List>) {
this.annotations = Output.all(values)
}
/**
* @param value The connection string.
*/
@JvmName("cpohjrywycefenhh")
public suspend fun connectionString(`value`: Output) {
this.connectionString = value
}
/**
* @param value The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*/
@JvmName("ntgdqjilkllgibtw")
public suspend fun dataFactoryId(`value`: Output) {
this.dataFactoryId = value
}
/**
* @param value The description for the Data Factory Linked Service.
*/
@JvmName("jvivyxoyicmooowh")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value The name of the file share.
*/
@JvmName("cutjsnsrebskvuad")
public suspend fun fileShare(`value`: Output) {
this.fileShare = value
}
/**
* @param value The Host name of the server.
*/
@JvmName("sajvrtoglkajwjhs")
public suspend fun host(`value`: Output) {
this.host = value
}
/**
* @param value The integration runtime reference to associate with the Data Factory Linked Service.
*/
@JvmName("ewhvtgrxntrrjcbk")
public suspend fun integrationRuntimeName(`value`: Output) {
this.integrationRuntimeName = value
}
/**
* @param value A `key_vault_password` block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
*/
@JvmName("qkdbnjbicmdidccw")
public suspend
fun keyVaultPassword(`value`: Output) {
this.keyVaultPassword = 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("ltjmoksqvldswvie")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value A map of parameters to associate with the Data Factory Linked Service.
*/
@JvmName("pkaytrteahydccel")
public suspend fun parameters(`value`: Output>) {
this.parameters = value
}
/**
* @param value The password to log in the server.
*/
@JvmName("quyqpyufgglmvxxq")
public suspend fun password(`value`: Output) {
this.password = value
}
/**
* @param value The user ID to log in the server.
*/
@JvmName("hbjddfgxklafaany")
public suspend fun userId(`value`: Output) {
this.userId = value
}
/**
* @param value A map of additional properties to associate with the Data Factory Linked Service.
* The following supported arguments are specific to Azure File Storage Linked Service:
*/
@JvmName("ycxtcpulwhouvlkb")
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 Azure File Storage Linked Service:
*/
@JvmName("mvaxdmbonxrhpkhg")
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("aumhdsksyslvyjxw")
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("yvctuybyqnewfooi")
public suspend fun annotations(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.annotations = mapped
}
/**
* @param value The connection string.
*/
@JvmName("aorerkdydhbpeowh")
public suspend fun connectionString(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.connectionString = mapped
}
/**
* @param value The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*/
@JvmName("ioqgioydmfwutoie")
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("axpmwpydcdadbfun")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value The name of the file share.
*/
@JvmName("iyndhpoufudimfsj")
public suspend fun fileShare(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.fileShare = mapped
}
/**
* @param value The Host name of the server.
*/
@JvmName("sulapvauavrcuxog")
public suspend fun host(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.host = mapped
}
/**
* @param value The integration runtime reference to associate with the Data Factory Linked Service.
*/
@JvmName("yxavhkwmkcuhoahk")
public suspend fun integrationRuntimeName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.integrationRuntimeName = mapped
}
/**
* @param value A `key_vault_password` block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
*/
@JvmName("fadqnntmjfaaxhig")
public suspend fun keyVaultPassword(`value`: LinkedServiceAzureFileStorageKeyVaultPasswordArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.keyVaultPassword = mapped
}
/**
* @param argument A `key_vault_password` block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.
*/
@JvmName("wawumdjbruawtbfs")
public suspend
fun keyVaultPassword(argument: suspend LinkedServiceAzureFileStorageKeyVaultPasswordArgsBuilder.() -> Unit) {
val toBeMapped = LinkedServiceAzureFileStorageKeyVaultPasswordArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.keyVaultPassword = 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("idtixowhljxymodq")
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("btotspauormjciyi")
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("eqovnpaydopmtvae")
public fun parameters(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.parameters = mapped
}
/**
* @param value The password to log in the server.
*/
@JvmName("cvyrdipqicvmjcqs")
public suspend fun password(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.password = mapped
}
/**
* @param value The user ID to log in the server.
*/
@JvmName("aoddcobpywrrbtql")
public suspend fun userId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.userId = mapped
}
internal fun build(): LinkedServiceAzureFileStorageArgs = LinkedServiceAzureFileStorageArgs(
additionalProperties = additionalProperties,
annotations = annotations,
connectionString = connectionString,
dataFactoryId = dataFactoryId,
description = description,
fileShare = fileShare,
host = host,
integrationRuntimeName = integrationRuntimeName,
keyVaultPassword = keyVaultPassword,
name = name,
parameters = parameters,
password = password,
userId = userId,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy