Class ExcelDataset

Excel dataset.

Inheritance
System.Object
DataFactoryDatasetProperties
ExcelDataset
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.DataFactory.dll
Syntax
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>

Constructors

ExcelDataset(DataFactoryLinkedServiceReference)

Initializes a new instance of ExcelDataset.

Declaration
public ExcelDataset (Azure.Core.Expressions.DataFactory.DataFactoryLinkedServiceReference linkedServiceName);
Parameters
Azure.Core.Expressions.DataFactory.DataFactoryLinkedServiceReference linkedServiceName

Linked service reference.
Exceptions
System.ArgumentNullException

linkedServiceName is null.

Properties

Compression

The data compression method used for the json dataset.

Declaration
public Azure.ResourceManager.DataFactory.Models.DatasetCompression Compression { get; set; }
Property Value
DatasetCompression

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.

Declaration
public Azure.ResourceManager.DataFactory.Models.DatasetLocation DataLocation { get; set; }
Property Value
DatasetLocation

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).

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<bool> FirstRowAsHeader { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.Boolean>

NullValue

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> NullValue { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

Range

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> Range { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

SheetIndex

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<int> SheetIndex { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.Int32>

SheetName

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> SheetName { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration
protected override void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The JSON writer.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The client options for reading and writing models.

Explicit Interface Implementations

IJsonModel<ExcelDataset>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

Declaration
Azure.ResourceManager.DataFactory.Models.ExcelDataset IJsonModel<ExcelDataset>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonReader reader

The System.Text.Json.Utf8JsonReader to read.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
ExcelDataset

A T representation of the JSON value.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<ExcelDataset>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration
void IJsonModel<ExcelDataset>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The System.Text.Json.Utf8JsonWriter to write into.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<ExcelDataset>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.DataFactory.Models.ExcelDataset IPersistableModel<ExcelDataset>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.BinaryData data

The System.BinaryData to parse.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
ExcelDataset

A T representation of the data.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<ExcelDataset>.GetFormatFromOptions(ModelReaderWriterOptions)

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

Declaration
string IPersistableModel<ExcelDataset>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.
Returns
System.String

The format that the model uses when communicating with the service.

IPersistableModel<ExcelDataset>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<ExcelDataset>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
System.BinaryData

A binary representation of the written model.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.