PoolProperties interface

Package:

@azure/arm-horizondb

Properties of a HorizonDB pool.

Properties

computeModel	The required compute model for the HorizonDB pool.
highAvailability	The required high-availability configuration for the pool. mode must be Disabled when nodeCount is 1, and must be AnyZone or ZoneRedundant when nodeCount is 2 through 16.
nodeCount	The required number of nodes to allocate and assign to the pool. Allowed values are 1 through 16. To deallocate runtime compute without changing the configured node count, stop the pool.
parameterGroup	The required parameter group associated with the pool. When creating a new pool in this API version, the caller must supply the corresponding default parameter group; customer-created parameter groups are not accepted during creation. For an existing pool, PUT or PATCH can associate either the corresponding default parameter group or a customer-created parameter group. The create-visible shape intentionally supports both resource ID forms so a future API version can allow customer-created parameter groups during creation without a breaking schema change.
provisioningState	The provisioning state of the pool.
scheduledMaintenance	The scheduled maintenance configuration for the pool. The properties available depend on the selected maintenance management type.
state	Current state of the pool.

Property Details

computeModel

The required compute model for the HorizonDB pool.

computeModel: PoolComputeModel

Property Value

PoolComputeModel

highAvailability

The required high-availability configuration for the pool. mode must be Disabled when nodeCount is 1, and must be AnyZone or ZoneRedundant when nodeCount is 2 through 16.

highAvailability: PoolHighAvailability

Property Value

PoolHighAvailability

nodeCount

The required number of nodes to allocate and assign to the pool. Allowed values are 1 through 16. To deallocate runtime compute without changing the configured node count, stop the pool.

nodeCount: number

Property Value

number

parameterGroup

The required parameter group associated with the pool. When creating a new pool in this API version, the caller must supply the corresponding default parameter group; customer-created parameter groups are not accepted during creation. For an existing pool, PUT or PATCH can associate either the corresponding default parameter group or a customer-created parameter group. The create-visible shape intentionally supports both resource ID forms so a future API version can allow customer-created parameter groups during creation without a breaking schema change.

parameterGroup: PoolParameterGroupReference

Property Value

PoolParameterGroupReference

provisioningState

The provisioning state of the pool.

provisioningState?: string

Property Value

string

scheduledMaintenance

The scheduled maintenance configuration for the pool. The properties available depend on the selected maintenance management type.

scheduledMaintenance?: ScheduledMaintenancePropertiesUnion

Property Value

ScheduledMaintenancePropertiesUnion

state

Current state of the pool.

state?: string

Property Value

string