ClusterForUpdate interface

Package:

@azure/arm-cosmosdbforpostgresql

Represents a cluster for update.

Properties

administratorLoginPassword	The password of the administrator login. Each cluster is created with pre-defined administrative role called ‘citus’. This value contains a credential. Consider obscuring before showing to users
citusVersion	The Citus extension version on all cluster servers.
coordinatorEnablePublicIpAccess	If public access is enabled on coordinator.
coordinatorServerEdition	The edition of the coordinator (default: GeneralPurpose).
coordinatorStorageQuotaInMb	The storage of the coordinator in MB.
coordinatorVCores	The vCores count of the coordinator (max: 96).
enableHa	If high availability (HA) is enabled or not for the cluster.
enableShardsOnCoordinator	If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
maintenanceWindow	Maintenance window of a cluster.
nodeCount	Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1.
nodeEnablePublicIpAccess	If public access is enabled on worker nodes. NOTE: This property will not be serialized. It can only be populated by the server.
nodeServerEdition	The edition of a node (default: MemoryOptimized).
nodeStorageQuotaInMb	The storage in MB on each worker node.
nodeVCores	The compute in vCores on each worker node (max: 104).
postgresqlVersion	The major PostgreSQL version on all cluster servers.
preferredPrimaryZone	Preferred primary availability zone (AZ) for all cluster servers.
tags	Application-specific metadata in the form of key-value pairs.

Property Details

administratorLoginPassword

The password of the administrator login. Each cluster is created with pre-defined administrative role called ‘citus’. This value contains a credential. Consider obscuring before showing to users

administratorLoginPassword?: string

Property Value

string

citusVersion

The Citus extension version on all cluster servers.

citusVersion?: string

Property Value

string

coordinatorEnablePublicIpAccess

If public access is enabled on coordinator.

coordinatorEnablePublicIpAccess?: boolean

Property Value

boolean

coordinatorServerEdition

The edition of the coordinator (default: GeneralPurpose).

coordinatorServerEdition?: string

Property Value

string

coordinatorStorageQuotaInMb

The storage of the coordinator in MB.

coordinatorStorageQuotaInMb?: number

Property Value

number

coordinatorVCores

The vCores count of the coordinator (max: 96).

coordinatorVCores?: number

Property Value

number

enableHa

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

enableHa?: boolean

Property Value

boolean

enableShardsOnCoordinator

If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.

enableShardsOnCoordinator?: boolean

Property Value

boolean

maintenanceWindow

Maintenance window of a cluster.

maintenanceWindow?: MaintenanceWindow

Property Value

MaintenanceWindow

nodeCount

Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1.

nodeCount?: number

Property Value

number

nodeEnablePublicIpAccess

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

nodeEnablePublicIpAccess?: boolean

Property Value

boolean

nodeServerEdition

The edition of a node (default: MemoryOptimized).

nodeServerEdition?: string

Property Value

string

nodeStorageQuotaInMb

The storage in MB on each worker node.

nodeStorageQuotaInMb?: number

Property Value

number

nodeVCores

The compute in vCores on each worker node (max: 104).

nodeVCores?: number

Property Value

number

postgresqlVersion

The major PostgreSQL version on all cluster servers.

postgresqlVersion?: string

Property Value

string

preferredPrimaryZone

Preferred primary availability zone (AZ) for all cluster servers.

preferredPrimaryZone?: string

Property Value

string

tags

Application-specific metadata in the form of key-value pairs.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}