DatasetJsonFormat Class

Definition

The data stored in JSON format.

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

Constructors

DatasetJsonFormat()

Initializes a new instance of DatasetJsonFormat.

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 DatasetStorageFormat)
Deserializer

Deserializer. Type: string (or Expression with resultType string).

(Inherited from DatasetStorageFormat)
EncodingName

The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string).

FilePattern

File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive.

To assign an object to 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" }.
JsonNodeReference

The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string).

JsonPathDefinition

The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with "$"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object (or Expression with resultType object).

To assign an object to 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" }.
NestingSeparator

The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string).

Serializer

Serializer. Type: string (or Expression with resultType string).

(Inherited from DatasetStorageFormat)

Explicit Interface Implementations

IJsonModel<DatasetJsonFormat>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<DatasetJsonFormat>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<DatasetStorageFormat>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

(Inherited from DatasetStorageFormat)
IJsonModel<DatasetStorageFormat>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from DatasetStorageFormat)
IPersistableModel<DatasetJsonFormat>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<DatasetJsonFormat>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<DatasetJsonFormat>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<DatasetStorageFormat>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from DatasetStorageFormat)
IPersistableModel<DatasetStorageFormat>.GetFormatFromOptions(ModelReaderWriterOptions)

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

(Inherited from DatasetStorageFormat)
IPersistableModel<DatasetStorageFormat>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from DatasetStorageFormat)

Applies to