-
Notifications
You must be signed in to change notification settings - Fork 180
/
AmlComputeProperties.yml
263 lines (257 loc) · 9.07 KB
/
AmlComputeProperties.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: AmlComputeProperties
uid: '@azure/arm-machinelearning.AmlComputeProperties'
package: '@azure/arm-machinelearning'
summary: AML Compute properties
fullName: AmlComputeProperties
remarks: ''
isDeprecated: false
type: interface
properties:
- name: allocationState
uid: '@azure/arm-machinelearning.AmlComputeProperties.allocationState'
package: '@azure/arm-machinelearning'
summary: >-
Allocation state of the compute. Possible values are: steady - Indicates
that the compute is not resizing. There are no changes to the number of
compute nodes in the compute in progress. A compute enters this state when
it is created and when no operations are being performed on the compute to
change the number of compute nodes. resizing - Indicates that the compute
is resizing; that is, compute nodes are being added to or removed from the
compute.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: allocationState
remarks: ''
isDeprecated: false
syntax:
content: 'allocationState?: string'
return:
description: ''
type: string
- name: allocationStateTransitionTime
uid: >-
@azure/arm-machinelearning.AmlComputeProperties.allocationStateTransitionTime
package: '@azure/arm-machinelearning'
summary: >-
The time at which the compute entered its current allocation state.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: allocationStateTransitionTime
remarks: ''
isDeprecated: false
syntax:
content: 'allocationStateTransitionTime?: Date'
return:
description: ''
type: Date
- name: currentNodeCount
uid: '@azure/arm-machinelearning.AmlComputeProperties.currentNodeCount'
package: '@azure/arm-machinelearning'
summary: >-
The number of compute nodes currently assigned to the compute.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: currentNodeCount
remarks: ''
isDeprecated: false
syntax:
content: 'currentNodeCount?: number'
return:
description: ''
type: number
- name: enableNodePublicIp
uid: '@azure/arm-machinelearning.AmlComputeProperties.enableNodePublicIp'
package: '@azure/arm-machinelearning'
summary: >-
Enable or disable node public IP address provisioning. Possible values
are: Possible values are: true - Indicates that the compute nodes will
have public IPs provisioned. false - Indicates that the compute nodes will
have a private endpoint and no public IPs.
fullName: enableNodePublicIp
remarks: ''
isDeprecated: false
syntax:
content: 'enableNodePublicIp?: boolean'
return:
description: ''
type: boolean
- name: errors
uid: '@azure/arm-machinelearning.AmlComputeProperties.errors'
package: '@azure/arm-machinelearning'
summary: >-
Collection of errors encountered by various compute nodes during node
setup.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: errors
remarks: ''
isDeprecated: false
syntax:
content: 'errors?: ErrorResponse[]'
return:
description: ''
type: <xref uid="@azure/arm-machinelearning.ErrorResponse" />[]
- name: isolatedNetwork
uid: '@azure/arm-machinelearning.AmlComputeProperties.isolatedNetwork'
package: '@azure/arm-machinelearning'
summary: Network is isolated or not
fullName: isolatedNetwork
remarks: ''
isDeprecated: false
syntax:
content: 'isolatedNetwork?: boolean'
return:
description: ''
type: boolean
- name: nodeStateCounts
uid: '@azure/arm-machinelearning.AmlComputeProperties.nodeStateCounts'
package: '@azure/arm-machinelearning'
summary: >-
Counts of various node states on the compute.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: nodeStateCounts
remarks: ''
isDeprecated: false
syntax:
content: 'nodeStateCounts?: NodeStateCounts'
return:
description: ''
type: <xref uid="@azure/arm-machinelearning.NodeStateCounts" />
- name: osType
uid: '@azure/arm-machinelearning.AmlComputeProperties.osType'
package: '@azure/arm-machinelearning'
summary: Compute OS Type
fullName: osType
remarks: ''
isDeprecated: false
syntax:
content: 'osType?: string'
return:
description: ''
type: string
- name: propertyBag
uid: '@azure/arm-machinelearning.AmlComputeProperties.propertyBag'
package: '@azure/arm-machinelearning'
summary: A property bag containing additional properties.
fullName: propertyBag
remarks: ''
isDeprecated: false
syntax:
content: 'propertyBag?: Record<string, unknown>'
return:
description: ''
type: Record<string, unknown>
- name: remoteLoginPortPublicAccess
uid: >-
@azure/arm-machinelearning.AmlComputeProperties.remoteLoginPortPublicAccess
package: '@azure/arm-machinelearning'
summary: >-
State of the public SSH port. Possible values are: Disabled - Indicates
that the public ssh port is closed on all nodes of the cluster. Enabled -
Indicates that the public ssh port is open on all nodes of the cluster.
NotSpecified - Indicates that the public ssh port is closed on all nodes
of the cluster if VNet is defined, else is open all public nodes. It can
be default only during cluster creation time, after creation it will be
either enabled or disabled.
fullName: remoteLoginPortPublicAccess
remarks: ''
isDeprecated: false
syntax:
content: 'remoteLoginPortPublicAccess?: string'
return:
description: ''
type: string
- name: scaleSettings
uid: '@azure/arm-machinelearning.AmlComputeProperties.scaleSettings'
package: '@azure/arm-machinelearning'
summary: Scale settings for AML Compute
fullName: scaleSettings
remarks: ''
isDeprecated: false
syntax:
content: 'scaleSettings?: ScaleSettings'
return:
description: ''
type: <xref uid="@azure/arm-machinelearning.ScaleSettings" />
- name: subnet
uid: '@azure/arm-machinelearning.AmlComputeProperties.subnet'
package: '@azure/arm-machinelearning'
summary: Virtual network subnet resource ID the compute nodes belong to.
fullName: subnet
remarks: ''
isDeprecated: false
syntax:
content: 'subnet?: ResourceId'
return:
description: ''
type: <xref uid="@azure/arm-machinelearning.ResourceId" />
- name: targetNodeCount
uid: '@azure/arm-machinelearning.AmlComputeProperties.targetNodeCount'
package: '@azure/arm-machinelearning'
summary: >-
The target number of compute nodes for the compute. If the allocationState
is resizing, this property denotes the target node count for the ongoing
resize operation. If the allocationState is steady, this property denotes
the target node count for the previous resize operation.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: targetNodeCount
remarks: ''
isDeprecated: false
syntax:
content: 'targetNodeCount?: number'
return:
description: ''
type: number
- name: userAccountCredentials
uid: '@azure/arm-machinelearning.AmlComputeProperties.userAccountCredentials'
package: '@azure/arm-machinelearning'
summary: >-
Credentials for an administrator user account that will be created on each
compute node.
fullName: userAccountCredentials
remarks: ''
isDeprecated: false
syntax:
content: 'userAccountCredentials?: UserAccountCredentials'
return:
description: ''
type: <xref uid="@azure/arm-machinelearning.UserAccountCredentials" />
- name: virtualMachineImage
uid: '@azure/arm-machinelearning.AmlComputeProperties.virtualMachineImage'
package: '@azure/arm-machinelearning'
summary: Virtual Machine image for AML Compute - windows only
fullName: virtualMachineImage
remarks: ''
isDeprecated: false
syntax:
content: 'virtualMachineImage?: VirtualMachineImage'
return:
description: ''
type: <xref uid="@azure/arm-machinelearning.VirtualMachineImage" />
- name: vmPriority
uid: '@azure/arm-machinelearning.AmlComputeProperties.vmPriority'
package: '@azure/arm-machinelearning'
summary: Virtual Machine priority
fullName: vmPriority
remarks: ''
isDeprecated: false
syntax:
content: 'vmPriority?: string'
return:
description: ''
type: string
- name: vmSize
uid: '@azure/arm-machinelearning.AmlComputeProperties.vmSize'
package: '@azure/arm-machinelearning'
summary: Virtual Machine Size
fullName: vmSize
remarks: ''
isDeprecated: false
syntax:
content: 'vmSize?: string'
return:
description: ''
type: string