-
Notifications
You must be signed in to change notification settings - Fork 180
/
VirtualMachines.yml
162 lines (162 loc) · 6.32 KB
/
VirtualMachines.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
### YamlMime:TSType
name: VirtualMachines
uid: '@azure/arm-avs.VirtualMachines'
package: '@azure/arm-avs'
summary: Interface representing a VirtualMachines.
fullName: VirtualMachines
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
beginRestrictMovement(string, string, string, string,
VirtualMachineRestrictMovement,
VirtualMachinesRestrictMovementOptionalParams)
uid: '@azure/arm-avs.VirtualMachines.beginRestrictMovement'
package: '@azure/arm-avs'
summary: Enable or disable DRS-driven VM movement restriction
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginRestrictMovement(resourceGroupName: string,
privateCloudName: string, clusterName: string, virtualMachineId: string,
restrictMovement: VirtualMachineRestrictMovement, options?:
VirtualMachinesRestrictMovementOptionalParams):
Promise<SimplePollerLike<OperationState<VirtualMachinesRestrictMovementHeaders>,
VirtualMachinesRestrictMovementHeaders>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: privateCloudName
type: string
description: Name of the private cloud
- id: clusterName
type: string
description: Name of the cluster
- id: virtualMachineId
type: string
description: ID of the virtual machine.
- id: restrictMovement
type: <xref uid="@azure/arm-avs.VirtualMachineRestrictMovement" />
description: The body type of the operation request.
- id: options
type: >-
<xref
uid="@azure/arm-avs.VirtualMachinesRestrictMovementOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><<xref
uid="@azure/arm-avs.VirtualMachinesRestrictMovementHeaders" />>,
<xref uid="@azure/arm-avs.VirtualMachinesRestrictMovementHeaders"
/>>>
- name: >-
beginRestrictMovementAndWait(string, string, string, string,
VirtualMachineRestrictMovement,
VirtualMachinesRestrictMovementOptionalParams)
uid: '@azure/arm-avs.VirtualMachines.beginRestrictMovementAndWait'
package: '@azure/arm-avs'
summary: Enable or disable DRS-driven VM movement restriction
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginRestrictMovementAndWait(resourceGroupName: string,
privateCloudName: string, clusterName: string, virtualMachineId: string,
restrictMovement: VirtualMachineRestrictMovement, options?:
VirtualMachinesRestrictMovementOptionalParams):
Promise<VirtualMachinesRestrictMovementHeaders>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: privateCloudName
type: string
description: Name of the private cloud
- id: clusterName
type: string
description: Name of the cluster
- id: virtualMachineId
type: string
description: ID of the virtual machine.
- id: restrictMovement
type: <xref uid="@azure/arm-avs.VirtualMachineRestrictMovement" />
description: The body type of the operation request.
- id: options
type: >-
<xref
uid="@azure/arm-avs.VirtualMachinesRestrictMovementOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-avs.VirtualMachinesRestrictMovementHeaders" />>
- name: get(string, string, string, string, VirtualMachinesGetOptionalParams)
uid: '@azure/arm-avs.VirtualMachines.get'
package: '@azure/arm-avs'
summary: Get a VirtualMachine
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, privateCloudName: string,
clusterName: string, virtualMachineId: string, options?:
VirtualMachinesGetOptionalParams): Promise<VirtualMachine>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: privateCloudName
type: string
description: Name of the private cloud
- id: clusterName
type: string
description: Name of the cluster
- id: virtualMachineId
type: string
description: ID of the virtual machine.
- id: options
type: <xref uid="@azure/arm-avs.VirtualMachinesGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-avs.VirtualMachine" />>
- name: list(string, string, string, VirtualMachinesListOptionalParams)
uid: '@azure/arm-avs.VirtualMachines.list'
package: '@azure/arm-avs'
summary: List VirtualMachine resources by Cluster
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(resourceGroupName: string, privateCloudName: string,
clusterName: string, options?: VirtualMachinesListOptionalParams):
PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[],
PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: privateCloudName
type: string
description: Name of the private cloud
- id: clusterName
type: string
description: Name of the cluster
- id: options
type: <xref uid="@azure/arm-avs.VirtualMachinesListOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-avs.VirtualMachine" />, <xref
uid="@azure/arm-avs.VirtualMachine" />[], <xref
uid="@azure/core-paging.PageSettings" />>