PoolUpdateProperties interface

Properties of a Pool. These properties can be updated after the resource has been created.

Properties

activeHoursConfiguration

Active hours configuration settings for Dev Boxes created in this pool.

devBoxDefinition

A definition of the machines that are created from this Pool. Will be ignored if devBoxDefinitionType is Reference or not provided.

devBoxDefinitionName

Name of a Dev Box definition in parent Project of this Pool. Will be ignored if devBoxDefinitionType is Value.

devBoxDefinitionType

Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.

devBoxTunnelEnableStatus

Indicates whether Dev Box Tunnel is enabled for a the 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.

stopOnNoConnect

Stop on no connect 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

activeHoursConfiguration

Active hours configuration settings for Dev Boxes created in this pool.

activeHoursConfiguration?: ActiveHoursConfiguration

Property Value

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

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

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