Share via

XmlDataset Class

  • Reference

Xml dataset.

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

Constructor

XmlDataset(*, linked_service_name: _models.LinkedServiceReference, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None, structure: MutableMapping[str, Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder | None = None, location: _models.DatasetLocation | None = None, encoding_name: MutableMapping[str, Any] | None = None, null_value: MutableMapping[str, Any] | None = None, compression: _models.DatasetCompression | 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.

Default value: None
description
str

Dataset description.

Default value: None
structure
<xref:JSON>

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

Default value: None
schema
<xref:JSON>

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

Default value: None
linked_service_name
LinkedServiceReference

Linked service reference. Required.
parameters
dict[str, ParameterSpecification]

Parameters for dataset.

Default value: None
annotations
list[<xref:JSON>]

List of tags that can be used for describing the Dataset.

Default value: None
folder
DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Default value: None
location
DatasetLocation

The location of the json data storage.

Default value: None
encoding_name
<xref:JSON>

The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).

Default value: None
null_value
<xref:JSON>

The null value string. Type: string (or Expression with resultType string).

Default value: None
compression
DatasetCompression

The data compression method used for the json dataset.

Default value: None

Variables

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

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

Type of dataset. Required.
description
str

Dataset description.
structure
<xref:JSON>

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

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
linked_service_name
LinkedServiceReference

Linked service reference. Required.
parameters
dict[str, ParameterSpecification]

Parameters for dataset.
annotations
list[<xref:JSON>]

List of tags that can be used for describing the Dataset.
folder
DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
location
DatasetLocation

The location of the json data storage.
encoding_name
<xref:JSON>

The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
null_value
<xref:JSON>

The null value string. Type: string (or Expression with resultType string).
compression
DatasetCompression

The data compression method used for the json dataset.