Cluster interface

Package:

@azure/arm-postgresqlhsc

Represents a cluster.

Extends

TrackedResource

Properties

aadAuthEnabled	Indicates whether the cluster was created using AAD authentication.
administratorLogin	The administrator's login name of the servers in the cluster.
administratorLoginPassword	The password of the administrator login. Required for creation.
authConfig	Authentication configuration of a cluster.
citusVersion	The Citus extension version on all cluster servers.
coordinatorEnablePublicIpAccess	If public access is enabled on coordinator.
coordinatorServerEdition	The edition of a coordinator server (default: GeneralPurpose). Required for creation.
coordinatorStorageQuotaInMb	The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
coordinatorVCores	The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
databaseName	The database name of the cluster. Only one database per cluster is supported.
dataEncryption	The data encryption properties of a cluster.
earliestRestoreTime	The earliest restore point time (ISO8601 format) for the cluster.
enableGeoBackup	If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation.
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.
identity	Describes the identity of the cluster.
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. Required for creation.
nodeEnablePublicIpAccess	If public access is enabled on worker nodes.
nodeServerEdition	The edition of a node server (default: MemoryOptimized).
nodeStorageQuotaInMb	The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
nodeVCores	The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
passwordEnabled	Indicates whether the cluster was created with a password or using AAD authentication.
pointInTimeUTC	Date and time in UTC (ISO8601 format) for cluster restore.
postgresqlVersion	The major PostgreSQL version on all cluster servers.
preferredPrimaryZone	Preferred primary availability zone (AZ) for all cluster servers.
privateEndpointConnections	The private endpoint connections for a cluster.
provisioningState	Provisioning state of the cluster
readReplicas	The array of read replica clusters.
serverNames	The list of server names in the cluster
sourceLocation	The Azure region of source cluster for read replica clusters.
sourceResourceId	The resource id of source cluster for read replica clusters.
state	A state of a cluster/server that is visible to user.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	The geo-location where the resource lives
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

aadAuthEnabled

Indicates whether the cluster was created using AAD authentication.

aadAuthEnabled?: string

Property Value

string

administratorLogin

The administrator's login name of the servers in the cluster.

administratorLogin?: string

Property Value

string

administratorLoginPassword

The password of the administrator login. Required for creation.

administratorLoginPassword?: string

Property Value

string

authConfig

Authentication configuration of a cluster.

authConfig?: AuthConfig

Property Value

AuthConfig

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 a coordinator server (default: GeneralPurpose). Required for creation.

coordinatorServerEdition?: string

Property Value

string

coordinatorStorageQuotaInMb

The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.

coordinatorStorageQuotaInMb?: number

Property Value

number

coordinatorVCores

The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.

coordinatorVCores?: number

Property Value

number

databaseName

The database name of the cluster. Only one database per cluster is supported.

databaseName?: string

Property Value

string

dataEncryption

The data encryption properties of a cluster.

dataEncryption?: DataEncryption

Property Value

DataEncryption

earliestRestoreTime

The earliest restore point time (ISO8601 format) for the cluster.

earliestRestoreTime?: Date

Property Value

Date

enableGeoBackup

If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation.

enableGeoBackup?: boolean

Property Value

boolean

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

identity

Describes the identity of the cluster.

identity?: IdentityProperties

Property Value

IdentityProperties

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. Required for creation.

nodeCount?: number

Property Value

number

nodeEnablePublicIpAccess

If public access is enabled on worker nodes.

nodeEnablePublicIpAccess?: boolean

Property Value

boolean

nodeServerEdition

The edition of a node server (default: MemoryOptimized).

nodeServerEdition?: string

Property Value

string

nodeStorageQuotaInMb

The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.

nodeStorageQuotaInMb?: number

Property Value

number

nodeVCores

The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.

nodeVCores?: number

Property Value

number

passwordEnabled

Indicates whether the cluster was created with a password or using AAD authentication.

passwordEnabled?: string

Property Value

string

pointInTimeUTC

Date and time in UTC (ISO8601 format) for cluster restore.

pointInTimeUTC?: Date

Property Value

Date

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

privateEndpointConnections

The private endpoint connections for a cluster.

privateEndpointConnections?: SimplePrivateEndpointConnection[]

Property Value

SimplePrivateEndpointConnection[]

provisioningState

Provisioning state of the cluster

provisioningState?: string

Property Value

string

readReplicas

The array of read replica clusters.

readReplicas?: string[]

Property Value

string[]

serverNames

The list of server names in the cluster

serverNames?: ServerNameItem[]

Property Value

ServerNameItem[]

sourceLocation

The Azure region of source cluster for read replica clusters.

sourceLocation?: string

Property Value

string

sourceResourceId

The resource id of source cluster for read replica clusters.

sourceResourceId?: string

Property Value

string

state

A state of a cluster/server that is visible to user.

state?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type