Share via


DevBoxDefinition Class

Definition

Represents a definition for a Developer Machine.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20240501Preview.DevBoxDefinitionTypeConverter))]
public class DevBoxDefinition : Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20240501Preview.IDevBoxDefinition, Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20240501Preview.DevBoxDefinitionTypeConverter))>]
type DevBoxDefinition = class
    interface IDevBoxDefinition
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
    interface IValidates
Public Class DevBoxDefinition
Implements IDevBoxDefinition, IValidates
Inheritance
DevBoxDefinition
Attributes
Implements

Constructors

DevBoxDefinition()

Creates an new DevBoxDefinition instance.

Properties

ActiveImageReferenceExactVersion

The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use.

ActiveImageReferenceId

Image ID, or Image version ID. When Image ID is provided, its latest version will be used.

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

Id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

ImageReferenceExactVersion

The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use.

ImageReferenceId

Image ID, or Image version ID. When Image ID is provided, its latest version will be used.

ImageValidationErrorDetailCode

An identifier for the error.

ImageValidationErrorDetailMessage

A message describing the error.

ImageValidationStatus

Validation status of the configured image.

Location

The geo-location where the resource lives

Name

The name of the resource

OSStorageType

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

ProvisioningState

The provisioning state of the resource.

SkuCapacity

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

SkuFamily

If the service has different generations of hardware, for the same SKU, then that can be captured here.

SkuName

The name of the SKU. E.g. P3. It is typically a letter+number code

SkuSize

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Tag

Resource tags.

Type

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

ValidationStatus

Validation status for the Dev Box Definition.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of DevBoxDefinition.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of DevBoxDefinition.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20240501Preview.IDevBoxDefinition.

FromJsonString(String)

Creates a new instance of DevBoxDefinition, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of DevBoxDefinition into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to