Share via

JsonFormat Class

  • Reference

The data stored in JSON format.

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.datafactory.models._models_py3.DatasetStorageFormat
JsonFormat

Constructor

JsonFormat(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, serializer: MutableMapping[str, Any] | None = None, deserializer: MutableMapping[str, Any] | None = None, file_pattern: MutableMapping[str, Any] | None = None, nesting_separator: MutableMapping[str, Any] | None = None, encoding_name: MutableMapping[str, Any] | None = None, json_node_reference: MutableMapping[str, Any] | None = None, json_path_definition: MutableMapping[str, Any] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
serializer
<xref:JSON>

Serializer. Type: string (or Expression with resultType string).
deserializer
<xref:JSON>

Deserializer. Type: string (or Expression with resultType string).
file_pattern
<xref:JSON>

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.
nesting_separator
<xref:JSON>

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

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).
json_node_reference
<xref:JSON>

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

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

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
type
str

Type of dataset storage format. Required.
serializer
<xref:JSON>

Serializer. Type: string (or Expression with resultType string).
deserializer
<xref:JSON>

Deserializer. Type: string (or Expression with resultType string).
file_pattern
<xref:JSON>

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.
nesting_separator
<xref:JSON>

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

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).
json_node_reference
<xref:JSON>

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

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