ClusterServer interface

Package:

@azure/arm-cosmosdbforpostgresql

Represents a server in a cluster.

Extends

ProxyResource

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.
availabilityZone	Availability Zone information of the server.
citusVersion	The Citus extension version of 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.
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.
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.
postgresqlVersion	The major PostgreSQL version of server.
role	The role of server in the cluster.
serverEdition	The edition of a server.
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.
storageQuotaInMb	The storage of a server in MB.
vCores	The vCores count of a server.

Inherited Properties

id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

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

availabilityZone

Availability Zone information of the server.

availabilityZone?: string

Property Value

string

citusVersion

The Citus extension version of server.

citusVersion?: string

Property Value

string

enableHa

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

enableHa?: boolean

Property Value

boolean

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

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

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

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

serverEdition

The edition of a server.

serverEdition?: 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

storageQuotaInMb

The storage of a server in MB.

storageQuotaInMb?: number

Property Value

number

vCores

The vCores count of a server.

vCores?: number

Property Value

number

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type