pulumi-azure-kotlin/com.pulumi.azure.datafactory.kotlin/DatasetAzureBlob

DatasetAzureBlob

class DatasetAzureBlob : KotlinCustomResource

Manages an Azure Blob Dataset inside an Azure Data Factory.

Example Usage

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",
});
Content copied to clipboard
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")
Content copied to clipboard
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",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/datafactory"
	"github.com/pulumi/pulumi-azure/sdk/v6/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
	})
}
Content copied to clipboard
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(_example -> _example.primaryConnectionString()))
            .build());
        var exampleDatasetAzureBlob = new DatasetAzureBlob("exampleDatasetAzureBlob", DatasetAzureBlobArgs.builder()
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .linkedServiceName(exampleLinkedServiceAzureBlobStorage.name())
            .path("foo")
            .filename("bar.png")
            .build());
    }
}
Content copied to clipboard
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}
Content copied to clipboard

Import

Data Factory Datasets can be imported using the resource id, e.g.

$ pulumi import azure:datafactory/datasetAzureBlob:DatasetAzureBlob example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/datasets/example
Content copied to clipboard

Properties

Link copied to clipboard
val additionalProperties: Output<Map<String, String>>?

A map of additional properties to associate with the Data Factory Dataset. The following supported arguments are specific to Azure Blob Dataset:

Link copied to clipboard
val annotations: Output<List<String>>?

List of tags that can be used for describing the Data Factory Dataset.

Link copied to clipboard
val dataFactoryId: Output<String>

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

Link copied to clipboard
val description: Output<String>?

The description for the Data Factory Dataset.

Link copied to clipboard
val dynamicFilenameEnabled: Output<Boolean>?

Is the filename using dynamic expression, function or system variables? Defaults to false.

Link copied to clipboard
val dynamicPathEnabled: Output<Boolean>?

Is the path using dynamic expression, function or system variables? Defaults to false.

Link copied to clipboard
val filename: Output<String>?

The filename of the Azure Blob.

Link copied to clipboard
val folder: Output<String>?

The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val linkedServiceName: Output<String>

The Data Factory Linked Service name in which to associate the Dataset with.

Link copied to clipboard
val name: Output<String>

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 for all restrictions.

Link copied to clipboard
val parameters: Output<Map<String, String>>?

A map of parameters to associate with the Data Factory Dataset.

Link copied to clipboard
val path: Output<String>?

The path of the Azure Blob.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val schemaColumns: Output<List<DatasetAzureBlobSchemaColumn>>?

A schema_column block as defined below.

Link copied to clipboard
val urn: Output<String>