Pool interface
A pool of Virtual Machines.
- Extends
Properties
| active |
Active hours configuration settings for Dev Boxes created in this pool. |
| dev |
Indicates the number of provisioned Dev Boxes in this pool. |
| dev |
A definition of the machines that are created from this Pool. Will be ignored if devBoxDefinitionType is Reference or not provided. |
| dev |
Name of a Dev Box definition in parent Project of this Pool. Will be ignored if devBoxDefinitionType is Value. |
| dev |
Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly. |
| dev |
Indicates whether Dev Box Tunnel is enabled for a the pool. |
| display |
The display name of the pool. |
| health |
Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. |
| health |
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 |
| license |
Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created. |
| local |
Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box. |
| managed |
The regions of the managed virtual network (required when managedNetworkType is Managed). |
| network |
Name of a Network Connection in parent Project of this Pool. |
| provisioning |
The provisioning state of the resource. |
| single |
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. |
| stop |
Stop on disconnect configuration settings for Dev Boxes created in this pool. |
| stop |
Stop on no connect configuration settings for Dev Boxes created in this pool. |
| virtual |
Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network. |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location | The geo-location where the resource lives |
| name | The name of the resource |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| tags | Resource tags. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Property Details
activeHoursConfiguration
Active hours configuration settings for Dev Boxes created in this pool.
activeHoursConfiguration?: ActiveHoursConfiguration
Property Value
devBoxCount
Indicates the number of provisioned Dev Boxes in this pool.
devBoxCount?: number
Property Value
number
devBoxDefinition
A definition of the machines that are created from this Pool. Will be ignored if devBoxDefinitionType is Reference or not provided.
devBoxDefinition?: PoolDevBoxDefinition
Property Value
devBoxDefinitionName
Name of a Dev Box definition in parent Project of this Pool. Will be ignored if devBoxDefinitionType is Value.
devBoxDefinitionName?: string
Property Value
string
devBoxDefinitionType
Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.
devBoxDefinitionType?: string
Property Value
string
devBoxTunnelEnableStatus
Indicates whether Dev Box Tunnel is enabled for a the pool.
devBoxTunnelEnableStatus?: string
Property Value
string
displayName
The display name of the pool.
displayName?: string
Property Value
string
healthStatus
Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.
healthStatus?: string
Property Value
string
healthStatusDetails
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
healthStatusDetails?: HealthStatusDetail[]
Property Value
licenseType
Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.
licenseType?: string
Property Value
string
localAdministrator
Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.
localAdministrator?: string
Property Value
string
managedVirtualNetworkRegions
The regions of the managed virtual network (required when managedNetworkType is Managed).
managedVirtualNetworkRegions?: string[]
Property Value
string[]
networkConnectionName
Name of a Network Connection in parent Project of this Pool.
networkConnectionName?: string
Property Value
string
provisioningState
The provisioning state of the resource.
provisioningState?: string
Property Value
string
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.
singleSignOnStatus?: string
Property Value
string
stopOnDisconnect
Stop on disconnect configuration settings for Dev Boxes created in this pool.
stopOnDisconnect?: StopOnDisconnectConfiguration
Property Value
stopOnNoConnect
Stop on no connect configuration settings for Dev Boxes created in this pool.
stopOnNoConnect?: StopOnNoConnectConfiguration
Property Value
virtualNetworkType
Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.
virtualNetworkType?: string
Property Value
string
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: string
Property Value
string
Inherited From TrackedResource.id
location
The geo-location where the resource lives
location: string
Property Value
string
Inherited From TrackedResource.location
name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemData?: SystemData
Property Value
Inherited From TrackedResource.systemData
tags
Resource tags.
tags?: Record<string, string>
Property Value
Record<string, string>
Inherited From TrackedResource.tags
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
type?: string
Property Value
string
Inherited From TrackedResource.type