PoolUpdate interface
The pool properties for partial update. Properties not provided in the update request will not be changed.
Properties
| active |
Active hours configuration settings for Dev Boxes created 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. |
| 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. |
| location | The geo-location where the resource lives. |
| 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. |
| 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. |
| tags | Resource tags. |
| virtual |
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
location
The geo-location where the resource lives.
location?: 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
tags
Resource tags.
tags?: Record<string, string>
Property Value
Record<string, string>
virtualNetworkType
Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.
virtualNetworkType?: string
Property Value
string