DevBoxDefinition interface

Represents a definition for a Developer Machine.

Extends

Properties

activeImageReference

Image reference information for the currently active image (only populated during updates).

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.

imageValidationErrorDetails

Details for image validator error. Populated when the image validation is not successful.

imageValidationStatus

Validation status of the configured image.

osStorageType

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

provisioningState

The provisioning state of the resource.

sku

The SKU for Dev Boxes created using this definition.

validationStatus

Validation status for the Dev Box Definition.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

The geo-location where the resource lives

name

The name of the resource

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags

Resource tags.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

activeImageReference

Image reference information for the currently active image (only populated during updates).

activeImageReference?: ImageReference

Property Value

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

imageReference

Image reference information.

imageReference?: ImageReference

Property Value

imageValidationErrorDetails

Details for image validator error. Populated when the image validation is not successful.

imageValidationErrorDetails?: ImageValidationErrorDetails

Property Value

imageValidationStatus

Validation status of the configured image.

imageValidationStatus?: string

Property Value

string

osStorageType

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

osStorageType?: string

Property Value

string

provisioningState

The provisioning state of the resource.

provisioningState?: string

Property Value

string

sku

The SKU for Dev Boxes created using this definition.

sku?: Sku

Property Value

Sku

validationStatus

Validation status for the Dev Box Definition.

validationStatus?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type