GetMetadataActivity interface

Package:

@azure/arm-datafactory

Activity to get metadata of dataset

Extends

ExecutionActivity

Properties

dataset	GetMetadata activity dataset reference.
fieldList	Fields of metadata to get from dataset.
formatSettings	GetMetadata activity format settings.
storeSettings	GetMetadata activity store settings.
type	Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

dependsOn	Activity depends on condition.
description	Activity description.
linkedServiceName	Linked service reference.
name	Activity name.
onInactiveMarkAs	Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.
policy	Activity policy.
state	Activity state. This is an optional property and if not provided, the state will be Active by default.
userProperties	Activity user properties.

Property Details

dataset

GetMetadata activity dataset reference.

dataset: DatasetReference

Property Value

DatasetReference

fieldList

Fields of metadata to get from dataset.

fieldList?: any[]

Property Value

any[]

formatSettings

GetMetadata activity format settings.

formatSettings?: FormatReadSettingsUnion

Property Value

FormatReadSettingsUnion

storeSettings

GetMetadata activity store settings.

storeSettings?: StoreReadSettingsUnion

Property Value

StoreReadSettingsUnion

type

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

type: "GetMetadata"

Property Value

"GetMetadata"

Inherited Property Details

dependsOn

Activity depends on condition.

dependsOn?: ActivityDependency[]

Property Value

ActivityDependency[]

Inherited From ExecutionActivity.dependsOn

description

Activity description.

description?: string

Property Value

string

Inherited From ExecutionActivity.description

linkedServiceName

Linked service reference.

linkedServiceName?: LinkedServiceReference

Property Value

LinkedServiceReference

Inherited From ExecutionActivity.linkedServiceName

name

Activity name.

name: string

Property Value

string

Inherited From ExecutionActivity.name

onInactiveMarkAs

Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

onInactiveMarkAs?: string

Property Value

string

Inherited From ExecutionActivity.onInactiveMarkAs

policy

Activity policy.

policy?: ActivityPolicy

Property Value

ActivityPolicy

Inherited From ExecutionActivity.policy

state

Activity state. This is an optional property and if not provided, the state will be Active by default.

state?: string

Property Value

string

Inherited From ExecutionActivity.state

userProperties

Activity user properties.

userProperties?: UserProperty[]

Property Value

UserProperty[]

Inherited From ExecutionActivity.userProperties