Freigeben über


PoolUpdate Class

Definition

The pool properties for partial update. Properties not provided in the update request will not be changed.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.PoolUpdateTypeConverter))]
public class PoolUpdate : Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.IPoolUpdate, Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.PoolUpdateTypeConverter))>]
type PoolUpdate = class
    interface IPoolUpdate
    interface IJsonSerializable
    interface ITrackedResourceUpdate
    interface IValidates
Public Class PoolUpdate
Implements IPoolUpdate, IValidates
Inheritance
PoolUpdate
Attributes
Implements

Constructors

Name Description
PoolUpdate()

Creates an new PoolUpdate instance.

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.

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.

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

ManagedVirtualNetworkRegion

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.

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.

Tag

Resource tags.

VirtualNetworkType

Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.

Methods

Name Description
DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of PoolUpdate.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of PoolUpdate.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.IPoolUpdate.

FromJsonString(String)

Creates a new instance of PoolUpdate, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of PoolUpdate into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to