HorizonDbClusterProperties interface

Package:

@azure/arm-horizondb

Properties of a HorizonDb cluster.

Properties

administratorLogin	The administrator login name.
administratorLoginPassword	The administrator login password.
createMode	The mode to create a new HorizonDb cluster.
fullyQualifiedDomainName	The fully qualified domain name of the cluster.
network	The network related info.
parameterGroup	Defines connection to a parameter group.
pointInTimeUTC	Restore point creation time specifying the time to restore from.
poolName	The pool name for restore or replica operations.
processorType	The processor type for the HorizonDb cluster.
provisioningState	The provisioning state of the cluster.
readonlyEndpoint	The fully qualified domain name used for readonly endpoint for the cluster.
replicaCount	Number of replicas.
sourceClusterResourceId	The source cluster resource ID for restore or replica creation.
state	Current state of the cluster.
vCores	Number of vCores.
version	The version of the HorizonDb cluster.
zonePlacementPolicy	Defines how replicas are placed across availability zones.

Property Details

administratorLogin

The administrator login name.

administratorLogin: string

Property Value

string

administratorLoginPassword

The administrator login password.

administratorLoginPassword?: string

Property Value

string

createMode

The mode to create a new HorizonDb cluster.

createMode?: string

Property Value

string

fullyQualifiedDomainName

The fully qualified domain name of the cluster.

fullyQualifiedDomainName?: string

Property Value

string

network

The network related info.

network?: Network

Property Value

Network

parameterGroup

Defines connection to a parameter group.

parameterGroup?: HorizonDbClusterParameterGroupConnectionProperties

Property Value

HorizonDbClusterParameterGroupConnectionProperties

pointInTimeUTC

Restore point creation time specifying the time to restore from.

pointInTimeUTC?: Date

Property Value

Date

poolName

The pool name for restore or replica operations.

poolName?: string

Property Value

string

processorType

The processor type for the HorizonDb cluster.

processorType?: string

Property Value

string

provisioningState

The provisioning state of the cluster.

provisioningState?: string

Property Value

string

readonlyEndpoint

The fully qualified domain name used for readonly endpoint for the cluster.

readonlyEndpoint?: string

Property Value

string

replicaCount

Number of replicas.

replicaCount?: number

Property Value

number

sourceClusterResourceId

The source cluster resource ID for restore or replica creation.

sourceClusterResourceId?: string

Property Value

string

state

Current state of the cluster.

state?: string

Property Value

string

vCores

Number of vCores.

vCores?: number

Property Value

number

version

The version of the HorizonDb cluster.

version?: string

Property Value

string

zonePlacementPolicy

Defines how replicas are placed across availability zones.

zonePlacementPolicy?: string

Property Value

string