RestResourceDataset Class

Definition

A Rest service dataset.

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

Constructors

RestResourceDataset(DataFactoryLinkedServiceReference)

Initializes a new instance of RestResourceDataset.

Properties

AdditionalHeaders

The additional HTTP headers in the request to the RESTful API.

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" }.

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

Dataset description.

(Inherited from DataFactoryDatasetProperties)
FolderName

The name of the folder that this Dataset is in.

(Inherited from DataFactoryDatasetProperties)
LinkedServiceName

Linked service reference.

(Inherited from DataFactoryDatasetProperties)
PaginationRules

The pagination rules to compose next page requests.

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" }.

Parameters

Parameters for dataset.

(Inherited from DataFactoryDatasetProperties)
RelativeUri

The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).

RequestBody

The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).

RequestMethod

The HTTP method used to call the RESTful API. The default is GET. 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)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (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<RestResourceDataset>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Converts the provided BinaryData into a model.

IPersistableModel<RestResourceDataset>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<RestResourceDataset>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to