Share via


FileShareDataset Class

Definition

An on-premises file system dataset.

public class FileShareDataset : Azure.ResourceManager.DataFactory.Models.DataFactoryDatasetProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.FileShareDataset>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.FileShareDataset>
public class FileShareDataset : Azure.ResourceManager.DataFactory.Models.DataFactoryDatasetProperties
type FileShareDataset = class
    inherit DataFactoryDatasetProperties
    interface IJsonModel<FileShareDataset>
    interface IPersistableModel<FileShareDataset>
type FileShareDataset = class
    inherit DataFactoryDatasetProperties
Public Class FileShareDataset
Inherits DataFactoryDatasetProperties
Implements IJsonModel(Of FileShareDataset), IPersistableModel(Of FileShareDataset)
Public Class FileShareDataset
Inherits DataFactoryDatasetProperties
Inheritance
Implements

Constructors

FileShareDataset(DataFactoryLinkedServiceReference)

Initializes a new instance of FileShareDataset.

Properties

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from DataFactoryDatasetProperties)
Annotations

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

To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from DataFactoryDatasetProperties)
Compression

The data compression method used for the file system.

Description

Dataset description.

(Inherited from DataFactoryDatasetProperties)
FileFilter

Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).

FileName

The name of the on-premises file system. Type: string (or Expression with resultType string).

FolderName

The name of the folder that this Dataset is in.

(Inherited from DataFactoryDatasetProperties)
FolderPath

The path of the on-premises file system. Type: string (or Expression with resultType string).

Format

The format of the files. Please note DatasetStorageFormat is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include DatasetAvroFormat, DatasetJsonFormat, DatasetOrcFormat, DatasetParquetFormat and DatasetTextFormat.

LinkedServiceName

Linked service reference.

(Inherited from DataFactoryDatasetProperties)
ModifiedDatetimeEnd

The end of file's modified datetime. Type: string (or Expression with resultType string).

ModifiedDatetimeStart

The start of file's modified datetime. Type: string (or Expression with resultType string).

Parameters

Parameters for dataset.

(Inherited from DataFactoryDatasetProperties)
Schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

(Inherited from DataFactoryDatasetProperties)
Structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

(Inherited from DataFactoryDatasetProperties)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from DataFactoryDatasetProperties)

Explicit Interface Implementations

IJsonModel<DataFactoryDatasetProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from DataFactoryDatasetProperties)
IJsonModel<DataFactoryDatasetProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from DataFactoryDatasetProperties)
IJsonModel<FileShareDataset>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<FileShareDataset>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<DataFactoryDatasetProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from DataFactoryDatasetProperties)
IPersistableModel<DataFactoryDatasetProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from DataFactoryDatasetProperties)
IPersistableModel<DataFactoryDatasetProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from DataFactoryDatasetProperties)
IPersistableModel<FileShareDataset>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<FileShareDataset>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<FileShareDataset>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to