/
DevBoxDefinitionProperties.yml
160 lines (155 loc) · 5.51 KB
/
DevBoxDefinitionProperties.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
### YamlMime:TSType
name: DevBoxDefinitionProperties
uid: '@azure/arm-devcenter.DevBoxDefinitionProperties'
package: '@azure/arm-devcenter'
summary: Properties of a Dev Box definition.
fullName: DevBoxDefinitionProperties
remarks: ''
isDeprecated: false
type: interface
properties:
- name: activeImageReference
uid: '@azure/arm-devcenter.DevBoxDefinitionProperties.activeImageReference'
package: '@azure/arm-devcenter'
summary: >-
Image reference information for the currently active image (only populated
during updates).
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: activeImageReference
remarks: ''
isDeprecated: false
syntax:
content: 'activeImageReference?: ImageReference'
return:
description: ''
type: <xref uid="@azure/arm-devcenter.ImageReference" />
- name: imageValidationErrorDetails
uid: >-
@azure/arm-devcenter.DevBoxDefinitionProperties.imageValidationErrorDetails
package: '@azure/arm-devcenter'
summary: >-
Details for image validator error. Populated when the image validation is
not successful.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: imageValidationErrorDetails
remarks: ''
isDeprecated: false
syntax:
content: 'imageValidationErrorDetails?: ImageValidationErrorDetails'
return:
description: ''
type: <xref uid="@azure/arm-devcenter.ImageValidationErrorDetails" />
- name: imageValidationStatus
uid: '@azure/arm-devcenter.DevBoxDefinitionProperties.imageValidationStatus'
package: '@azure/arm-devcenter'
summary: >-
Validation status of the configured image.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: imageValidationStatus
remarks: ''
isDeprecated: false
syntax:
content: 'imageValidationStatus?: string'
return:
description: ''
type: string
- name: provisioningState
uid: '@azure/arm-devcenter.DevBoxDefinitionProperties.provisioningState'
package: '@azure/arm-devcenter'
summary: >-
The provisioning state of the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: provisioningState
remarks: ''
isDeprecated: false
syntax:
content: 'provisioningState?: string'
return:
description: ''
type: string
- name: validationStatus
uid: '@azure/arm-devcenter.DevBoxDefinitionProperties.validationStatus'
package: '@azure/arm-devcenter'
summary: >-
Validation status for the Dev Box Definition.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: validationStatus
remarks: ''
isDeprecated: false
syntax:
content: 'validationStatus?: string'
return:
description: ''
type: string
inheritedProperties:
- name: hibernateSupport
uid: '@azure/arm-devcenter.DevBoxDefinitionProperties.hibernateSupport'
package: '@azure/arm-devcenter'
summary: >-
Indicates whether Dev Boxes created with this definition are capable of
hibernation. Not all images are capable of supporting hibernation. To find
out more see https://aka.ms/devbox/hibernate
fullName: hibernateSupport
remarks: ''
isDeprecated: false
syntax:
content: 'hibernateSupport?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[DevBoxDefinitionUpdateProperties.hibernateSupport](xref:@azure/arm-devcenter.DevBoxDefinitionUpdateProperties.hibernateSupport)
- name: imageReference
uid: '@azure/arm-devcenter.DevBoxDefinitionProperties.imageReference'
package: '@azure/arm-devcenter'
summary: Image reference information.
fullName: imageReference
remarks: ''
isDeprecated: false
syntax:
content: 'imageReference?: ImageReference'
return:
description: ''
type: <xref uid="@azure/arm-devcenter.ImageReference" />
inheritanceDescription: >-
<b>Inherited From</b>
[DevBoxDefinitionUpdateProperties.imageReference](xref:@azure/arm-devcenter.DevBoxDefinitionUpdateProperties.imageReference)
- name: osStorageType
uid: '@azure/arm-devcenter.DevBoxDefinitionProperties.osStorageType'
package: '@azure/arm-devcenter'
summary: >-
The storage type used for the Operating System disk of Dev Boxes created
using this definition.
fullName: osStorageType
remarks: ''
isDeprecated: false
syntax:
content: 'osStorageType?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[DevBoxDefinitionUpdateProperties.osStorageType](xref:@azure/arm-devcenter.DevBoxDefinitionUpdateProperties.osStorageType)
- name: sku
uid: '@azure/arm-devcenter.DevBoxDefinitionProperties.sku'
package: '@azure/arm-devcenter'
summary: The SKU for Dev Boxes created using this definition.
fullName: sku
remarks: ''
isDeprecated: false
syntax:
content: 'sku?: Sku'
return:
description: ''
type: <xref uid="@azure/arm-devcenter.Sku" />
inheritanceDescription: >-
<b>Inherited From</b>
[DevBoxDefinitionUpdateProperties.sku](xref:@azure/arm-devcenter.DevBoxDefinitionUpdateProperties.sku)
extends: <xref uid="@azure/arm-devcenter.DevBoxDefinitionUpdateProperties" />