DataFactoryHttpDataset Class

Definition

A file in an HTTP web server.

public class DataFactoryHttpDataset : Azure.ResourceManager.DataFactory.Models.DataFactoryDatasetProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.DataFactoryHttpDataset>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.DataFactoryHttpDataset>
public class DataFactoryHttpDataset : Azure.ResourceManager.DataFactory.Models.DataFactoryDatasetProperties
type DataFactoryHttpDataset = class
    inherit DataFactoryDatasetProperties
    interface IJsonModel<DataFactoryHttpDataset>
    interface IPersistableModel<DataFactoryHttpDataset>
type DataFactoryHttpDataset = class
    inherit DataFactoryDatasetProperties
Public Class DataFactoryHttpDataset
Inherits DataFactoryDatasetProperties
Implements IJsonModel(Of DataFactoryHttpDataset), IPersistableModel(Of DataFactoryHttpDataset)
Public Class DataFactoryHttpDataset
Inherits DataFactoryDatasetProperties
Inheritance
DataFactoryHttpDataset
Implements

Constructors

DataFactoryHttpDataset(DataFactoryLinkedServiceReference)

Initializes a new instance of DataFactoryHttpDataset.

Properties

AdditionalHeaders

The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1 ... request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).

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 on files.

Description

Dataset description.

(Inherited from DataFactoryDatasetProperties)
FolderName

The name of the folder that this Dataset is in.

(Inherited from DataFactoryDatasetProperties)
Format

The format of files. Please note DatasetStorageFormat 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 DatasetAvroFormat, DatasetJsonFormat, DatasetOrcFormat, DatasetParquetFormat and DatasetTextFormat.

LinkedServiceName

Linked service reference.

(Inherited from DataFactoryDatasetProperties)
Parameters

Parameters for dataset.

(Inherited from DataFactoryDatasetProperties)
RelativeUri

The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).

RequestBody

The body for the HTTP request. Type: string (or Expression with resultType string).

RequestMethod

The HTTP method for the HTTP request. 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)
Structure

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

(Inherited from DataFactoryDatasetProperties)

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<DataFactoryHttpDataset>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<DataFactoryHttpDataset>.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<DataFactoryHttpDataset>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<DataFactoryHttpDataset>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<DataFactoryHttpDataset>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to