DevBoxDefinitionProperties interface

Properties of a Dev Box definition.

Extends

Properties

activeImageReference

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.

imageValidationErrorDetails

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.

imageValidationStatus

Validation status of the configured image. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

validationStatus

Validation status for the Dev Box Definition. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

hibernateSupport

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

imageReference

Image reference information.

osStorageType

The storage type used for the Operating System disk of Dev Boxes created using this definition.

sku

The SKU for Dev Boxes created using this definition.

Property Details

activeImageReference

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.

activeImageReference?: ImageReference

Property Value

imageValidationErrorDetails

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.

imageValidationErrorDetails?: ImageValidationErrorDetails

Property Value

imageValidationStatus

Validation status of the configured image. NOTE: This property will not be serialized. It can only be populated by the server.

imageValidationStatus?: string

Property Value

string

provisioningState

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

validationStatus

Validation status for the Dev Box Definition. NOTE: This property will not be serialized. It can only be populated by the server.

validationStatus?: string

Property Value

string

Inherited Property Details

hibernateSupport

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

hibernateSupport?: string

Property Value

string

Inherited From DevBoxDefinitionUpdateProperties.hibernateSupport

imageReference

Image reference information.

imageReference?: ImageReference

Property Value

Inherited From DevBoxDefinitionUpdateProperties.imageReference

osStorageType

The storage type used for the Operating System disk of Dev Boxes created using this definition.

osStorageType?: string

Property Value

string

Inherited From DevBoxDefinitionUpdateProperties.osStorageType

sku

The SKU for Dev Boxes created using this definition.

sku?: Sku

Property Value

Sku

Inherited From DevBoxDefinitionUpdateProperties.sku