-
Notifications
You must be signed in to change notification settings - Fork 180
/
Schedules.yml
250 lines (250 loc) · 9.13 KB
/
Schedules.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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
### YamlMime:TSType
name: Schedules
uid: '@azure/arm-devtestlabs.Schedules'
package: '@azure/arm-devtestlabs'
summary: Interface representing a Schedules.
fullName: Schedules
remarks: ''
isDeprecated: false
type: interface
methods:
- name: beginExecute(string, string, string, SchedulesExecuteOptionalParams)
uid: '@azure/arm-devtestlabs.Schedules.beginExecute'
package: '@azure/arm-devtestlabs'
summary: Execute a schedule. This operation can take a while to complete.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginExecute(resourceGroupName: string, labName: string, name:
string, options?: SchedulesExecuteOptionalParams):
Promise<PollerLike<PollOperationState<void>, void>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: labName
type: string
description: The name of the lab.
- id: name
type: string
description: The name of the schedule.
- id: options
type: <xref uid="@azure/arm-devtestlabs.SchedulesExecuteOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.PollerLike" /><<xref
uid="@azure/core-lro.PollOperationState" /><void>, void>>
- name: >-
beginExecuteAndWait(string, string, string,
SchedulesExecuteOptionalParams)
uid: '@azure/arm-devtestlabs.Schedules.beginExecuteAndWait'
package: '@azure/arm-devtestlabs'
summary: Execute a schedule. This operation can take a while to complete.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginExecuteAndWait(resourceGroupName: string, labName: string,
name: string, options?: SchedulesExecuteOptionalParams): Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: labName
type: string
description: The name of the lab.
- id: name
type: string
description: The name of the schedule.
- id: options
type: <xref uid="@azure/arm-devtestlabs.SchedulesExecuteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: >-
createOrUpdate(string, string, string, Schedule,
SchedulesCreateOrUpdateOptionalParams)
uid: '@azure/arm-devtestlabs.Schedules.createOrUpdate'
package: '@azure/arm-devtestlabs'
summary: Create or replace an existing schedule.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdate(resourceGroupName: string, labName: string,
name: string, schedule: Schedule, options?:
SchedulesCreateOrUpdateOptionalParams): Promise<Schedule>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: labName
type: string
description: The name of the lab.
- id: name
type: string
description: The name of the schedule.
- id: schedule
type: <xref uid="@azure/arm-devtestlabs.Schedule" />
description: A schedule.
- id: options
type: >-
<xref
uid="@azure/arm-devtestlabs.SchedulesCreateOrUpdateOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-devtestlabs.Schedule" />>
- name: delete(string, string, string, SchedulesDeleteOptionalParams)
uid: '@azure/arm-devtestlabs.Schedules.delete'
package: '@azure/arm-devtestlabs'
summary: Delete schedule.
remarks: ''
isDeprecated: false
syntax:
content: >-
function delete(resourceGroupName: string, labName: string, name:
string, options?: SchedulesDeleteOptionalParams): Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: labName
type: string
description: The name of the lab.
- id: name
type: string
description: The name of the schedule.
- id: options
type: <xref uid="@azure/arm-devtestlabs.SchedulesDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, string, SchedulesGetOptionalParams)
uid: '@azure/arm-devtestlabs.Schedules.get'
package: '@azure/arm-devtestlabs'
summary: Get schedule.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, labName: string, name: string,
options?: SchedulesGetOptionalParams): Promise<Schedule>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: labName
type: string
description: The name of the lab.
- id: name
type: string
description: The name of the schedule.
- id: options
type: <xref uid="@azure/arm-devtestlabs.SchedulesGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-devtestlabs.Schedule" />>
- name: list(string, string, SchedulesListOptionalParams)
uid: '@azure/arm-devtestlabs.Schedules.list'
package: '@azure/arm-devtestlabs'
summary: List schedules in a given lab.
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(resourceGroupName: string, labName: string, options?:
SchedulesListOptionalParams): PagedAsyncIterableIterator<Schedule,
Schedule[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: labName
type: string
description: The name of the lab.
- id: options
type: <xref uid="@azure/arm-devtestlabs.SchedulesListOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-devtestlabs.Schedule" />, <xref
uid="@azure/arm-devtestlabs.Schedule" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: >-
listApplicable(string, string, string,
SchedulesListApplicableOptionalParams)
uid: '@azure/arm-devtestlabs.Schedules.listApplicable'
package: '@azure/arm-devtestlabs'
summary: Lists all applicable schedules
remarks: ''
isDeprecated: false
syntax:
content: >-
function listApplicable(resourceGroupName: string, labName: string,
name: string, options?: SchedulesListApplicableOptionalParams):
PagedAsyncIterableIterator<Schedule, Schedule[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: labName
type: string
description: The name of the lab.
- id: name
type: string
description: The name of the schedule.
- id: options
type: >-
<xref
uid="@azure/arm-devtestlabs.SchedulesListApplicableOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-devtestlabs.Schedule" />, <xref
uid="@azure/arm-devtestlabs.Schedule" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: >-
update(string, string, string, ScheduleFragment,
SchedulesUpdateOptionalParams)
uid: '@azure/arm-devtestlabs.Schedules.update'
package: '@azure/arm-devtestlabs'
summary: Allows modifying tags of schedules. All other properties will be ignored.
remarks: ''
isDeprecated: false
syntax:
content: >-
function update(resourceGroupName: string, labName: string, name:
string, schedule: ScheduleFragment, options?:
SchedulesUpdateOptionalParams): Promise<Schedule>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: labName
type: string
description: The name of the lab.
- id: name
type: string
description: The name of the schedule.
- id: schedule
type: <xref uid="@azure/arm-devtestlabs.ScheduleFragment" />
description: A schedule.
- id: options
type: <xref uid="@azure/arm-devtestlabs.SchedulesUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-devtestlabs.Schedule" />>