PoolProperties Class

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview

Assembly:: Az.DevCenter.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Properties of a Pool

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.PoolPropertiesTypeConverter))]
public class PoolProperties : Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.IPoolProperties, Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.PoolPropertiesTypeConverter))>]
type PoolProperties = class
    interface IPoolProperties
    interface IJsonSerializable
    interface IPoolUpdateProperties
    interface IValidates

Public Class PoolProperties
Implements IPoolProperties, IValidates

Inheritance: Object
PoolProperties

Attributes: TypeConverterAttribute

Implements: IPoolProperties IPoolUpdateProperties IJsonSerializable IValidates

Constructors

Name	Description
PoolProperties()	Creates an new PoolProperties instance.

Properties

Name	Description
ActiveHourConfigurationAutoStartEnableStatus	Enables or disables whether the Dev Box should be automatically started at commencement of active hours.
ActiveHourConfigurationDefaultEndTimeHour	The default end time of the active hours
ActiveHourConfigurationDefaultStartTimeHour	The default start time of the active hours.
ActiveHourConfigurationDefaultTimeZone	The default IANA timezone id of the active hours.
ActiveHourConfigurationKeepAwakeEnableStatus	Enables or disables whether the Dev Box should be kept awake during active hours.
ActiveHoursConfiguration	Active hours configuration settings for Dev Boxes created in this pool.
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.
DevBoxCount	Indicates the number of provisioned Dev Boxes in this pool.
DevBoxDefinition	A definition of the machines that are created from this Pool. Will be ignored if devBoxDefinitionType is Reference or not provided.
DevBoxDefinitionActiveImageReference	Image reference information for the currently active image (only populated during updates).
DevBoxDefinitionImageReference	Image reference information.
DevBoxDefinitionName	Name of a Dev Box definition in parent Project of this Pool. Will be ignored if devBoxDefinitionType is Value.
DevBoxDefinitionSku	The SKU for Dev Boxes created from the Pool.
DevBoxDefinitionType	Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.
DevBoxTunnelEnableStatus	Indicates whether Dev Box Tunnel is enabled for a the pool.
DisplayName	The display name of the pool.
HealthStatus	Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.
HealthStatusDetail	Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state
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.
LicenseType	Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.
LocalAdministrator	Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.
ManagedVirtualNetworkRegion	The regions of the managed virtual network (required when managedNetworkType is Managed).
NetworkConnectionName	Name of a Network Connection in parent Project of this Pool
ProvisioningState	The provisioning state of the resource.
SingleSignOnStatus	Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.
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.
StopOnDisconnect	Stop on disconnect configuration settings for Dev Boxes created in this pool.
StopOnDisconnectGracePeriodMinute	The specified time in minutes to wait before stopping a Dev Box once disconnect is detected.
StopOnDisconnectStatus	Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled.
StopOnNoConnect	Stop on no connect configuration settings for Dev Boxes created in this pool.
StopOnNoConnectGracePeriodMinute	The specified time in minutes to wait before stopping a Dev Box if no connection is made.
StopOnNoConnectStatus	Enables the feature to stop a started Dev Box when it has not been connected to, once the grace period has lapsed.
VirtualNetworkType	Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.

Methods

Name	Description
DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of PoolProperties.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of PoolProperties.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.IPoolProperties.
FromJsonString(String)	Creates a new instance of PoolProperties, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of PoolProperties into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
Validate(IEventListener)	Validates that this object meets the validation criteria.

Applies to