Share via

PoolProperties interface

  • Reference
Package:
@azure/arm-devcenter

Properties of a Pool

Extends
PoolUpdateProperties

Properties

devBoxCount

Indicates the number of provisioned Dev Boxes in this pool. NOTE: This property will not be serialized. It can only be populated by the server.
healthStatus

Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. NOTE: This property will not be serialized. It can only be populated by the server.
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 NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

devBoxDefinitionName

Name of a Dev Box definition in parent Project of this Pool
displayName

The display name of the pool.
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.
managedVirtualNetworkRegions

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

Name of a Network Connection in parent Project of this Pool
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.
virtualNetworkType

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

Property Details

devBoxCount

Indicates the number of provisioned Dev Boxes in this pool. NOTE: This property will not be serialized. It can only be populated by the server.

devBoxCount?: number

Property Value

number

healthStatus

Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. NOTE: This property will not be serialized. It can only be populated by the server.

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 NOTE: This property will not be serialized. It can only be populated by the server.

healthStatusDetails?: HealthStatusDetail[]

Property Value

HealthStatusDetail[]

provisioningState

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

Inherited Property Details

devBoxDefinitionName

Name of a Dev Box definition in parent Project of this Pool

devBoxDefinitionName?: string

Property Value

string

Inherited From PoolUpdateProperties.devBoxDefinitionName

displayName

The display name of the pool.

displayName?: string

Property Value

string

Inherited From PoolUpdateProperties.displayName

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

Inherited From PoolUpdateProperties.licenseType

localAdministrator

Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.

localAdministrator?: string

Property Value

string

Inherited From PoolUpdateProperties.localAdministrator

managedVirtualNetworkRegions

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

managedVirtualNetworkRegions?: string[]

Property Value

string[]

Inherited From PoolUpdateProperties.managedVirtualNetworkRegions

networkConnectionName

Name of a Network Connection in parent Project of this Pool

networkConnectionName?: string

Property Value

string

Inherited From PoolUpdateProperties.networkConnectionName

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

Inherited From PoolUpdateProperties.singleSignOnStatus

stopOnDisconnect

Stop on disconnect configuration settings for Dev Boxes created in this pool.

stopOnDisconnect?: StopOnDisconnectConfiguration

Property Value

StopOnDisconnectConfiguration

Inherited From PoolUpdateProperties.stopOnDisconnect

virtualNetworkType

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

virtualNetworkType?: string

Property Value

string

Inherited From PoolUpdateProperties.virtualNetworkType