ClusterServerProperties interface

Package:

@azure/arm-cosmosdbforpostgresql

The properties of a server in cluster.

Extends

ServerProperties

Properties

availabilityZone	Availability Zone information of the server.
citusVersion	The Citus extension version of server.
fullyQualifiedDomainName	The fully qualified domain name of a server. NOTE: This property will not be serialized. It can only be populated by the server.
haState	A state of HA feature for the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
postgresqlVersion	The major PostgreSQL version of server.
role	The role of server in the cluster.
state	A state of a cluster/server that is visible to user. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

administratorLogin	The administrator's login name of the servers in the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
enableHa	If high availability (HA) is enabled or not for the server.
enablePublicIpAccess	If public access is enabled on server. NOTE: This property will not be serialized. It can only be populated by the server.
isReadOnly	If server database is set to read-only by system maintenance depending on high disk space usage. NOTE: This property will not be serialized. It can only be populated by the server.
serverEdition	The edition of a server.
storageQuotaInMb	The storage of a server in MB.
vCores	The vCores count of a server.

Property Details

availabilityZone

Availability Zone information of the server.

availabilityZone?: string

Property Value

string

citusVersion

The Citus extension version of server.

citusVersion?: string

Property Value

string

fullyQualifiedDomainName

The fully qualified domain name of a server. NOTE: This property will not be serialized. It can only be populated by the server.

fullyQualifiedDomainName?: string

Property Value

string

haState

A state of HA feature for the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

haState?: string

Property Value

string

postgresqlVersion

The major PostgreSQL version of server.

postgresqlVersion?: string

Property Value

string

role

The role of server in the cluster.

role?: string

Property Value

string

state

A state of a cluster/server that is visible to user. NOTE: This property will not be serialized. It can only be populated by the server.

state?: string

Property Value

string

Inherited Property Details

administratorLogin

The administrator's login name of the servers in the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

administratorLogin?: string

Property Value

string

Inherited From ServerProperties.administratorLogin

enableHa

If high availability (HA) is enabled or not for the server.

enableHa?: boolean

Property Value

boolean

Inherited From ServerProperties.enableHa

enablePublicIpAccess

If public access is enabled on server. NOTE: This property will not be serialized. It can only be populated by the server.

enablePublicIpAccess?: boolean

Property Value

boolean

Inherited From ServerProperties.enablePublicIpAccess

isReadOnly

If server database is set to read-only by system maintenance depending on high disk space usage. NOTE: This property will not be serialized. It can only be populated by the server.

isReadOnly?: boolean

Property Value

boolean

Inherited From ServerProperties.isReadOnly

serverEdition

The edition of a server.

serverEdition?: string

Property Value

string

Inherited From ServerProperties.serverEdition

storageQuotaInMb

The storage of a server in MB.

storageQuotaInMb?: number

Property Value

number

Inherited From ServerProperties.storageQuotaInMb

vCores

The vCores count of a server.

vCores?: number

Property Value

number

Inherited From ServerProperties.vCores