import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages an Azure Delimited Text 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-resources", * location: "West Europe", * }); * const exampleFactory = new azure.datafactory.Factory("example", { * name: "example", * location: example.location, * resourceGroupName: example.name, * }); * const exampleLinkedServiceWeb = new azure.datafactory.LinkedServiceWeb("example", { * name: "example", * dataFactoryId: exampleFactory.id, * authenticationType: "Anonymous", * url: "https://www.bing.com", * }); * const exampleDatasetDelimitedText = new azure.datafactory.DatasetDelimitedText("example", { * name: "example", * dataFactoryId: exampleFactory.id, * linkedServiceName: exampleLinkedServiceWeb.name, * httpServerLocation: { * relativeUrl: "http://www.bing.com", * path: "foo/bar/", * filename: "fizz.txt", * }, * columnDelimiter: ",", * rowDelimiter: "NEW", * encoding: "UTF-8", * quoteCharacter: "x", * escapeCharacter: "f", * firstRowAsHeader: true, * nullValue: "NULL", * }); * ``` * * ## Import * * Data Factory Datasets can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:datafactory/datasetDelimitedText:DatasetDelimitedText example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/datasets/example * ``` */ export declare class DatasetDelimitedText extends pulumi.CustomResource { /** * Get an existing DatasetDelimitedText resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: DatasetDelimitedTextState, opts?: pulumi.CustomResourceOptions): DatasetDelimitedText; /** * Returns true if the given object is an instance of DatasetDelimitedText. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is DatasetDelimitedText; /** * 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): */ readonly additionalProperties: pulumi.Output<{ [key: string]: string; } | undefined>; /** * List of tags that can be used for describing the Data Factory Dataset. */ readonly annotations: pulumi.Output; /** * An `azureBlobFsLocation` block as defined below. */ readonly azureBlobFsLocation: pulumi.Output; /** * An `azureBlobStorageLocation` block as defined below. */ readonly azureBlobStorageLocation: pulumi.Output; /** * The column delimiter. Defaults to `,`. */ readonly columnDelimiter: pulumi.Output; /** * 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. */ readonly compressionCodec: pulumi.Output; /** * The compression ratio for the Data Factory Dataset. Valid values are `Fastest` or `Optimal`. Please note these values are case sensitive. */ readonly compressionLevel: pulumi.Output; /** * The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource. */ readonly dataFactoryId: pulumi.Output; /** * The description for the Data Factory Dataset. */ readonly description: pulumi.Output; /** * The encoding format for the file. */ readonly encoding: pulumi.Output; /** * The escape character. Defaults to `\`. */ readonly escapeCharacter: pulumi.Output; /** * 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`. */ readonly firstRowAsHeader: pulumi.Output; /** * The folder that this Dataset is in. If not specified, the Dataset will appear at the root level. */ readonly folder: pulumi.Output; /** * A `httpServerLocation` block as defined below. * * The following supported arguments are specific to Delimited Text Dataset: */ readonly httpServerLocation: pulumi.Output; /** * The Data Factory Linked Service name in which to associate the Dataset with. */ readonly linkedServiceName: pulumi.Output; /** * 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. */ readonly name: pulumi.Output; /** * The null value string. Defaults to `""`. */ readonly nullValue: pulumi.Output; /** * A map of parameters to associate with the Data Factory Dataset. */ readonly parameters: pulumi.Output<{ [key: string]: string; } | undefined>; /** * The quote character. Defaults to `"`. */ readonly quoteCharacter: pulumi.Output; /** * 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. */ readonly rowDelimiter: pulumi.Output; /** * A `schemaColumn` block as defined below. */ readonly schemaColumns: pulumi.Output; /** * Create a DatasetDelimitedText resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: DatasetDelimitedTextArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering DatasetDelimitedText resources. */ export interface DatasetDelimitedTextState { /** * 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): */ additionalProperties?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * List of tags that can be used for describing the Data Factory Dataset. */ annotations?: pulumi.Input[]>; /** * An `azureBlobFsLocation` block as defined below. */ azureBlobFsLocation?: pulumi.Input; /** * An `azureBlobStorageLocation` block as defined below. */ azureBlobStorageLocation?: pulumi.Input; /** * The column delimiter. Defaults to `,`. */ columnDelimiter?: pulumi.Input; /** * 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. */ compressionCodec?: pulumi.Input; /** * The compression ratio for the Data Factory Dataset. Valid values are `Fastest` or `Optimal`. Please note these values are case sensitive. */ compressionLevel?: pulumi.Input; /** * The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource. */ dataFactoryId?: pulumi.Input; /** * The description for the Data Factory Dataset. */ description?: pulumi.Input; /** * The encoding format for the file. */ encoding?: pulumi.Input; /** * The escape character. Defaults to `\`. */ escapeCharacter?: pulumi.Input; /** * 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`. */ firstRowAsHeader?: pulumi.Input; /** * The folder that this Dataset is in. If not specified, the Dataset will appear at the root level. */ folder?: pulumi.Input; /** * A `httpServerLocation` block as defined below. * * The following supported arguments are specific to Delimited Text Dataset: */ httpServerLocation?: pulumi.Input; /** * The Data Factory Linked Service name in which to associate the Dataset with. */ linkedServiceName?: pulumi.Input; /** * 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. */ name?: pulumi.Input; /** * The null value string. Defaults to `""`. */ nullValue?: pulumi.Input; /** * A map of parameters to associate with the Data Factory Dataset. */ parameters?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * The quote character. Defaults to `"`. */ quoteCharacter?: pulumi.Input; /** * 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. */ rowDelimiter?: pulumi.Input; /** * A `schemaColumn` block as defined below. */ schemaColumns?: pulumi.Input[]>; } /** * The set of arguments for constructing a DatasetDelimitedText resource. */ export interface DatasetDelimitedTextArgs { /** * 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): */ additionalProperties?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * List of tags that can be used for describing the Data Factory Dataset. */ annotations?: pulumi.Input[]>; /** * An `azureBlobFsLocation` block as defined below. */ azureBlobFsLocation?: pulumi.Input; /** * An `azureBlobStorageLocation` block as defined below. */ azureBlobStorageLocation?: pulumi.Input; /** * The column delimiter. Defaults to `,`. */ columnDelimiter?: pulumi.Input; /** * 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. */ compressionCodec?: pulumi.Input; /** * The compression ratio for the Data Factory Dataset. Valid values are `Fastest` or `Optimal`. Please note these values are case sensitive. */ compressionLevel?: pulumi.Input; /** * The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource. */ dataFactoryId: pulumi.Input; /** * The description for the Data Factory Dataset. */ description?: pulumi.Input; /** * The encoding format for the file. */ encoding?: pulumi.Input; /** * The escape character. Defaults to `\`. */ escapeCharacter?: pulumi.Input; /** * 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`. */ firstRowAsHeader?: pulumi.Input; /** * The folder that this Dataset is in. If not specified, the Dataset will appear at the root level. */ folder?: pulumi.Input; /** * A `httpServerLocation` block as defined below. * * The following supported arguments are specific to Delimited Text Dataset: */ httpServerLocation?: pulumi.Input; /** * The Data Factory Linked Service name in which to associate the Dataset with. */ linkedServiceName: pulumi.Input; /** * 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. */ name?: pulumi.Input; /** * The null value string. Defaults to `""`. */ nullValue?: pulumi.Input; /** * A map of parameters to associate with the Data Factory Dataset. */ parameters?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * The quote character. Defaults to `"`. */ quoteCharacter?: pulumi.Input; /** * 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. */ rowDelimiter?: pulumi.Input; /** * A `schemaColumn` block as defined below. */ schemaColumns?: pulumi.Input[]>; }