-
Notifications
You must be signed in to change notification settings - Fork 180
/
RunbookOperations.yml
258 lines (258 loc) · 10 KB
/
RunbookOperations.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
251
252
253
254
255
256
257
258
### YamlMime:TSType
name: RunbookOperations
uid: '@azure/arm-automation.RunbookOperations'
package: '@azure/arm-automation'
summary: Interface representing a RunbookOperations.
fullName: RunbookOperations
remarks: ''
isDeprecated: false
type: interface
methods:
- name: beginPublish(string, string, string, RunbookPublishOptionalParams)
uid: '@azure/arm-automation.RunbookOperations.beginPublish'
package: '@azure/arm-automation'
summary: Publish runbook draft.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginPublish(resourceGroupName: string, automationAccountName:
string, runbookName: string, options?: RunbookPublishOptionalParams):
Promise<PollerLike<PollOperationState<RunbookPublishHeaders>,
RunbookPublishHeaders>>
parameters:
- id: resourceGroupName
type: string
description: Name of an Azure Resource group.
- id: automationAccountName
type: string
description: The name of the automation account.
- id: runbookName
type: string
description: The parameters supplied to the publish runbook operation.
- id: options
type: <xref uid="@azure/arm-automation.RunbookPublishOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.PollerLike" /><<xref
uid="@azure/core-lro.PollOperationState" /><<xref
uid="@azure/arm-automation.RunbookPublishHeaders" />>, <xref
uid="@azure/arm-automation.RunbookPublishHeaders" />>>
- name: beginPublishAndWait(string, string, string, RunbookPublishOptionalParams)
uid: '@azure/arm-automation.RunbookOperations.beginPublishAndWait'
package: '@azure/arm-automation'
summary: Publish runbook draft.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginPublishAndWait(resourceGroupName: string,
automationAccountName: string, runbookName: string, options?:
RunbookPublishOptionalParams): Promise<RunbookPublishHeaders>
parameters:
- id: resourceGroupName
type: string
description: Name of an Azure Resource group.
- id: automationAccountName
type: string
description: The name of the automation account.
- id: runbookName
type: string
description: The parameters supplied to the publish runbook operation.
- id: options
type: <xref uid="@azure/arm-automation.RunbookPublishOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/arm-automation.RunbookPublishHeaders"
/>>
- name: >-
createOrUpdate(string, string, string, RunbookCreateOrUpdateParameters,
RunbookCreateOrUpdateOptionalParams)
uid: '@azure/arm-automation.RunbookOperations.createOrUpdate'
package: '@azure/arm-automation'
summary: Create the runbook identified by runbook name.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdate(resourceGroupName: string,
automationAccountName: string, runbookName: string, parameters:
RunbookCreateOrUpdateParameters, options?:
RunbookCreateOrUpdateOptionalParams): Promise<Runbook>
parameters:
- id: resourceGroupName
type: string
description: Name of an Azure Resource group.
- id: automationAccountName
type: string
description: The name of the automation account.
- id: runbookName
type: string
description: The runbook name.
- id: parameters
type: <xref uid="@azure/arm-automation.RunbookCreateOrUpdateParameters" />
description: >-
The create or update parameters for runbook. Provide either content
link for a
published runbook or draft, not both.
- id: options
type: >-
<xref
uid="@azure/arm-automation.RunbookCreateOrUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-automation.Runbook" />>
- name: delete(string, string, string, RunbookDeleteOptionalParams)
uid: '@azure/arm-automation.RunbookOperations.delete'
package: '@azure/arm-automation'
summary: Delete the runbook by name.
remarks: ''
isDeprecated: false
syntax:
content: >-
function delete(resourceGroupName: string, automationAccountName:
string, runbookName: string, options?: RunbookDeleteOptionalParams):
Promise<void>
parameters:
- id: resourceGroupName
type: string
description: Name of an Azure Resource group.
- id: automationAccountName
type: string
description: The name of the automation account.
- id: runbookName
type: string
description: The runbook name.
- id: options
type: <xref uid="@azure/arm-automation.RunbookDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, string, RunbookGetOptionalParams)
uid: '@azure/arm-automation.RunbookOperations.get'
package: '@azure/arm-automation'
summary: Retrieve the runbook identified by runbook name.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, automationAccountName: string,
runbookName: string, options?: RunbookGetOptionalParams):
Promise<Runbook>
parameters:
- id: resourceGroupName
type: string
description: Name of an Azure Resource group.
- id: automationAccountName
type: string
description: The name of the automation account.
- id: runbookName
type: string
description: The runbook name.
- id: options
type: <xref uid="@azure/arm-automation.RunbookGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-automation.Runbook" />>
- name: getContent(string, string, string, RunbookGetContentOptionalParams)
uid: '@azure/arm-automation.RunbookOperations.getContent'
package: '@azure/arm-automation'
summary: Retrieve the content of runbook identified by runbook name.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getContent(resourceGroupName: string, automationAccountName:
string, runbookName: string, options?: RunbookGetContentOptionalParams):
Promise<RunbookGetContentResponse>
parameters:
- id: resourceGroupName
type: string
description: Name of an Azure Resource group.
- id: automationAccountName
type: string
description: The name of the automation account.
- id: runbookName
type: string
description: The runbook name.
- id: options
type: <xref uid="@azure/arm-automation.RunbookGetContentOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/arm-automation.RunbookGetContentResponse"
/>>
- name: >-
listByAutomationAccount(string, string,
RunbookListByAutomationAccountOptionalParams)
uid: '@azure/arm-automation.RunbookOperations.listByAutomationAccount'
package: '@azure/arm-automation'
summary: Retrieve a list of runbooks.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByAutomationAccount(resourceGroupName: string,
automationAccountName: string, options?:
RunbookListByAutomationAccountOptionalParams):
PagedAsyncIterableIterator<Runbook, Runbook[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: Name of an Azure Resource group.
- id: automationAccountName
type: string
description: The name of the automation account.
- id: options
type: >-
<xref
uid="@azure/arm-automation.RunbookListByAutomationAccountOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-automation.Runbook" />, <xref
uid="@azure/arm-automation.Runbook" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: >-
update(string, string, string, RunbookUpdateParameters,
RunbookUpdateOptionalParams)
uid: '@azure/arm-automation.RunbookOperations.update'
package: '@azure/arm-automation'
summary: Update the runbook identified by runbook name.
remarks: ''
isDeprecated: false
syntax:
content: >-
function update(resourceGroupName: string, automationAccountName:
string, runbookName: string, parameters: RunbookUpdateParameters,
options?: RunbookUpdateOptionalParams): Promise<Runbook>
parameters:
- id: resourceGroupName
type: string
description: Name of an Azure Resource group.
- id: automationAccountName
type: string
description: The name of the automation account.
- id: runbookName
type: string
description: The runbook name.
- id: parameters
type: <xref uid="@azure/arm-automation.RunbookUpdateParameters" />
description: The update parameters for runbook.
- id: options
type: <xref uid="@azure/arm-automation.RunbookUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-automation.Runbook" />>