-
Notifications
You must be signed in to change notification settings - Fork 180
/
InstancePools.yml
287 lines (287 loc) · 11.6 KB
/
InstancePools.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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
### YamlMime:TSType
name: InstancePools
uid: '@azure/arm-sql.InstancePools'
package: '@azure/arm-sql'
summary: Interface representing a InstancePools.
fullName: InstancePools
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
beginCreateOrUpdate(string, string, InstancePool,
InstancePoolsCreateOrUpdateOptionalParams)
uid: '@azure/arm-sql.InstancePools.beginCreateOrUpdate'
package: '@azure/arm-sql'
summary: Creates or updates an instance pool.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdate(resourceGroupName: string,
instancePoolName: string, parameters: InstancePool, options?:
InstancePoolsCreateOrUpdateOptionalParams):
Promise<SimplePollerLike<OperationState<InstancePool>, InstancePool>>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group that contains the resource. You can
obtain
this value from the Azure Resource Manager API or the portal.
- id: instancePoolName
type: string
description: The name of the instance pool to be created or updated.
- id: parameters
type: <xref uid="@azure/arm-sql.InstancePool" />
description: The requested instance pool resource state.
- id: options
type: >-
<xref uid="@azure/arm-sql.InstancePoolsCreateOrUpdateOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><<xref
uid="@azure/arm-sql.InstancePool" />>, <xref
uid="@azure/arm-sql.InstancePool" />>>
- name: >-
beginCreateOrUpdateAndWait(string, string, InstancePool,
InstancePoolsCreateOrUpdateOptionalParams)
uid: '@azure/arm-sql.InstancePools.beginCreateOrUpdateAndWait'
package: '@azure/arm-sql'
summary: Creates or updates an instance pool.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdateAndWait(resourceGroupName: string,
instancePoolName: string, parameters: InstancePool, options?:
InstancePoolsCreateOrUpdateOptionalParams): Promise<InstancePool>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group that contains the resource. You can
obtain
this value from the Azure Resource Manager API or the portal.
- id: instancePoolName
type: string
description: The name of the instance pool to be created or updated.
- id: parameters
type: <xref uid="@azure/arm-sql.InstancePool" />
description: The requested instance pool resource state.
- id: options
type: >-
<xref uid="@azure/arm-sql.InstancePoolsCreateOrUpdateOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-sql.InstancePool" />>
- name: beginDelete(string, string, InstancePoolsDeleteOptionalParams)
uid: '@azure/arm-sql.InstancePools.beginDelete'
package: '@azure/arm-sql'
summary: Deletes an instance pool
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDelete(resourceGroupName: string, instancePoolName:
string, options?: InstancePoolsDeleteOptionalParams):
Promise<SimplePollerLike<OperationState<void>, void>>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group that contains the resource. You can
obtain
this value from the Azure Resource Manager API or the portal.
- id: instancePoolName
type: string
description: The name of the instance pool to be deleted
- id: options
type: <xref uid="@azure/arm-sql.InstancePoolsDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><void>, void>>
- name: beginDeleteAndWait(string, string, InstancePoolsDeleteOptionalParams)
uid: '@azure/arm-sql.InstancePools.beginDeleteAndWait'
package: '@azure/arm-sql'
summary: Deletes an instance pool
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDeleteAndWait(resourceGroupName: string, instancePoolName:
string, options?: InstancePoolsDeleteOptionalParams): Promise<void>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group that contains the resource. You can
obtain
this value from the Azure Resource Manager API or the portal.
- id: instancePoolName
type: string
description: The name of the instance pool to be deleted
- id: options
type: <xref uid="@azure/arm-sql.InstancePoolsDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: >-
beginUpdate(string, string, InstancePoolUpdate,
InstancePoolsUpdateOptionalParams)
uid: '@azure/arm-sql.InstancePools.beginUpdate'
package: '@azure/arm-sql'
summary: Updates an instance pool.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginUpdate(resourceGroupName: string, instancePoolName:
string, parameters: InstancePoolUpdate, options?:
InstancePoolsUpdateOptionalParams):
Promise<SimplePollerLike<OperationState<InstancePool>, InstancePool>>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group that contains the resource. You can
obtain
this value from the Azure Resource Manager API or the portal.
- id: instancePoolName
type: string
description: The name of the instance pool to be updated.
- id: parameters
type: <xref uid="@azure/arm-sql.InstancePoolUpdate" />
description: The requested instance pool resource state.
- id: options
type: <xref uid="@azure/arm-sql.InstancePoolsUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><<xref
uid="@azure/arm-sql.InstancePool" />>, <xref
uid="@azure/arm-sql.InstancePool" />>>
- name: >-
beginUpdateAndWait(string, string, InstancePoolUpdate,
InstancePoolsUpdateOptionalParams)
uid: '@azure/arm-sql.InstancePools.beginUpdateAndWait'
package: '@azure/arm-sql'
summary: Updates an instance pool.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginUpdateAndWait(resourceGroupName: string, instancePoolName:
string, parameters: InstancePoolUpdate, options?:
InstancePoolsUpdateOptionalParams): Promise<InstancePool>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group that contains the resource. You can
obtain
this value from the Azure Resource Manager API or the portal.
- id: instancePoolName
type: string
description: The name of the instance pool to be updated.
- id: parameters
type: <xref uid="@azure/arm-sql.InstancePoolUpdate" />
description: The requested instance pool resource state.
- id: options
type: <xref uid="@azure/arm-sql.InstancePoolsUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-sql.InstancePool" />>
- name: get(string, string, InstancePoolsGetOptionalParams)
uid: '@azure/arm-sql.InstancePools.get'
package: '@azure/arm-sql'
summary: Gets an instance pool.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, instancePoolName: string,
options?: InstancePoolsGetOptionalParams): Promise<InstancePool>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group that contains the resource. You can
obtain
this value from the Azure Resource Manager API or the portal.
- id: instancePoolName
type: string
description: The name of the instance pool to be retrieved.
- id: options
type: <xref uid="@azure/arm-sql.InstancePoolsGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-sql.InstancePool" />>
- name: list(InstancePoolsListOptionalParams)
uid: '@azure/arm-sql.InstancePools.list'
package: '@azure/arm-sql'
summary: Gets a list of all instance pools in the subscription.
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(options?: InstancePoolsListOptionalParams):
PagedAsyncIterableIterator<InstancePool, InstancePool[], PageSettings>
parameters:
- id: options
type: <xref uid="@azure/arm-sql.InstancePoolsListOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-sql.InstancePool" />, <xref
uid="@azure/arm-sql.InstancePool" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: >-
listByResourceGroup(string,
InstancePoolsListByResourceGroupOptionalParams)
uid: '@azure/arm-sql.InstancePools.listByResourceGroup'
package: '@azure/arm-sql'
summary: Gets a list of instance pools in the resource group
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByResourceGroup(resourceGroupName: string, options?:
InstancePoolsListByResourceGroupOptionalParams):
PagedAsyncIterableIterator<InstancePool, InstancePool[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group that contains the resource. You can
obtain
this value from the Azure Resource Manager API or the portal.
- id: options
type: >-
<xref
uid="@azure/arm-sql.InstancePoolsListByResourceGroupOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-sql.InstancePool" />, <xref
uid="@azure/arm-sql.InstancePool" />[], <xref
uid="@azure/core-paging.PageSettings" />>