-
Notifications
You must be signed in to change notification settings - Fork 180
/
ContainerGroup.yml
409 lines (404 loc) · 14.5 KB
/
ContainerGroup.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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
### YamlMime:TSType
name: ContainerGroup
uid: '@azure/arm-containerinstance.ContainerGroup'
package: '@azure/arm-containerinstance'
summary: A container group.
fullName: ContainerGroup
remarks: ''
isDeprecated: false
type: interface
inheritedProperties:
- name: confidentialComputeProperties
uid: '@azure/arm-containerinstance.ContainerGroup.confidentialComputeProperties'
package: '@azure/arm-containerinstance'
summary: The properties for confidential container group
fullName: confidentialComputeProperties
remarks: ''
isDeprecated: false
syntax:
content: 'confidentialComputeProperties?: ConfidentialComputeProperties'
return:
description: ''
type: >-
<xref uid="@azure/arm-containerinstance.ConfidentialComputeProperties"
/>
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.confidentialComputeProperties](xref:@azure/arm-containerinstance.ContainerGroupProperties.confidentialComputeProperties)
- name: containers
uid: '@azure/arm-containerinstance.ContainerGroup.containers'
package: '@azure/arm-containerinstance'
summary: The containers within the container group.
fullName: containers
remarks: ''
isDeprecated: false
syntax:
content: 'containers: Container[]'
return:
description: ''
type: <xref uid="@azure/arm-containerinstance.Container" />[]
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.containers](xref:@azure/arm-containerinstance.ContainerGroupProperties.containers)
- name: diagnostics
uid: '@azure/arm-containerinstance.ContainerGroup.diagnostics'
package: '@azure/arm-containerinstance'
summary: The diagnostic information for a container group.
fullName: diagnostics
remarks: ''
isDeprecated: false
syntax:
content: 'diagnostics?: ContainerGroupDiagnostics'
return:
description: ''
type: <xref uid="@azure/arm-containerinstance.ContainerGroupDiagnostics" />
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.diagnostics](xref:@azure/arm-containerinstance.ContainerGroupProperties.diagnostics)
- name: dnsConfig
uid: '@azure/arm-containerinstance.ContainerGroup.dnsConfig'
package: '@azure/arm-containerinstance'
summary: The DNS config information for a container group.
fullName: dnsConfig
remarks: ''
isDeprecated: false
syntax:
content: 'dnsConfig?: DnsConfiguration'
return:
description: ''
type: <xref uid="@azure/arm-containerinstance.DnsConfiguration" />
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.dnsConfig](xref:@azure/arm-containerinstance.ContainerGroupProperties.dnsConfig)
- name: encryptionProperties
uid: '@azure/arm-containerinstance.ContainerGroup.encryptionProperties'
package: '@azure/arm-containerinstance'
summary: The encryption properties for a container group.
fullName: encryptionProperties
remarks: ''
isDeprecated: false
syntax:
content: 'encryptionProperties?: EncryptionProperties'
return:
description: ''
type: <xref uid="@azure/arm-containerinstance.EncryptionProperties" />
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.encryptionProperties](xref:@azure/arm-containerinstance.ContainerGroupProperties.encryptionProperties)
- name: extensions
uid: '@azure/arm-containerinstance.ContainerGroup.extensions'
package: '@azure/arm-containerinstance'
summary: extensions used by virtual kubelet
fullName: extensions
remarks: ''
isDeprecated: false
syntax:
content: 'extensions?: DeploymentExtensionSpec[]'
return:
description: ''
type: <xref uid="@azure/arm-containerinstance.DeploymentExtensionSpec" />[]
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.extensions](xref:@azure/arm-containerinstance.ContainerGroupProperties.extensions)
- name: id
uid: '@azure/arm-containerinstance.ContainerGroup.id'
package: '@azure/arm-containerinstance'
summary: >-
The resource id.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[Resource.id](xref:@azure/arm-containerinstance.Resource.id)
- name: identity
uid: '@azure/arm-containerinstance.ContainerGroup.identity'
package: '@azure/arm-containerinstance'
summary: The identity of the container group, if configured.
fullName: identity
remarks: ''
isDeprecated: false
syntax:
content: 'identity?: ContainerGroupIdentity'
return:
description: ''
type: <xref uid="@azure/arm-containerinstance.ContainerGroupIdentity" />
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.identity](xref:@azure/arm-containerinstance.ContainerGroupProperties.identity)
- name: imageRegistryCredentials
uid: '@azure/arm-containerinstance.ContainerGroup.imageRegistryCredentials'
package: '@azure/arm-containerinstance'
summary: >-
The image registry credentials by which the container group is created
from.
fullName: imageRegistryCredentials
remarks: ''
isDeprecated: false
syntax:
content: 'imageRegistryCredentials?: ImageRegistryCredential[]'
return:
description: ''
type: <xref uid="@azure/arm-containerinstance.ImageRegistryCredential" />[]
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.imageRegistryCredentials](xref:@azure/arm-containerinstance.ContainerGroupProperties.imageRegistryCredentials)
- name: initContainers
uid: '@azure/arm-containerinstance.ContainerGroup.initContainers'
package: '@azure/arm-containerinstance'
summary: The init containers for a container group.
fullName: initContainers
remarks: ''
isDeprecated: false
syntax:
content: 'initContainers?: InitContainerDefinition[]'
return:
description: ''
type: <xref uid="@azure/arm-containerinstance.InitContainerDefinition" />[]
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.initContainers](xref:@azure/arm-containerinstance.ContainerGroupProperties.initContainers)
- name: instanceView
uid: '@azure/arm-containerinstance.ContainerGroup.instanceView'
package: '@azure/arm-containerinstance'
summary: >-
The instance view of the container group. Only valid in response.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: instanceView
remarks: ''
isDeprecated: false
syntax:
content: 'instanceView?: ContainerGroupPropertiesInstanceView'
return:
description: ''
type: >-
<xref
uid="@azure/arm-containerinstance.ContainerGroupPropertiesInstanceView"
/>
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.instanceView](xref:@azure/arm-containerinstance.ContainerGroupProperties.instanceView)
- name: ipAddress
uid: '@azure/arm-containerinstance.ContainerGroup.ipAddress'
package: '@azure/arm-containerinstance'
summary: The IP address type of the container group.
fullName: ipAddress
remarks: ''
isDeprecated: false
syntax:
content: 'ipAddress?: IpAddress'
return:
description: ''
type: <xref uid="@azure/arm-containerinstance.IpAddress" />
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.ipAddress](xref:@azure/arm-containerinstance.ContainerGroupProperties.ipAddress)
- name: location
uid: '@azure/arm-containerinstance.ContainerGroup.location'
package: '@azure/arm-containerinstance'
summary: The resource location.
fullName: location
remarks: ''
isDeprecated: false
syntax:
content: 'location?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[Resource.location](xref:@azure/arm-containerinstance.Resource.location)
- name: name
uid: '@azure/arm-containerinstance.ContainerGroup.name'
package: '@azure/arm-containerinstance'
summary: >-
The resource name.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[Resource.name](xref:@azure/arm-containerinstance.Resource.name)
- name: osType
uid: '@azure/arm-containerinstance.ContainerGroup.osType'
package: '@azure/arm-containerinstance'
summary: >-
The operating system type required by the containers in the container
group.
fullName: osType
remarks: ''
isDeprecated: false
syntax:
content: 'osType: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.osType](xref:@azure/arm-containerinstance.ContainerGroupProperties.osType)
- name: priority
uid: '@azure/arm-containerinstance.ContainerGroup.priority'
package: '@azure/arm-containerinstance'
summary: The priority of the container group.
fullName: priority
remarks: ''
isDeprecated: false
syntax:
content: 'priority?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.priority](xref:@azure/arm-containerinstance.ContainerGroupProperties.priority)
- name: provisioningState
uid: '@azure/arm-containerinstance.ContainerGroup.provisioningState'
package: '@azure/arm-containerinstance'
summary: >-
The provisioning state of the container group. This only appears in the
response.
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
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.provisioningState](xref:@azure/arm-containerinstance.ContainerGroupProperties.provisioningState)
- name: restartPolicy
uid: '@azure/arm-containerinstance.ContainerGroup.restartPolicy'
package: '@azure/arm-containerinstance'
summary: |-
Restart policy for all containers within the container group.
- `Always` Always restart
- `OnFailure` Restart on failure
- `Never` Never restart
fullName: restartPolicy
remarks: ''
isDeprecated: false
syntax:
content: 'restartPolicy?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.restartPolicy](xref:@azure/arm-containerinstance.ContainerGroupProperties.restartPolicy)
- name: sku
uid: '@azure/arm-containerinstance.ContainerGroup.sku'
package: '@azure/arm-containerinstance'
summary: The SKU for a container group.
fullName: sku
remarks: ''
isDeprecated: false
syntax:
content: 'sku?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.sku](xref:@azure/arm-containerinstance.ContainerGroupProperties.sku)
- name: subnetIds
uid: '@azure/arm-containerinstance.ContainerGroup.subnetIds'
package: '@azure/arm-containerinstance'
summary: The subnet resource IDs for a container group.
fullName: subnetIds
remarks: ''
isDeprecated: false
syntax:
content: 'subnetIds?: ContainerGroupSubnetId[]'
return:
description: ''
type: <xref uid="@azure/arm-containerinstance.ContainerGroupSubnetId" />[]
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.subnetIds](xref:@azure/arm-containerinstance.ContainerGroupProperties.subnetIds)
- name: tags
uid: '@azure/arm-containerinstance.ContainerGroup.tags'
package: '@azure/arm-containerinstance'
summary: The resource tags.
fullName: tags
remarks: ''
isDeprecated: false
syntax:
content: 'tags?: {[propertyName: string]: string}'
return:
description: ''
type: '{[propertyName: string]: string}'
inheritanceDescription: >-
<b>Inherited From</b>
[Resource.tags](xref:@azure/arm-containerinstance.Resource.tags)
- name: type
uid: '@azure/arm-containerinstance.ContainerGroup.type'
package: '@azure/arm-containerinstance'
summary: >-
The resource type.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[Resource.type](xref:@azure/arm-containerinstance.Resource.type)
- name: volumes
uid: '@azure/arm-containerinstance.ContainerGroup.volumes'
package: '@azure/arm-containerinstance'
summary: >-
The list of volumes that can be mounted by containers in this container
group.
fullName: volumes
remarks: ''
isDeprecated: false
syntax:
content: 'volumes?: Volume[]'
return:
description: ''
type: <xref uid="@azure/arm-containerinstance.Volume" />[]
inheritanceDescription: >-
<b>Inherited From</b>
[ContainerGroupProperties.volumes](xref:@azure/arm-containerinstance.ContainerGroupProperties.volumes)
- name: zones
uid: '@azure/arm-containerinstance.ContainerGroup.zones'
package: '@azure/arm-containerinstance'
summary: The zones for the container group.
fullName: zones
remarks: ''
isDeprecated: false
syntax:
content: 'zones?: string[]'
return:
description: ''
type: string[]
inheritanceDescription: >-
<b>Inherited From</b>
[Resource.zones](xref:@azure/arm-containerinstance.Resource.zones)
extends: >-
<xref uid="@azure/arm-containerinstance.Resource" />,<xref
uid="@azure/arm-containerinstance.ContainerGroupProperties" />