IPoolProperties Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.PoolPropertiesTypeConverter))]
public interface IPoolProperties : Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.IPoolUpdateProperties[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.PoolPropertiesTypeConverter))>]
type IPoolProperties = interface
interface IJsonSerializable
interface IPoolUpdatePropertiesPublic Interface IPoolProperties
Implements IPoolUpdateProperties- Derived
- Attributes
- Implements
Properties
| Name | Description |
|---|---|
| ActiveHourConfigurationAutoStartEnableStatus |
Enables or disables whether the Dev Box should be automatically started at commencement of active hours. (Inherited from IPoolUpdateProperties) |
| ActiveHourConfigurationDefaultEndTimeHour |
The default end time of the active hours (Inherited from IPoolUpdateProperties) |
| ActiveHourConfigurationDefaultStartTimeHour |
The default start time of the active hours. (Inherited from IPoolUpdateProperties) |
| ActiveHourConfigurationDefaultTimeZone |
The default IANA timezone id of the active hours. (Inherited from IPoolUpdateProperties) |
| ActiveHourConfigurationKeepAwakeEnableStatus |
Enables or disables whether the Dev Box should be kept awake during active hours. (Inherited from IPoolUpdateProperties) |
| ActiveImageReferenceExactVersion |
The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. (Inherited from IPoolUpdateProperties) |
| ActiveImageReferenceId |
Image ID, or Image version ID. When Image ID is provided, its latest version will be used. (Inherited from IPoolUpdateProperties) |
| DevBoxCount |
Indicates the number of provisioned Dev Boxes in this pool. |
| DevBoxDefinitionName |
Name of a Dev Box definition in parent Project of this Pool. Will be ignored if devBoxDefinitionType is Value. (Inherited from IPoolUpdateProperties) |
| DevBoxDefinitionType |
Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly. (Inherited from IPoolUpdateProperties) |
| DevBoxTunnelEnableStatus |
Indicates whether Dev Box Tunnel is enabled for a the pool. (Inherited from IPoolUpdateProperties) |
| DisplayName |
The display name of the pool. (Inherited from IPoolUpdateProperties) |
| HealthStatus |
Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. |
| HealthStatusDetail |
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 |
| ImageReferenceExactVersion |
The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. (Inherited from IPoolUpdateProperties) |
| ImageReferenceId |
Image ID, or Image version ID. When Image ID is provided, its latest version will be used. (Inherited from IPoolUpdateProperties) |
| LicenseType |
Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created. (Inherited from IPoolUpdateProperties) |
| LocalAdministrator |
Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box. (Inherited from IPoolUpdateProperties) |
| ManagedVirtualNetworkRegion |
The regions of the managed virtual network (required when managedNetworkType is Managed). (Inherited from IPoolUpdateProperties) |
| NetworkConnectionName |
Name of a Network Connection in parent Project of this Pool (Inherited from IPoolUpdateProperties) |
| ProvisioningState |
The provisioning state of the resource. |
| 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. (Inherited from IPoolUpdateProperties) |
| SkuCapacity |
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. (Inherited from IPoolUpdateProperties) |
| SkuFamily |
If the service has different generations of hardware, for the same SKU, then that can be captured here. (Inherited from IPoolUpdateProperties) |
| SkuName |
The name of the SKU. E.g. P3. It is typically a letter+number code (Inherited from IPoolUpdateProperties) |
| SkuSize |
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. (Inherited from IPoolUpdateProperties) |
| SkuTier |
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. (Inherited from IPoolUpdateProperties) |
| StopOnDisconnectGracePeriodMinute |
The specified time in minutes to wait before stopping a Dev Box once disconnect is detected. (Inherited from IPoolUpdateProperties) |
| StopOnDisconnectStatus |
Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled. (Inherited from IPoolUpdateProperties) |
| StopOnNoConnectGracePeriodMinute |
The specified time in minutes to wait before stopping a Dev Box if no connection is made. (Inherited from IPoolUpdateProperties) |
| StopOnNoConnectStatus |
Enables the feature to stop a started Dev Box when it has not been connected to, once the grace period has lapsed. (Inherited from IPoolUpdateProperties) |
| VirtualNetworkType |
Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network. (Inherited from IPoolUpdateProperties) |
Methods
| Name | Description |
|---|---|
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |