FileShareDataset Class

Reference

An on-premises file system dataset.

All required parameters must be populated in order to send to server.

Inheritance: azure.mgmt.datafactory.models._models_py3.Dataset

FileShareDataset

Constructor

FileShareDataset(*, linked_service_name: _models.LinkedServiceReference, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None, structure: MutableMapping[str, Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder | None = None, folder_path: MutableMapping[str, Any] | None = None, file_name: MutableMapping[str, Any] | None = None, modified_datetime_start: MutableMapping[str, Any] | None = None, modified_datetime_end: MutableMapping[str, Any] | None = None, format: _models.DatasetStorageFormat | None = None, file_filter: MutableMapping[str, Any] | None = None, compression: _models.DatasetCompression | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
description	str Dataset description.
structure	<xref:JSON> Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
schema	<xref:JSON> Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
linked_service_name	LinkedServiceReference Linked service reference. Required.
parameters	dict[str, ParameterSpecification] Parameters for dataset.
annotations	list[<xref:JSON>] List of tags that can be used for describing the Dataset.
folder	DatasetFolder The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
folder_path	<xref:JSON> The path of the on-premises file system. Type: string (or Expression with resultType string).
file_name	<xref:JSON> The name of the on-premises file system. Type: string (or Expression with resultType string).
modified_datetime_start	<xref:JSON> The start of file's modified datetime. Type: string (or Expression with resultType string).
modified_datetime_end	<xref:JSON> The end of file's modified datetime. Type: string (or Expression with resultType string).
format	DatasetStorageFormat The format of the files.
file_filter	<xref:JSON> 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).
compression	DatasetCompression The data compression method used for the file system.

Variables

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
type	str Type of dataset. Required.
description	str Dataset description.
structure	<xref:JSON> Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
schema	<xref:JSON> Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
linked_service_name	LinkedServiceReference Linked service reference. Required.
parameters	dict[str, ParameterSpecification] Parameters for dataset.
annotations	list[<xref:JSON>] List of tags that can be used for describing the Dataset.
folder	DatasetFolder The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
folder_path	<xref:JSON> The path of the on-premises file system. Type: string (or Expression with resultType string).
file_name	<xref:JSON> The name of the on-premises file system. Type: string (or Expression with resultType string).
modified_datetime_start	<xref:JSON> The start of file's modified datetime. Type: string (or Expression with resultType string).
modified_datetime_end	<xref:JSON> The end of file's modified datetime. Type: string (or Expression with resultType string).
format	DatasetStorageFormat The format of the files.
file_filter	<xref:JSON> 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).
compression	DatasetCompression The data compression method used for the file system.

Share via

FileShareDataset Class

Constructor

Keyword-Only Parameters

Variables

Additional resources