ExcelDataset Class

Excel dataset.

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

Inheritance

azure.mgmt.datafactory.models._models_py3.Dataset

ExcelDataset

Constructor

ExcelDataset(*, linked_service_name: _models.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, _models.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[_models.DatasetFolder] = None, location: Optional[_models.DatasetLocation] = None, sheet_name: Optional[Any] = None, sheet_index: Optional[Any] = None, range: Optional[Any] = None, first_row_as_header: Optional[Any] = None, compression: Optional[_models.DatasetCompression] = None, null_value: Optional[Any] = None, **kwargs)

Variables

additional_properties

dict[str, any]

Unmatched properties from the message are deserialized to this collection.

type

str

Required. Type of dataset.Constant filled by server.

description

str

Dataset description.

structure

any

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

schema

any

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

linked_service_name

LinkedServiceReference

Required. Linked service reference.

parameters

dict[str, ParameterSpecification]

Parameters for dataset.

annotations

list[any]

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

any

The sheet name of excel file. Type: string (or Expression with resultType string).

sheet_index

any

The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer).

range

any

The partial data of one sheet. Type: string (or Expression with resultType string).

first_row_as_header

any

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

any

The null value string. Type: string (or Expression with resultType string).