All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.datafactory.kotlin.DatasetAzureBlob.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.datafactory.kotlin

import com.pulumi.azure.datafactory.kotlin.outputs.DatasetAzureBlobSchemaColumn
import com.pulumi.azure.datafactory.kotlin.outputs.DatasetAzureBlobSchemaColumn.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 [DatasetAzureBlob].
 */
@PulumiTagMarker
public class DatasetAzureBlobResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: DatasetAzureBlobArgs = DatasetAzureBlobArgs()

    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 DatasetAzureBlobArgsBuilder.() -> Unit) {
        val builder = DatasetAzureBlobArgsBuilder()
        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(): DatasetAzureBlob {
        val builtJavaResource = com.pulumi.azure.datafactory.DatasetAzureBlob(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return DatasetAzureBlob(builtJavaResource)
    }
}

/**
 * Manages an Azure Blob Dataset inside an 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 exampleLinkedServiceAzureBlobStorage = new azure.datafactory.LinkedServiceAzureBlobStorage("example", {
 *     name: "example",
 *     dataFactoryId: exampleFactory.id,
 *     connectionString: example.apply(example => example.primaryConnectionString),
 * });
 * const exampleDatasetAzureBlob = new azure.datafactory.DatasetAzureBlob("example", {
 *     name: "example",
 *     dataFactoryId: exampleFactory.id,
 *     linkedServiceName: exampleLinkedServiceAzureBlobStorage.name,
 *     path: "foo",
 *     filename: "bar.png",
 * });
 * ```
 * ```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_blob_storage = azure.datafactory.LinkedServiceAzureBlobStorage("example",
 *     name="example",
 *     data_factory_id=example_factory.id,
 *     connection_string=example.primary_connection_string)
 * example_dataset_azure_blob = azure.datafactory.DatasetAzureBlob("example",
 *     name="example",
 *     data_factory_id=example_factory.id,
 *     linked_service_name=example_linked_service_azure_blob_storage.name,
 *     path="foo",
 *     filename="bar.png")
 * ```
 * ```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 exampleLinkedServiceAzureBlobStorage = new Azure.DataFactory.LinkedServiceAzureBlobStorage("example", new()
 *     {
 *         Name = "example",
 *         DataFactoryId = exampleFactory.Id,
 *         ConnectionString = example.Apply(getAccountResult => getAccountResult.PrimaryConnectionString),
 *     });
 *     var exampleDatasetAzureBlob = new Azure.DataFactory.DatasetAzureBlob("example", new()
 *     {
 *         Name = "example",
 *         DataFactoryId = exampleFactory.Id,
 *         LinkedServiceName = exampleLinkedServiceAzureBlobStorage.Name,
 *         Path = "foo",
 *         Filename = "bar.png",
 *     });
 * });
 * ```
 * ```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
 * 		}
 * 		exampleLinkedServiceAzureBlobStorage, err := datafactory.NewLinkedServiceAzureBlobStorage(ctx, "example", &datafactory.LinkedServiceAzureBlobStorageArgs{
 * 			Name:          pulumi.String("example"),
 * 			DataFactoryId: exampleFactory.ID(),
 * 			ConnectionString: pulumi.String(example.ApplyT(func(example storage.GetAccountResult) (*string, error) {
 * 				return &example.PrimaryConnectionString, nil
 * 			}).(pulumi.StringPtrOutput)),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = datafactory.NewDatasetAzureBlob(ctx, "example", &datafactory.DatasetAzureBlobArgs{
 * 			Name:              pulumi.String("example"),
 * 			DataFactoryId:     exampleFactory.ID(),
 * 			LinkedServiceName: exampleLinkedServiceAzureBlobStorage.Name,
 * 			Path:              pulumi.String("foo"),
 * 			Filename:          pulumi.String("bar.png"),
 * 		})
 * 		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.LinkedServiceAzureBlobStorage;
 * import com.pulumi.azure.datafactory.LinkedServiceAzureBlobStorageArgs;
 * import com.pulumi.azure.datafactory.DatasetAzureBlob;
 * import com.pulumi.azure.datafactory.DatasetAzureBlobArgs;
 * 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 exampleLinkedServiceAzureBlobStorage = new LinkedServiceAzureBlobStorage("exampleLinkedServiceAzureBlobStorage", LinkedServiceAzureBlobStorageArgs.builder()
 *             .name("example")
 *             .dataFactoryId(exampleFactory.id())
 *             .connectionString(example.applyValue(getAccountResult -> getAccountResult).applyValue(example -> example.applyValue(getAccountResult -> getAccountResult.primaryConnectionString())))
 *             .build());
 *         var exampleDatasetAzureBlob = new DatasetAzureBlob("exampleDatasetAzureBlob", DatasetAzureBlobArgs.builder()
 *             .name("example")
 *             .dataFactoryId(exampleFactory.id())
 *             .linkedServiceName(exampleLinkedServiceAzureBlobStorage.name())
 *             .path("foo")
 *             .filename("bar.png")
 *             .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}
 *   exampleLinkedServiceAzureBlobStorage:
 *     type: azure:datafactory:LinkedServiceAzureBlobStorage
 *     name: example
 *     properties:
 *       name: example
 *       dataFactoryId: ${exampleFactory.id}
 *       connectionString: ${example.primaryConnectionString}
 *   exampleDatasetAzureBlob:
 *     type: azure:datafactory:DatasetAzureBlob
 *     name: example
 *     properties:
 *       name: example
 *       dataFactoryId: ${exampleFactory.id}
 *       linkedServiceName: ${exampleLinkedServiceAzureBlobStorage.name}
 *       path: foo
 *       filename: bar.png
 * variables:
 *   example:
 *     fn::invoke:
 *       Function: azure:storage:getAccount
 *       Arguments:
 *         name: storageaccountname
 *         resourceGroupName: ${exampleResourceGroup.name}
 * ```
 * 
 * ## Import
 * Data Factory Datasets can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:datafactory/datasetAzureBlob:DatasetAzureBlob example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/datasets/example
 * ```
 */
public class DatasetAzureBlob internal constructor(
    override val javaResource: com.pulumi.azure.datafactory.DatasetAzureBlob,
) : KotlinCustomResource(javaResource, DatasetAzureBlobMapper) {
    /**
     * A map of additional properties to associate with the Data Factory Dataset.
     * The following supported arguments are specific to Azure Blob Dataset:
     */
    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 Dataset.
     */
    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 Dataset.
     */
    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Is the `filename` using dynamic expression, function or system variables? Defaults to `false`.
     */
    public val dynamicFilenameEnabled: Output?
        get() = javaResource.dynamicFilenameEnabled().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Is the `path` using dynamic expression, function or system variables? Defaults to `false`.
     */
    public val dynamicPathEnabled: Output?
        get() = javaResource.dynamicPathEnabled().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The filename of the Azure Blob.
     */
    public val filename: Output?
        get() = javaResource.filename().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
     */
    public val folder: Output?
        get() = javaResource.folder().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The Data Factory Linked Service name in which to associate the Dataset with.
     */
    public val linkedServiceName: Output
        get() = javaResource.linkedServiceName().applyValue({ args0 -> args0 })

    /**
     * Specifies the name of the Data Factory 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.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * A map of parameters to associate with the Data Factory Dataset.
     */
    public val parameters: Output>?
        get() = javaResource.parameters().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.key.to(args0.value)
                }).toMap()
            }).orElse(null)
        })

    /**
     * The path of the Azure Blob.
     */
    public val path: Output?
        get() = javaResource.path().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * A `schema_column` block as defined below.
     */
    public val schemaColumns: Output>?
        get() = javaResource.schemaColumns().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 -> args0.let({ args0 -> toKotlin(args0) }) })
            }).orElse(null)
        })
}

public object DatasetAzureBlobMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.datafactory.DatasetAzureBlob::class == javaResource::class

    override fun map(javaResource: Resource): DatasetAzureBlob = DatasetAzureBlob(
        javaResource as
            com.pulumi.azure.datafactory.DatasetAzureBlob,
    )
}

/**
 * @see [DatasetAzureBlob].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [DatasetAzureBlob].
 */
public suspend fun datasetAzureBlob(
    name: String,
    block: suspend DatasetAzureBlobResourceBuilder.() -> Unit,
): DatasetAzureBlob {
    val builder = DatasetAzureBlobResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [DatasetAzureBlob].
 * @param name The _unique_ name of the resulting resource.
 */
public fun datasetAzureBlob(name: String): DatasetAzureBlob {
    val builder = DatasetAzureBlobResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy