Share via

RestResourceDataset Class

  • Reference

A Rest service dataset.

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

Inheritance
azure.mgmt.datafactory.models._models_py3.Dataset
RestResourceDataset

Constructor

RestResourceDataset(*, 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, relative_url: MutableMapping[str, Any] | None = None, request_method: MutableMapping[str, Any] | None = None, request_body: MutableMapping[str, Any] | None = None, additional_headers: Dict[str, MutableMapping[str, Any]] | None = None, pagination_rules: Dict[str, 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.
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.
relative_url
<xref:JSON>

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

The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
request_body
<xref:JSON>

The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
additional_headers
dict[str, <xref:JSON>]

The additional HTTP headers in the request to the RESTful API.
pagination_rules
dict[str, <xref:JSON>]

The pagination rules to compose next page requests.

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

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

The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
request_body
<xref:JSON>

The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
additional_headers
dict[str, <xref:JSON>]

The additional HTTP headers in the request to the RESTful API.
pagination_rules
dict[str, <xref:JSON>]

The pagination rules to compose next page requests.