Class DatasetJsonFormat

The data stored in JSON format.

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

Constructors

DatasetJsonFormat()

Initializes a new instance of DatasetJsonFormat.

Declaration
public DatasetJsonFormat ();

Properties

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> EncodingName { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.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 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 BinaryData FilePattern { get; set; }
Property Value
System.BinaryData

JsonNodeReference

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> JsonNodeReference { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.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 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 BinaryData JsonPathDefinition { get; set; }
Property Value
System.BinaryData

NestingSeparator

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> NestingSeparator { 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<DatasetJsonFormat>.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.DatasetJsonFormat IJsonModel<DatasetJsonFormat>.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
DatasetJsonFormat

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

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

IJsonModel<DatasetJsonFormat>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

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

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

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.DataFactory.Models.DatasetJsonFormat IPersistableModel<DatasetJsonFormat>.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
DatasetJsonFormat

A T representation of the data.
Exceptions
System.FormatException

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

IPersistableModel<DatasetJsonFormat>.GetFormatFromOptions(ModelReaderWriterOptions)

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

Declaration
string IPersistableModel<DatasetJsonFormat>.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<DatasetJsonFormat>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<DatasetJsonFormat>.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.