Pool interface

Package:

@azure/arm-devcenter

A pool of Virtual Machines.

Extends

TrackedResource

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

Inherited Properties

id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location	The geo-location where the resource lives
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

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

devBoxDefinitionName

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

devBoxDefinitionName?: 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. 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[]

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

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

StopOnDisconnectConfiguration

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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

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

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

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type