Share via


PoolProperties Class

Definition

Properties of a Pool

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

Constructors

PoolProperties()

Creates an new PoolProperties instance.

Properties

DevBoxCount

Indicates the number of provisioned Dev Boxes in this pool.

DevBoxDefinitionName

Name of a Dev Box definition in parent Project of this 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

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.

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.

VirtualNetworkType

Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.

Methods

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