Class DataFactoryDatasetProperties
The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents. Please note DataFactoryDatasetProperties 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 AmazonMwsObjectDataset, AmazonRdsForOracleTableDataset, AmazonRdsForSqlServerTableDataset, AmazonRedshiftTableDataset, AmazonS3Dataset, AvroDataset, AzureBlobDataset, AzureBlobFSDataset, AzureDatabricksDeltaLakeDataset, AzureDataExplorerTableDataset, AzureDataLakeStoreDataset, AzureMariaDBTableDataset, AzureMySqlTableDataset, AzurePostgreSqlTableDataset, AzureSearchIndexDataset, AzureSqlDWTableDataset, AzureSqlMITableDataset, AzureSqlTableDataset, AzureTableDataset, BinaryDataset, CassandraTableDataset, CommonDataServiceForAppsEntityDataset, ConcurObjectDataset, CosmosDBMongoDBApiCollectionDataset, CosmosDBSqlApiCollectionDataset, CouchbaseTableDataset, CustomDataset, Db2TableDataset, DelimitedTextDataset, DocumentDBCollectionDataset, DrillTableDataset, DynamicsAXResourceDataset, DynamicsCrmEntityDataset, DynamicsEntityDataset, EloquaObjectDataset, ExcelDataset, FileShareDataset, GoogleAdWordsObjectDataset, GoogleBigQueryObjectDataset, GoogleBigQueryV2ObjectDataset, GreenplumTableDataset, HBaseObjectDataset, HiveObjectDataset, DataFactoryHttpDataset, HubspotObjectDataset, IcebergDataset, ImpalaObjectDataset, InformixTableDataset, JiraObjectDataset, JsonDataset, LakeHouseTableDataset, MagentoObjectDataset, MariaDBTableDataset, MarketoObjectDataset, MicrosoftAccessTableDataset, MongoDBAtlasCollectionDataset, MongoDBCollectionDataset, MongoDBV2CollectionDataset, MySqlTableDataset, NetezzaTableDataset, ODataResourceDataset, OdbcTableDataset, Office365Dataset, OracleServiceCloudObjectDataset, OracleTableDataset, OrcDataset, ParquetDataset, PaypalObjectDataset, PhoenixObjectDataset, PostgreSqlTableDataset, PostgreSqlV2TableDataset, PrestoObjectDataset, QuickBooksObjectDataset, RelationalTableDataset, ResponsysObjectDataset, RestResourceDataset, SalesforceMarketingCloudObjectDataset, SalesforceObjectDataset, SalesforceServiceCloudObjectDataset, SalesforceServiceCloudV2ObjectDataset, SalesforceV2ObjectDataset, SapBWCubeDataset, SapCloudForCustomerResourceDataset, SapEccResourceDataset, SapHanaTableDataset, SapOdpResourceDataset, SapOpenHubTableDataset, SapTableResourceDataset, ServiceNowObjectDataset, ServiceNowV2ObjectDataset, SharePointOnlineListResourceDataset, ShopifyObjectDataset, SnowflakeDataset, SnowflakeV2Dataset, SparkObjectDataset, SqlServerTableDataset, SquareObjectDataset, SybaseTableDataset, TeradataTableDataset, VerticaTableDataset, WarehouseTableDataset, WebTableDataset, XeroObjectDataset, XmlDataset and ZohoObjectDataset.
Inheritance
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.DataFactory.dll
Syntax
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.ResourceManager.DataFactory.Models.UnknownDataset))]
public abstract class DataFactoryDatasetProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.DataFactoryDatasetProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.DataFactoryDatasetProperties>Constructors
DataFactoryDatasetProperties(DataFactoryLinkedServiceReference)
Initializes a new instance of DataFactoryDatasetProperties.
Declaration
protected DataFactoryDatasetProperties (Azure.Core.Expressions.DataFactory.DataFactoryLinkedServiceReference linkedServiceName);Parameters
|
Azure.Core.Expressions.DataFactory.DataFactoryLinkedServiceReference
linkedServiceName
Linked service reference. |
Exceptions
|
System.ArgumentNullException
|
Properties
AdditionalProperties
Additional Properties
To assign an object to the value of this property use System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions).
To assign an already formatted json string to this property use System.BinaryData.FromString(System.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" }.
Declaration
public System.Collections.Generic.IDictionary<string,BinaryData> AdditionalProperties { get; }Property Value
|
System.Collections.Generic.IDictionary<System.String,System.BinaryData>
|
Annotations
List of tags that can be used for describing the Dataset.
To assign an object to the element of this property use System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions).
To assign an already formatted json string to this property use System.BinaryData.FromString(System.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" }.
Declaration
public System.Collections.Generic.IList<BinaryData> Annotations { get; }Property Value
|
System.Collections.Generic.IList<System.BinaryData>
|
Description
Dataset description.
Declaration
public string Description { get; set; }Property Value
|
System.String
|
FolderName
The name of the folder that this Dataset is in.
Declaration
public string FolderName { get; set; }Property Value
|
System.String
|
LinkedServiceName
Linked service reference.
Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryLinkedServiceReference LinkedServiceName { get; set; }Property Value
|
Azure.Core.Expressions.DataFactory.DataFactoryLinkedServiceReference
|
Parameters
Parameters for dataset.
Declaration
public System.Collections.Generic.IDictionary<string,Azure.ResourceManager.DataFactory.Models.EntityParameterSpecification> Parameters { get; }Property Value
|
System.Collections.Generic.IDictionary<System.String,EntityParameterSpecification>
|
Schema
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<System.Collections.Generic.IList<Azure.ResourceManager.DataFactory.Models.DatasetSchemaDataElement>> Schema { get; set; }Property Value
|
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.Collections.Generic.IList<DatasetSchemaDataElement>>
|
Structure
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<System.Collections.Generic.IList<Azure.ResourceManager.DataFactory.Models.DatasetDataElement>> Structure { get; set; }Property Value
|
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.Collections.Generic.IList<DatasetDataElement>>
|
Methods
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
Declaration
protected virtual 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<DataFactoryDatasetProperties>.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.DataFactoryDatasetProperties IJsonModel<DataFactoryDatasetProperties>.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
|
DataFactoryDatasetProperties
A |
Exceptions
|
System.FormatException
If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format. |
IJsonModel<DataFactoryDatasetProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
Writes the model to the provided System.Text.Json.Utf8JsonWriter.
Declaration
void IJsonModel<DataFactoryDatasetProperties>.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<DataFactoryDatasetProperties>.Create(BinaryData, ModelReaderWriterOptions)
Converts the provided System.BinaryData into a model.
Declaration
Azure.ResourceManager.DataFactory.Models.DataFactoryDatasetProperties IPersistableModel<DataFactoryDatasetProperties>.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
|
DataFactoryDatasetProperties
A |
Exceptions
|
System.FormatException
If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format. |
IPersistableModel<DataFactoryDatasetProperties>.GetFormatFromOptions(ModelReaderWriterOptions)
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
Declaration
string IPersistableModel<DataFactoryDatasetProperties>.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<DataFactoryDatasetProperties>.Write(ModelReaderWriterOptions)
Writes the model into a System.BinaryData.
Declaration
BinaryData IPersistableModel<DataFactoryDatasetProperties>.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. |