Share via


DevBoxDefinitionProperties Class

Definition

Properties of a Dev Box definition.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20240501Preview.DevBoxDefinitionPropertiesTypeConverter))]
public class DevBoxDefinitionProperties : Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20240501Preview.IDevBoxDefinitionProperties, Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20240501Preview.DevBoxDefinitionPropertiesTypeConverter))>]
type DevBoxDefinitionProperties = class
    interface IDevBoxDefinitionProperties
    interface IJsonSerializable
    interface IDevBoxDefinitionUpdateProperties
    interface IValidates
Public Class DevBoxDefinitionProperties
Implements IDevBoxDefinitionProperties, IValidates
Inheritance
DevBoxDefinitionProperties
Attributes
Implements

Constructors

DevBoxDefinitionProperties()

Creates an new DevBoxDefinitionProperties 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

ImageReference

Image reference information.

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.

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.

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.

ValidationStatus

Validation status for the Dev Box Definition.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of DevBoxDefinitionProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of DevBoxDefinitionProperties.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of DevBoxDefinitionProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to