Share via

DevBoxDefinition interface

Package:
@azure/arm-devcenter

Represents a definition for a Developer Machine.

Extends
TrackedResource

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.
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. 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.
osStorageType

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

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

The SKU for Dev Boxes created using this definition.
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

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

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

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

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

ImageReference

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

ImageReference

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

ImageValidationErrorDetails

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

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. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

validationStatus?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

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 NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type