Share via

DevBoxOutput interface

Package:
@azure-rest/developer-devcenter

A Dev Box.

Properties

actionState

The current action state of the Dev Box. This is state is based on previous action performed by user.
createdTime

Creation time of this Dev Box, in RFC3339 format.
error

Provisioning or action error details. Populated only for error states.
hardwareProfile

Information about the Dev Box's hardware resources.
hibernateSupport

Indicates whether hibernate is enabled/disabled or unknown.

Possible values: "Enabled", "Disabled", "OsUnsupported"
imageReference

Information about the image used for this Dev Box.
localAdministrator

Indicates whether the owner of the Dev Box is a local administrator.

Possible values: "Enabled", "Disabled"
location

Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to.
name

Display name for the Dev Box.
osType

The operating system type of this Dev Box.

Possible values: "Windows"
poolName

The name of the Dev Box pool this machine belongs to.
powerState

The current power state of the Dev Box.

Possible values: "Unknown", "Running", "Deallocated", "PoweredOff", "Hibernated"
projectName

Name of the project this Dev Box belongs to.
provisioningState

The current provisioning state of the Dev Box.

Possible values: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", "Updating", "Starting", "Stopping", "Provisioning", "ProvisionedWithWarning", "InGracePeriod", "NotProvisioned"
storageProfile

Storage settings for this Dev Box.
uniqueId

A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
user

The AAD object id of the user this Dev Box is assigned to.

Property Details

actionState

The current action state of the Dev Box. This is state is based on previous action performed by user.

actionState?: string

Property Value

string

createdTime

Creation time of this Dev Box, in RFC3339 format.

createdTime?: string

Property Value

string

error

Provisioning or action error details. Populated only for error states.

error?: ErrorModel

Property Value

ErrorModel

hardwareProfile

Information about the Dev Box's hardware resources.

hardwareProfile?: HardwareProfileOutput

Property Value

HardwareProfileOutput

hibernateSupport

Indicates whether hibernate is enabled/disabled or unknown.

Possible values: "Enabled", "Disabled", "OsUnsupported"

hibernateSupport?: string

Property Value

string

imageReference

Information about the image used for this Dev Box.

imageReference?: ImageReferenceOutput

Property Value

ImageReferenceOutput

localAdministrator

Indicates whether the owner of the Dev Box is a local administrator.

Possible values: "Enabled", "Disabled"

localAdministrator?: string

Property Value

string

location

Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to.

location?: string

Property Value

string

name

Display name for the Dev Box.

name: string

Property Value

string

osType

The operating system type of this Dev Box.

Possible values: "Windows"

osType?: string

Property Value

string

poolName

The name of the Dev Box pool this machine belongs to.

poolName: string

Property Value

string

powerState

The current power state of the Dev Box.

Possible values: "Unknown", "Running", "Deallocated", "PoweredOff", "Hibernated"

powerState?: string

Property Value

string

projectName

Name of the project this Dev Box belongs to.

projectName?: string

Property Value

string

provisioningState

The current provisioning state of the Dev Box.

Possible values: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", "Updating", "Starting", "Stopping", "Provisioning", "ProvisionedWithWarning", "InGracePeriod", "NotProvisioned"

provisioningState?: string

Property Value

string

storageProfile

Storage settings for this Dev Box.

storageProfile?: StorageProfileOutput

Property Value

StorageProfileOutput

uniqueId

A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

uniqueId?: string

Property Value

string

user

The AAD object id of the user this Dev Box is assigned to.

user?: string

Property Value

string