DatasetDelimitedText

class DatasetDelimitedText : KotlinCustomResource

Manages an Azure Delimited Text Dataset inside an Azure Data Factory.

Example Usage

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.LinkedServiceWeb;
import com.pulumi.azure.datafactory.LinkedServiceWebArgs;
import com.pulumi.azure.datafactory.DatasetDelimitedText;
import com.pulumi.azure.datafactory.DatasetDelimitedTextArgs;
import com.pulumi.azure.datafactory.inputs.DatasetDelimitedTextHttpServerLocationArgs;
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()
.location("West Europe")
.build());
var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.build());
var exampleLinkedServiceWeb = new LinkedServiceWeb("exampleLinkedServiceWeb", LinkedServiceWebArgs.builder()
.dataFactoryId(exampleFactory.id())
.authenticationType("Anonymous")
.url("https://www.bing.com")
.build());
var exampleDatasetDelimitedText = new DatasetDelimitedText("exampleDatasetDelimitedText", DatasetDelimitedTextArgs.builder()
.dataFactoryId(exampleFactory.id())
.linkedServiceName(exampleLinkedServiceWeb.name())
.httpServerLocation(DatasetDelimitedTextHttpServerLocationArgs.builder()
.relativeUrl("http://www.bing.com")
.path("foo/bar/")
.filename("fizz.txt")
.build())
.columnDelimiter(",")
.rowDelimiter("NEW")
.encoding("UTF-8")
.quoteCharacter("x")
.escapeCharacter("f")
.firstRowAsHeader(true)
.nullValue("NULL")
.build());
}
}

Import

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

$ pulumi import azure:datafactory/datasetDelimitedText:DatasetDelimitedText example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/datasets/example

Properties

Link copied to clipboard

A map of additional properties to associate with the Data Factory Dataset. The following supported locations for a Delimited Text Dataset (exactly one of them must be set):

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

An azure_blob_fs_location block as defined below.

Link copied to clipboard

An azure_blob_storage_location block as defined below.

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

The column delimiter. Defaults to ,.

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

The compression codec used to read/write text files. Valid values are None, bzip2, gzip, deflate, ZipDeflate, TarGzip, Tar, snappy and lz4. Please note these values are case sensitive.

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

The compression ratio for the Data Factory Dataset. Valid values are Fastest or Optimal. Please note these values are case sensitive.

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 encoding: Output<String>?

The encoding format for the file.

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

The escape character. Defaults to \.

Link copied to clipboard

When used as input, treat the first row of data as headers. When used as output, write the headers into the output as the first row of data. Defaults to false.

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

A http_server_location block as defined below. The following supported arguments are specific to Delimited Text Dataset:

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

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 nullValue: Output<String>?

The null value string. Defaults to an empty string. Defaults to "".

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 pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val quoteCharacter: Output<String>?

The quote character. Defaults to ".

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

The row delimiter. Defaults to any of the following values on read: \r\n, \r, \n, and \n or \r\n on write by mapping data flow and Copy activity respectively.

Link copied to clipboard

A schema_column block as defined below.

Link copied to clipboard
val urn: Output<String>