ExcelDataset Class

Definition

Namespace:

Azure.ResourceManager.DataFactory.Models

Assembly:

Azure.ResourceManager.DataFactory.dll

Package:

Azure.ResourceManager.DataFactory v1.5.0

Source:

ExcelDataset.cs

Excel dataset.

public class ExcelDataset : Azure.ResourceManager.DataFactory.Models.DataFactoryDatasetProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.ExcelDataset>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.ExcelDataset>

type ExcelDataset = class
    inherit DataFactoryDatasetProperties
    interface IJsonModel<ExcelDataset>
    interface IPersistableModel<ExcelDataset>

Public Class ExcelDataset
Inherits DataFactoryDatasetProperties
Implements IJsonModel(Of ExcelDataset), IPersistableModel(Of ExcelDataset)

Inheritance

Object

DataFactoryDatasetProperties

ExcelDataset

Implements

IJsonModel<ExcelDataset> IPersistableModel<ExcelDataset> IPersistableModel<T>

Constructors

ExcelDataset(DataFactoryLinkedServiceReference)

Initializes a new instance of ExcelDataset.

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 json dataset.
DataLocation	The location of the excel storage. Please note DatasetLocation 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 AmazonS3CompatibleLocation, AmazonS3Location, AzureBlobFSLocation, AzureBlobStorageLocation, AzureDataLakeStoreLocation, AzureFileStorageLocation, FileServerLocation, FtpServerLocation, GoogleCloudStorageLocation, HdfsLocation, HttpServerLocation, LakeHouseLocation, OracleCloudStorageLocation and SftpLocation.
Description	Dataset description. (Inherited from DataFactoryDatasetProperties)
FirstRowAsHeader	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).
FolderName	The name of the folder that this Dataset is in. (Inherited from DataFactoryDatasetProperties)
LinkedServiceName	Linked service reference. (Inherited from DataFactoryDatasetProperties)
NullValue	The null value string. Type: string (or Expression with resultType string).
Parameters	Parameters for dataset. (Inherited from DataFactoryDatasetProperties)
Range	The partial data of one sheet. Type: string (or Expression with resultType string).
Schema	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. (Inherited from DataFactoryDatasetProperties)
SheetIndex	The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer).
SheetName	The sheet name of excel file. Type: string (or Expression with resultType string).
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)

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<ExcelDataset>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ExcelDataset>.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<ExcelDataset>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ExcelDataset>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ExcelDataset>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.