-
Notifications
You must be signed in to change notification settings - Fork 180
/
PipelineRuns.yml
99 lines (99 loc) · 3.5 KB
/
PipelineRuns.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
### YamlMime:TSType
name: PipelineRuns
uid: '@azure/arm-datafactory.PipelineRuns'
package: '@azure/arm-datafactory'
summary: Interface representing a PipelineRuns.
fullName: PipelineRuns
remarks: ''
isDeprecated: false
type: interface
methods:
- name: cancel(string, string, string, PipelineRunsCancelOptionalParams)
uid: '@azure/arm-datafactory.PipelineRuns.cancel'
package: '@azure/arm-datafactory'
summary: Cancel a pipeline run by its run ID.
remarks: ''
isDeprecated: false
syntax:
content: >-
function cancel(resourceGroupName: string, factoryName: string, runId:
string, options?: PipelineRunsCancelOptionalParams): Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The resource group name.
- id: factoryName
type: string
description: The factory name.
- id: runId
type: string
description: The pipeline run identifier.
- id: options
type: >-
<xref uid="@azure/arm-datafactory.PipelineRunsCancelOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, string, PipelineRunsGetOptionalParams)
uid: '@azure/arm-datafactory.PipelineRuns.get'
package: '@azure/arm-datafactory'
summary: Get a pipeline run by its run ID.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, factoryName: string, runId:
string, options?: PipelineRunsGetOptionalParams): Promise<PipelineRun>
parameters:
- id: resourceGroupName
type: string
description: The resource group name.
- id: factoryName
type: string
description: The factory name.
- id: runId
type: string
description: The pipeline run identifier.
- id: options
type: <xref uid="@azure/arm-datafactory.PipelineRunsGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-datafactory.PipelineRun" />>
- name: >-
queryByFactory(string, string, RunFilterParameters,
PipelineRunsQueryByFactoryOptionalParams)
uid: '@azure/arm-datafactory.PipelineRuns.queryByFactory'
package: '@azure/arm-datafactory'
summary: Query pipeline runs in the factory based on input filter conditions.
remarks: ''
isDeprecated: false
syntax:
content: >-
function queryByFactory(resourceGroupName: string, factoryName: string,
filterParameters: RunFilterParameters, options?:
PipelineRunsQueryByFactoryOptionalParams):
Promise<PipelineRunsQueryResponse>
parameters:
- id: resourceGroupName
type: string
description: The resource group name.
- id: factoryName
type: string
description: The factory name.
- id: filterParameters
type: <xref uid="@azure/arm-datafactory.RunFilterParameters" />
description: Parameters to filter the pipeline run.
- id: options
type: >-
<xref
uid="@azure/arm-datafactory.PipelineRunsQueryByFactoryOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-datafactory.PipelineRunsQueryResponse" />>