PipelineResource interface

Package:

@azure/synapse-artifacts

Pipeline resource type.

Extends

SubResource

Properties

activities	List of activities in pipeline.
annotations	List of tags that can be used for describing the Pipeline.
concurrency	The max number of concurrent runs for the pipeline.
description	The description of the pipeline.
folder	The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.
parameters	List of parameters for pipeline.
runDimensions	Dimensions emitted by Pipeline.
variables	List of variables for pipeline.

Inherited Properties

etag	Resource Etag. NOTE: This property will not be serialized. It can only be populated by the server.
id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

activities

List of activities in pipeline.

activities?: ActivityUnion[]

Property Value

ActivityUnion[]

annotations

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

annotations?: any[]

Property Value

any[]

concurrency

The max number of concurrent runs for the pipeline.

concurrency?: number

Property Value

number

description

The description of the pipeline.

description?: string

Property Value

string

folder

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

folder?: PipelineFolder

Property Value

PipelineFolder

parameters

List of parameters for pipeline.

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

Property Value

{[propertyName: string]: ParameterSpecification}

runDimensions

Dimensions emitted by Pipeline.

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

Property Value

{[propertyName: string]: any}

variables

List of variables for pipeline.

variables?: {[propertyName: string]: VariableSpecification}

Property Value

{[propertyName: string]: VariableSpecification}

Inherited Property Details

etag

Resource Etag. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

Inherited From SubResource.etag

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From SubResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From SubResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From SubResource.type