-
Notifications
You must be signed in to change notification settings - Fork 180
/
Consoles.yml
279 lines (275 loc) · 10.9 KB
/
Consoles.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
### YamlMime:TSType
name: Consoles
uid: '@azure/arm-networkcloud.Consoles'
package: '@azure/arm-networkcloud'
summary: Interface representing a Consoles.
fullName: Consoles
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
beginCreateOrUpdate(string, string, string, Console_2,
ConsolesCreateOrUpdateOptionalParams)
uid: '@azure/arm-networkcloud.Consoles.beginCreateOrUpdate'
package: '@azure/arm-networkcloud'
summary: >-
Create a new virtual machine console or update the properties of the
existing virtual machine
console.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdate(resourceGroupName: string,
virtualMachineName: string, consoleName: string, consoleParameters:
Console_2, options?: ConsolesCreateOrUpdateOptionalParams):
Promise<SimplePollerLike<OperationState<Console_2>, Console_2>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: virtualMachineName
type: string
description: The name of the virtual machine.
- id: consoleName
type: string
description: The name of the virtual machine console.
- id: consoleParameters
type: <xref uid="@azure/arm-networkcloud.Console" />
description: The request body.
- id: options
type: >-
<xref
uid="@azure/arm-networkcloud.ConsolesCreateOrUpdateOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><<xref
uid="@azure/arm-networkcloud.Console" />>, <xref
uid="@azure/arm-networkcloud.Console" />>>
- name: >-
beginCreateOrUpdateAndWait(string, string, string, Console_2,
ConsolesCreateOrUpdateOptionalParams)
uid: '@azure/arm-networkcloud.Consoles.beginCreateOrUpdateAndWait'
package: '@azure/arm-networkcloud'
summary: >-
Create a new virtual machine console or update the properties of the
existing virtual machine
console.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdateAndWait(resourceGroupName: string,
virtualMachineName: string, consoleName: string, consoleParameters:
Console_2, options?: ConsolesCreateOrUpdateOptionalParams):
Promise<Console_2>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: virtualMachineName
type: string
description: The name of the virtual machine.
- id: consoleName
type: string
description: The name of the virtual machine console.
- id: consoleParameters
type: <xref uid="@azure/arm-networkcloud.Console" />
description: The request body.
- id: options
type: >-
<xref
uid="@azure/arm-networkcloud.ConsolesCreateOrUpdateOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-networkcloud.Console" />>
- name: beginDelete(string, string, string, ConsolesDeleteOptionalParams)
uid: '@azure/arm-networkcloud.Consoles.beginDelete'
package: '@azure/arm-networkcloud'
summary: Delete the provided virtual machine console.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDelete(resourceGroupName: string, virtualMachineName:
string, consoleName: string, options?: ConsolesDeleteOptionalParams):
Promise<SimplePollerLike<OperationState<void>, void>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: virtualMachineName
type: string
description: The name of the virtual machine.
- id: consoleName
type: string
description: The name of the virtual machine console.
- id: options
type: <xref uid="@azure/arm-networkcloud.ConsolesDeleteOptionalParams" />
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, string, ConsolesDeleteOptionalParams)
uid: '@azure/arm-networkcloud.Consoles.beginDeleteAndWait'
package: '@azure/arm-networkcloud'
summary: Delete the provided virtual machine console.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDeleteAndWait(resourceGroupName: string,
virtualMachineName: string, consoleName: string, options?:
ConsolesDeleteOptionalParams): Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: virtualMachineName
type: string
description: The name of the virtual machine.
- id: consoleName
type: string
description: The name of the virtual machine console.
- id: options
type: <xref uid="@azure/arm-networkcloud.ConsolesDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: beginUpdate(string, string, string, ConsolesUpdateOptionalParams)
uid: '@azure/arm-networkcloud.Consoles.beginUpdate'
package: '@azure/arm-networkcloud'
summary: >-
Patch the properties of the provided virtual machine console, or update
the tags associated with the
virtual machine console. Properties and tag updates can be done
independently.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginUpdate(resourceGroupName: string, virtualMachineName:
string, consoleName: string, options?: ConsolesUpdateOptionalParams):
Promise<SimplePollerLike<OperationState<Console_2>, Console_2>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: virtualMachineName
type: string
description: The name of the virtual machine.
- id: consoleName
type: string
description: The name of the virtual machine console.
- id: options
type: <xref uid="@azure/arm-networkcloud.ConsolesUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><<xref
uid="@azure/arm-networkcloud.Console" />>, <xref
uid="@azure/arm-networkcloud.Console" />>>
- name: beginUpdateAndWait(string, string, string, ConsolesUpdateOptionalParams)
uid: '@azure/arm-networkcloud.Consoles.beginUpdateAndWait'
package: '@azure/arm-networkcloud'
summary: >-
Patch the properties of the provided virtual machine console, or update
the tags associated with the
virtual machine console. Properties and tag updates can be done
independently.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginUpdateAndWait(resourceGroupName: string,
virtualMachineName: string, consoleName: string, options?:
ConsolesUpdateOptionalParams): Promise<Console_2>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: virtualMachineName
type: string
description: The name of the virtual machine.
- id: consoleName
type: string
description: The name of the virtual machine console.
- id: options
type: <xref uid="@azure/arm-networkcloud.ConsolesUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-networkcloud.Console" />>
- name: get(string, string, string, ConsolesGetOptionalParams)
uid: '@azure/arm-networkcloud.Consoles.get'
package: '@azure/arm-networkcloud'
summary: Get properties of the provided virtual machine console.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, virtualMachineName: string,
consoleName: string, options?: ConsolesGetOptionalParams):
Promise<Console_2>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: virtualMachineName
type: string
description: The name of the virtual machine.
- id: consoleName
type: string
description: The name of the virtual machine console.
- id: options
type: <xref uid="@azure/arm-networkcloud.ConsolesGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-networkcloud.Console" />>
- name: >-
listByVirtualMachine(string, string,
ConsolesListByVirtualMachineOptionalParams)
uid: '@azure/arm-networkcloud.Consoles.listByVirtualMachine'
package: '@azure/arm-networkcloud'
summary: Get a list of consoles for the provided virtual machine.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByVirtualMachine(resourceGroupName: string,
virtualMachineName: string, options?:
ConsolesListByVirtualMachineOptionalParams):
PagedAsyncIterableIterator<Console_2, Console_2[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: virtualMachineName
type: string
description: The name of the virtual machine.
- id: options
type: >-
<xref
uid="@azure/arm-networkcloud.ConsolesListByVirtualMachineOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-networkcloud.Console" />, <xref
uid="@azure/arm-networkcloud.Console" />[], <xref
uid="@azure/core-paging.PageSettings" />>