ExcelDataset Class

Reference

Excel dataset.

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

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

ExcelDataset

Constructor

ExcelDataset(*, 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, location: _models.DatasetLocation | None = None, sheet_name: MutableMapping[str, Any] | None = None, sheet_index: MutableMapping[str, Any] | None = None, range: MutableMapping[str, Any] | None = None, first_row_as_header: MutableMapping[str, Any] | None = None, compression: _models.DatasetCompression | None = None, null_value: MutableMapping[str, Any] | 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.
location	DatasetLocation The location of the excel storage.
sheet_name	<xref:JSON> The sheet name of excel file. Type: string (or Expression with resultType string).
sheet_index	<xref:JSON> The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer).
range	<xref:JSON> The partial data of one sheet. Type: string (or Expression with resultType string).
first_row_as_header	<xref:JSON> 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. The default value is false. Type: boolean (or Expression with resultType boolean).
compression	DatasetCompression The data compression method used for the json dataset.
null_value	<xref:JSON> The null value string. Type: string (or Expression with resultType string).

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.
location	DatasetLocation The location of the excel storage.
sheet_name	<xref:JSON> The sheet name of excel file. Type: string (or Expression with resultType string).
sheet_index	<xref:JSON> The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer).
range	<xref:JSON> The partial data of one sheet. Type: string (or Expression with resultType string).
first_row_as_header	<xref:JSON> 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. The default value is false. Type: boolean (or Expression with resultType boolean).
compression	DatasetCompression The data compression method used for the json dataset.
null_value	<xref:JSON> The null value string. Type: string (or Expression with resultType string).

Share via

ExcelDataset Class

Constructor

Keyword-Only Parameters

Variables

Additional resources