-
Notifications
You must be signed in to change notification settings - Fork 180
/
VirtualMachineScaleSetRollingUpgrades.yml
263 lines (255 loc) · 10 KB
/
VirtualMachineScaleSetRollingUpgrades.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
### YamlMime:TSType
name: VirtualMachineScaleSetRollingUpgrades
uid: >-
@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgrades
package: '@azure/arm-compute-profile-2020-09-01-hybrid'
summary: Interface representing a VirtualMachineScaleSetRollingUpgrades.
fullName: VirtualMachineScaleSetRollingUpgrades
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
beginCancel(string, string,
VirtualMachineScaleSetRollingUpgradesCancelOptionalParams)
uid: >-
@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgrades.beginCancel
package: '@azure/arm-compute-profile-2020-09-01-hybrid'
summary: Cancels the current virtual machine scale set rolling upgrade.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCancel(resourceGroupName: string, vmScaleSetName: string,
options?: VirtualMachineScaleSetRollingUpgradesCancelOptionalParams):
Promise<PollerLike<PollOperationState<void>, void>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: vmScaleSetName
type: string
description: The name of the VM scale set.
- id: options
type: >-
<xref
uid="@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgradesCancelOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.PollerLike" /><<xref
uid="@azure/core-lro.PollOperationState" /><void>, void>>
- name: >-
beginCancelAndWait(string, string,
VirtualMachineScaleSetRollingUpgradesCancelOptionalParams)
uid: >-
@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgrades.beginCancelAndWait
package: '@azure/arm-compute-profile-2020-09-01-hybrid'
summary: Cancels the current virtual machine scale set rolling upgrade.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCancelAndWait(resourceGroupName: string, vmScaleSetName:
string, options?:
VirtualMachineScaleSetRollingUpgradesCancelOptionalParams):
Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: vmScaleSetName
type: string
description: The name of the VM scale set.
- id: options
type: >-
<xref
uid="@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgradesCancelOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: >-
beginStartExtensionUpgrade(string, string,
VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams)
uid: >-
@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgrades.beginStartExtensionUpgrade
package: '@azure/arm-compute-profile-2020-09-01-hybrid'
summary: >-
Starts a rolling upgrade to move all extensions for all virtual machine
scale set instances to the
latest available extension version. Instances which are already running
the latest extension
versions are not affected.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginStartExtensionUpgrade(resourceGroupName: string,
vmScaleSetName: string, options?:
VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams):
Promise<PollerLike<PollOperationState<void>, void>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: vmScaleSetName
type: string
description: The name of the VM scale set.
- id: options
type: >-
<xref
uid="@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.PollerLike" /><<xref
uid="@azure/core-lro.PollOperationState" /><void>, void>>
- name: >-
beginStartExtensionUpgradeAndWait(string, string,
VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams)
uid: >-
@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgrades.beginStartExtensionUpgradeAndWait
package: '@azure/arm-compute-profile-2020-09-01-hybrid'
summary: >-
Starts a rolling upgrade to move all extensions for all virtual machine
scale set instances to the
latest available extension version. Instances which are already running
the latest extension
versions are not affected.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginStartExtensionUpgradeAndWait(resourceGroupName: string,
vmScaleSetName: string, options?:
VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams):
Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: vmScaleSetName
type: string
description: The name of the VM scale set.
- id: options
type: >-
<xref
uid="@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: >-
beginStartOSUpgrade(string, string,
VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams)
uid: >-
@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgrades.beginStartOSUpgrade
package: '@azure/arm-compute-profile-2020-09-01-hybrid'
summary: >-
Starts a rolling upgrade to move all virtual machine scale set instances
to the latest available
Platform Image OS version. Instances which are already running the latest
available OS version are
not affected.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginStartOSUpgrade(resourceGroupName: string, vmScaleSetName:
string, options?:
VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams):
Promise<PollerLike<PollOperationState<void>, void>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: vmScaleSetName
type: string
description: The name of the VM scale set.
- id: options
type: >-
<xref
uid="@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.PollerLike" /><<xref
uid="@azure/core-lro.PollOperationState" /><void>, void>>
- name: >-
beginStartOSUpgradeAndWait(string, string,
VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams)
uid: >-
@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgrades.beginStartOSUpgradeAndWait
package: '@azure/arm-compute-profile-2020-09-01-hybrid'
summary: >-
Starts a rolling upgrade to move all virtual machine scale set instances
to the latest available
Platform Image OS version. Instances which are already running the latest
available OS version are
not affected.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginStartOSUpgradeAndWait(resourceGroupName: string,
vmScaleSetName: string, options?:
VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams):
Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: vmScaleSetName
type: string
description: The name of the VM scale set.
- id: options
type: >-
<xref
uid="@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: >-
getLatest(string, string,
VirtualMachineScaleSetRollingUpgradesGetLatestOptionalParams)
uid: >-
@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgrades.getLatest
package: '@azure/arm-compute-profile-2020-09-01-hybrid'
summary: Gets the status of the latest virtual machine scale set rolling upgrade.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getLatest(resourceGroupName: string, vmScaleSetName: string,
options?: VirtualMachineScaleSetRollingUpgradesGetLatestOptionalParams):
Promise<RollingUpgradeStatusInfo>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: vmScaleSetName
type: string
description: The name of the VM scale set.
- id: options
type: >-
<xref
uid="@azure/arm-compute-profile-2020-09-01-hybrid.VirtualMachineScaleSetRollingUpgradesGetLatestOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-compute-profile-2020-09-01-hybrid.RollingUpgradeStatusInfo"
/>>