Share via

RestResourceDataset interface

  • Reference
Package:
@azure/arm-datafactory

A Rest service dataset.

Extends
Dataset

Properties

additionalHeaders

The additional HTTP headers in the request to the RESTful API.
paginationRules

The pagination rules to compose next page requests.
relativeUrl

The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).
requestBody

The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
requestMethod

The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
type

Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

annotations

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

Dataset description.
folder

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

Linked service reference.
parameters

Parameters for dataset.
schema

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

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

Property Details

additionalHeaders

The additional HTTP headers in the request to the RESTful API.

additionalHeaders?: {[propertyName: string]: any}

Property Value

{[propertyName: string]: any}

paginationRules

The pagination rules to compose next page requests.

paginationRules?: {[propertyName: string]: any}

Property Value

{[propertyName: string]: any}

relativeUrl

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

relativeUrl?: any

Property Value

any

requestBody

The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).

requestBody?: any

Property Value

any

requestMethod

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

requestMethod?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "RestResource"

Property Value

"RestResource"

Inherited Property Details

annotations

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

annotations?: any[]

Property Value

any[]

Inherited From Dataset.annotations

description

Dataset description.

description?: string

Property Value

string

Inherited From Dataset.description

folder

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

folder?: DatasetFolder

Property Value

DatasetFolder

Inherited From Dataset.folder

linkedServiceName

Linked service reference.

linkedServiceName: LinkedServiceReference

Property Value

LinkedServiceReference

Inherited From Dataset.linkedServiceName

parameters

Parameters for dataset.

parameters?: {[propertyName: string]: ParameterSpecification}

Property Value

{[propertyName: string]: ParameterSpecification}

Inherited From Dataset.parameters

schema

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

schema?: any

Property Value

any

Inherited From Dataset.schema

structure

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

structure?: any

Property Value

any

Inherited From Dataset.structure