Share via


Pool Class

Definition

A pool of Virtual Machines.

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

Constructors

Pool()

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

Id

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

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.

Location

The geo-location where the resource lives

ManagedVirtualNetworkRegion

The regions of the managed virtual network (required when managedNetworkType is Managed).

Name

The name of the resource

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.

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.

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"

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

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of Pool.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of Pool into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to