Share via

HttpDataset Class

  • Reference

A file in an HTTP web server.

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

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

Constructor

HttpDataset(*, 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: MutableMapping[str, Any] | None = None, format: _models.DatasetStorageFormat | 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.
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 based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).
request_method
<xref:JSON>

The HTTP method for the HTTP request. Type: string (or Expression with resultType string).
request_body
<xref:JSON>

The body for the HTTP request. Type: string (or Expression with resultType string).
additional_headers
<xref:JSON>

The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1 ... request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).
format
DatasetStorageFormat

The format of files.
compression
DatasetCompression

The data compression method used on files.

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 based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).
request_method
<xref:JSON>

The HTTP method for the HTTP request. Type: string (or Expression with resultType string).
request_body
<xref:JSON>

The body for the HTTP request. Type: string (or Expression with resultType string).
additional_headers
<xref:JSON>

The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1 ... request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).
format
DatasetStorageFormat

The format of files.
compression
DatasetCompression

The data compression method used on files.