com.pulumi.azure.datafactory.kotlin.DatasetBinaryArgs.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.DatasetBinaryArgs.builder
import com.pulumi.azure.datafactory.kotlin.inputs.DatasetBinaryAzureBlobStorageLocationArgs
import com.pulumi.azure.datafactory.kotlin.inputs.DatasetBinaryAzureBlobStorageLocationArgsBuilder
import com.pulumi.azure.datafactory.kotlin.inputs.DatasetBinaryCompressionArgs
import com.pulumi.azure.datafactory.kotlin.inputs.DatasetBinaryCompressionArgsBuilder
import com.pulumi.azure.datafactory.kotlin.inputs.DatasetBinaryHttpServerLocationArgs
import com.pulumi.azure.datafactory.kotlin.inputs.DatasetBinaryHttpServerLocationArgsBuilder
import com.pulumi.azure.datafactory.kotlin.inputs.DatasetBinarySftpServerLocationArgs
import com.pulumi.azure.datafactory.kotlin.inputs.DatasetBinarySftpServerLocationArgsBuilder
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 Data Factory Binary Dataset inside an 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",
* location: "West Europe",
* });
* const exampleFactory = new azure.datafactory.Factory("example", {
* name: "example",
* location: example.location,
* resourceGroupName: example.name,
* });
* const exampleLinkedServiceSftp = new azure.datafactory.LinkedServiceSftp("example", {
* name: "example",
* dataFactoryId: exampleFactory.id,
* authenticationType: "Basic",
* host: "http://www.bing.com",
* port: 22,
* username: "foo",
* password: "bar",
* });
* const exampleDatasetBinary = new azure.datafactory.DatasetBinary("example", {
* name: "example",
* dataFactoryId: exampleFactory.id,
* linkedServiceName: exampleLinkedServiceSftp.name,
* sftpServerLocation: {
* path: "/test/",
* filename: "**",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example",
* location="West Europe")
* example_factory = azure.datafactory.Factory("example",
* name="example",
* location=example.location,
* resource_group_name=example.name)
* example_linked_service_sftp = azure.datafactory.LinkedServiceSftp("example",
* name="example",
* data_factory_id=example_factory.id,
* authentication_type="Basic",
* host="http://www.bing.com",
* port=22,
* username="foo",
* password="bar")
* example_dataset_binary = azure.datafactory.DatasetBinary("example",
* name="example",
* data_factory_id=example_factory.id,
* linked_service_name=example_linked_service_sftp.name,
* sftp_server_location={
* "path": "/test/",
* "filename": "**",
* })
* ```
* ```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 exampleFactory = new Azure.DataFactory.Factory("example", new()
* {
* Name = "example",
* Location = example.Location,
* ResourceGroupName = example.Name,
* });
* var exampleLinkedServiceSftp = new Azure.DataFactory.LinkedServiceSftp("example", new()
* {
* Name = "example",
* DataFactoryId = exampleFactory.Id,
* AuthenticationType = "Basic",
* Host = "http://www.bing.com",
* Port = 22,
* Username = "foo",
* Password = "bar",
* });
* var exampleDatasetBinary = new Azure.DataFactory.DatasetBinary("example", new()
* {
* Name = "example",
* DataFactoryId = exampleFactory.Id,
* LinkedServiceName = exampleLinkedServiceSftp.Name,
* SftpServerLocation = new Azure.DataFactory.Inputs.DatasetBinarySftpServerLocationArgs
* {
* Path = "/test/",
* Filename = "**",
* },
* });
* });
* ```
* ```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"),
* 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
* }
* exampleLinkedServiceSftp, err := datafactory.NewLinkedServiceSftp(ctx, "example", &datafactory.LinkedServiceSftpArgs{
* Name: pulumi.String("example"),
* DataFactoryId: exampleFactory.ID(),
* AuthenticationType: pulumi.String("Basic"),
* Host: pulumi.String("http://www.bing.com"),
* Port: pulumi.Int(22),
* Username: pulumi.String("foo"),
* Password: pulumi.String("bar"),
* })
* if err != nil {
* return err
* }
* _, err = datafactory.NewDatasetBinary(ctx, "example", &datafactory.DatasetBinaryArgs{
* Name: pulumi.String("example"),
* DataFactoryId: exampleFactory.ID(),
* LinkedServiceName: exampleLinkedServiceSftp.Name,
* SftpServerLocation: &datafactory.DatasetBinarySftpServerLocationArgs{
* Path: pulumi.String("/test/"),
* Filename: pulumi.String("**"),
* },
* })
* 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.LinkedServiceSftp;
* import com.pulumi.azure.datafactory.LinkedServiceSftpArgs;
* import com.pulumi.azure.datafactory.DatasetBinary;
* import com.pulumi.azure.datafactory.DatasetBinaryArgs;
* import com.pulumi.azure.datafactory.inputs.DatasetBinarySftpServerLocationArgs;
* 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 exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
* .name("example")
* .location(example.location())
* .resourceGroupName(example.name())
* .build());
* var exampleLinkedServiceSftp = new LinkedServiceSftp("exampleLinkedServiceSftp", LinkedServiceSftpArgs.builder()
* .name("example")
* .dataFactoryId(exampleFactory.id())
* .authenticationType("Basic")
* .host("http://www.bing.com")
* .port(22)
* .username("foo")
* .password("bar")
* .build());
* var exampleDatasetBinary = new DatasetBinary("exampleDatasetBinary", DatasetBinaryArgs.builder()
* .name("example")
* .dataFactoryId(exampleFactory.id())
* .linkedServiceName(exampleLinkedServiceSftp.name())
* .sftpServerLocation(DatasetBinarySftpServerLocationArgs.builder()
* .path("/test/")
* .filename("**")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example
* location: West Europe
* exampleFactory:
* type: azure:datafactory:Factory
* name: example
* properties:
* name: example
* location: ${example.location}
* resourceGroupName: ${example.name}
* exampleLinkedServiceSftp:
* type: azure:datafactory:LinkedServiceSftp
* name: example
* properties:
* name: example
* dataFactoryId: ${exampleFactory.id}
* authenticationType: Basic
* host: http://www.bing.com
* port: 22
* username: foo
* password: bar
* exampleDatasetBinary:
* type: azure:datafactory:DatasetBinary
* name: example
* properties:
* name: example
* dataFactoryId: ${exampleFactory.id}
* linkedServiceName: ${exampleLinkedServiceSftp.name}
* sftpServerLocation:
* path: /test/
* filename: '**'
* ```
*
* ## Import
* Data Factory Binary Datasets can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:datafactory/datasetBinary:DatasetBinary example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/datasets/example
* ```
* @property additionalProperties A map of additional properties to associate with the Data Factory Binary Dataset.
* @property annotations List of tags that can be used for describing the Data Factory Binary Dataset.
* @property azureBlobStorageLocation A `azure_blob_storage_location` block as defined below.
* @property compression A `compression` block as defined below.
* @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 Dataset.
* @property folder The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
* @property httpServerLocation A `http_server_location` block as defined below.
* @property linkedServiceName The Data Factory Linked Service name in which to associate the Binary Dataset with.
* @property name Specifies the name of the Data Factory Binary Dataset. Changing this forces a new resource to be created. Must be globally unique. See the [Microsoft documentation](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions.
* @property parameters Specifies a list of parameters to associate with the Data Factory Binary Dataset.
* The following supported locations for a Binary Dataset. One of these should be specified:
* @property sftpServerLocation A `sftp_server_location` block as defined below.
*/
public data class DatasetBinaryArgs(
public val additionalProperties: Output>? = null,
public val annotations: Output>? = null,
public val azureBlobStorageLocation: Output? = null,
public val compression: Output? = null,
public val dataFactoryId: Output? = null,
public val description: Output? = null,
public val folder: Output? = null,
public val httpServerLocation: Output? = null,
public val linkedServiceName: Output? = null,
public val name: Output? = null,
public val parameters: Output>? = null,
public val sftpServerLocation: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.datafactory.DatasetBinaryArgs =
com.pulumi.azure.datafactory.DatasetBinaryArgs.builder()
.additionalProperties(
additionalProperties?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
)
.annotations(annotations?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.azureBlobStorageLocation(
azureBlobStorageLocation?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.compression(compression?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.dataFactoryId(dataFactoryId?.applyValue({ args0 -> args0 }))
.description(description?.applyValue({ args0 -> args0 }))
.folder(folder?.applyValue({ args0 -> args0 }))
.httpServerLocation(
httpServerLocation?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.linkedServiceName(linkedServiceName?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.parameters(
parameters?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
)
.sftpServerLocation(
sftpServerLocation?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
).build()
}
/**
* Builder for [DatasetBinaryArgs].
*/
@PulumiTagMarker
public class DatasetBinaryArgsBuilder internal constructor() {
private var additionalProperties: Output>? = null
private var annotations: Output>? = null
private var azureBlobStorageLocation: Output? = null
private var compression: Output? = null
private var dataFactoryId: Output? = null
private var description: Output? = null
private var folder: Output? = null
private var httpServerLocation: Output? = null
private var linkedServiceName: Output? = null
private var name: Output? = null
private var parameters: Output>? = null
private var sftpServerLocation: Output? = null
/**
* @param value A map of additional properties to associate with the Data Factory Binary Dataset.
*/
@JvmName("hkxgdqfetlrxldps")
public suspend fun additionalProperties(`value`: Output>) {
this.additionalProperties = value
}
/**
* @param value List of tags that can be used for describing the Data Factory Binary Dataset.
*/
@JvmName("bncnxjlhwbxwutxl")
public suspend fun annotations(`value`: Output>) {
this.annotations = value
}
@JvmName("pkjutkedrrxohsdn")
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 Binary Dataset.
*/
@JvmName("oyjavtapxwykowtu")
public suspend fun annotations(values: List>) {
this.annotations = Output.all(values)
}
/**
* @param value A `azure_blob_storage_location` block as defined below.
*/
@JvmName("ggqypkbvqggtbnrg")
public suspend fun azureBlobStorageLocation(`value`: Output) {
this.azureBlobStorageLocation = value
}
/**
* @param value A `compression` block as defined below.
*/
@JvmName("ubfbqmubvmkdmveu")
public suspend fun compression(`value`: Output) {
this.compression = value
}
/**
* @param value The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*/
@JvmName("ibpiwvfxhqsrbvro")
public suspend fun dataFactoryId(`value`: Output) {
this.dataFactoryId = value
}
/**
* @param value The description for the Data Factory Dataset.
*/
@JvmName("rhxmbrpupbnmgnyw")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
*/
@JvmName("jpmfnsrbqrteuoij")
public suspend fun folder(`value`: Output) {
this.folder = value
}
/**
* @param value A `http_server_location` block as defined below.
*/
@JvmName("hiiqflnawyjhwdxo")
public suspend fun httpServerLocation(`value`: Output) {
this.httpServerLocation = value
}
/**
* @param value The Data Factory Linked Service name in which to associate the Binary Dataset with.
*/
@JvmName("fvxacvhqlorveucb")
public suspend fun linkedServiceName(`value`: Output) {
this.linkedServiceName = value
}
/**
* @param value Specifies the name of the Data Factory Binary Dataset. Changing this forces a new resource to be created. Must be globally unique. See the [Microsoft documentation](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions.
*/
@JvmName("ilmesdpfcujeoifs")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value Specifies a list of parameters to associate with the Data Factory Binary Dataset.
* The following supported locations for a Binary Dataset. One of these should be specified:
*/
@JvmName("qdbbpqmunecvyemx")
public suspend fun parameters(`value`: Output>) {
this.parameters = value
}
/**
* @param value A `sftp_server_location` block as defined below.
*/
@JvmName("ftsxgfisbdmqftap")
public suspend fun sftpServerLocation(`value`: Output) {
this.sftpServerLocation = value
}
/**
* @param value A map of additional properties to associate with the Data Factory Binary Dataset.
*/
@JvmName("knxniqagentlltha")
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 Binary Dataset.
*/
@JvmName("bijbijxvbwjecqwm")
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 Binary Dataset.
*/
@JvmName("geawijerkfsmojoi")
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 Binary Dataset.
*/
@JvmName("ibdgqpgwncnahbte")
public suspend fun annotations(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.annotations = mapped
}
/**
* @param value A `azure_blob_storage_location` block as defined below.
*/
@JvmName("iuxyxvmntdxlwvmk")
public suspend fun azureBlobStorageLocation(`value`: DatasetBinaryAzureBlobStorageLocationArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.azureBlobStorageLocation = mapped
}
/**
* @param argument A `azure_blob_storage_location` block as defined below.
*/
@JvmName("ahumhrfbejxywofj")
public suspend fun azureBlobStorageLocation(argument: suspend DatasetBinaryAzureBlobStorageLocationArgsBuilder.() -> Unit) {
val toBeMapped = DatasetBinaryAzureBlobStorageLocationArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.azureBlobStorageLocation = mapped
}
/**
* @param value A `compression` block as defined below.
*/
@JvmName("eiegpdupcjvuwaaq")
public suspend fun compression(`value`: DatasetBinaryCompressionArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.compression = mapped
}
/**
* @param argument A `compression` block as defined below.
*/
@JvmName("orggyvycxfpukkjg")
public suspend fun compression(argument: suspend DatasetBinaryCompressionArgsBuilder.() -> Unit) {
val toBeMapped = DatasetBinaryCompressionArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.compression = mapped
}
/**
* @param value The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*/
@JvmName("nvsgyeyuianmhtgm")
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 Dataset.
*/
@JvmName("haijdnpqkmetiuas")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
*/
@JvmName("sueqitnsegfqpqwl")
public suspend fun folder(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.folder = mapped
}
/**
* @param value A `http_server_location` block as defined below.
*/
@JvmName("lbyplgxdoguaprxf")
public suspend fun httpServerLocation(`value`: DatasetBinaryHttpServerLocationArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.httpServerLocation = mapped
}
/**
* @param argument A `http_server_location` block as defined below.
*/
@JvmName("glogakppanhaymsc")
public suspend fun httpServerLocation(argument: suspend DatasetBinaryHttpServerLocationArgsBuilder.() -> Unit) {
val toBeMapped = DatasetBinaryHttpServerLocationArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.httpServerLocation = mapped
}
/**
* @param value The Data Factory Linked Service name in which to associate the Binary Dataset with.
*/
@JvmName("mcsncanlonqhceuy")
public suspend fun linkedServiceName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.linkedServiceName = mapped
}
/**
* @param value Specifies the name of the Data Factory Binary Dataset. Changing this forces a new resource to be created. Must be globally unique. See the [Microsoft documentation](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions.
*/
@JvmName("deletqbpkhffhbbg")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value Specifies a list of parameters to associate with the Data Factory Binary Dataset.
* The following supported locations for a Binary Dataset. One of these should be specified:
*/
@JvmName("dbekmbktkedlufax")
public suspend fun parameters(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.parameters = mapped
}
/**
* @param values Specifies a list of parameters to associate with the Data Factory Binary Dataset.
* The following supported locations for a Binary Dataset. One of these should be specified:
*/
@JvmName("hiogkawbwkplbiwu")
public fun parameters(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.parameters = mapped
}
/**
* @param value A `sftp_server_location` block as defined below.
*/
@JvmName("miueytrivbfgqxst")
public suspend fun sftpServerLocation(`value`: DatasetBinarySftpServerLocationArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.sftpServerLocation = mapped
}
/**
* @param argument A `sftp_server_location` block as defined below.
*/
@JvmName("phewgnivamvoirgk")
public suspend fun sftpServerLocation(argument: suspend DatasetBinarySftpServerLocationArgsBuilder.() -> Unit) {
val toBeMapped = DatasetBinarySftpServerLocationArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.sftpServerLocation = mapped
}
internal fun build(): DatasetBinaryArgs = DatasetBinaryArgs(
additionalProperties = additionalProperties,
annotations = annotations,
azureBlobStorageLocation = azureBlobStorageLocation,
compression = compression,
dataFactoryId = dataFactoryId,
description = description,
folder = folder,
httpServerLocation = httpServerLocation,
linkedServiceName = linkedServiceName,
name = name,
parameters = parameters,
sftpServerLocation = sftpServerLocation,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy