IPool 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.PoolTypeConverter))]
public interface IPool : Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api50.ITrackedResource[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.PoolTypeConverter))>]
type IPool = interface
interface IJsonSerializable
interface ITrackedResource
interface IResourcePublic Interface IPool
Implements ITrackedResource- Derived
- Attributes
- Implements
Properties
| Name | Description |
|---|---|
| ActiveHourConfigurationAutoStartEnableStatus |
Enables or disables whether the Dev Box should be automatically started at commencement of active hours. |
| ActiveHourConfigurationDefaultEndTimeHour |
The default end time of the active hours |
| ActiveHourConfigurationDefaultStartTimeHour |
The default start time of the active hours. |
| ActiveHourConfigurationDefaultTimeZone |
The default IANA timezone id of the active hours. |
| ActiveHourConfigurationKeepAwakeEnableStatus |
Enables or disables whether the Dev Box should be kept awake during active hours. |
| 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. |
| ActiveImageReferenceId |
Image ID, or Image version ID. When Image ID is provided, its latest version will be used. |
| 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. |
| 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. |
| 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 |
| Id |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" (Inherited from IResource) |
| 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. |
| ImageReferenceId |
Image ID, or Image version ID. When Image ID is provided, its latest version will be used. |
| 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. |
| Location |
The geo-location where the resource lives (Inherited from ITrackedResource) |
| ManagedVirtualNetworkRegion |
The regions of the managed virtual network (required when managedNetworkType is Managed). |
| Name |
The name of the resource (Inherited from IResource) |
| NetworkConnectionName |
Name of a Network Connection in parent Project of this Pool |
| 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. |
| 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. |
| SkuFamily |
If the service has different generations of hardware, for the same SKU, then that can be captured here. |
| SkuName |
The name of the SKU. E.g. P3. It is typically a letter+number code |
| SkuSize |
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. |
| 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. |
| StopOnDisconnectGracePeriodMinute |
The specified time in minutes to wait before stopping a Dev Box once disconnect is detected. |
| StopOnDisconnectStatus |
Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled. |
| StopOnNoConnectGracePeriodMinute |
The specified time in minutes to wait before stopping a Dev Box if no connection is made. |
| StopOnNoConnectStatus |
Enables the feature to stop a started Dev Box when it has not been connected to, once the grace period has lapsed. |
| SystemDataCreatedAt |
The timestamp of resource creation (UTC). (Inherited from IResource) |
| SystemDataCreatedBy |
The identity that created the resource. (Inherited from IResource) |
| SystemDataCreatedByType |
The type of identity that created the resource. (Inherited from IResource) |
| SystemDataLastModifiedAt |
The timestamp of resource last modification (UTC) (Inherited from IResource) |
| SystemDataLastModifiedBy |
The identity that last modified the resource. (Inherited from IResource) |
| SystemDataLastModifiedByType |
The type of identity that last modified the resource. (Inherited from IResource) |
| Tag |
Resource tags. (Inherited from ITrackedResource) |
| Type |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" (Inherited from IResource) |
| VirtualNetworkType |
Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network. |
Methods
| Name | Description |
|---|---|
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |