Share via

Cluster interface

  • Reference
Package:
@azure/arm-cosmosdbforpostgresql

Represents a cluster.

Extends
TrackedResource

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.
administratorLoginPassword

The password of the administrator login. Required for creation. 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 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.
earliestRestoreTime

The earliest restore point time (ISO8601 format) for 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 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. 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.
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. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

Provisioning state of the cluster NOTE: This property will not be serialized. It can only be populated by the server.
readReplicas

The array of read replica clusters. NOTE: This property will not be serialized. It can only be populated by the server.
serverNames

The list of server names in the cluster NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the 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.
location

The geo-location where the resource lives
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.
tags

Resource tags.
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

administratorLoginPassword

The password of the administrator login. Required for creation. 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 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

earliestRestoreTime

The earliest restore point time (ISO8601 format) for the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

earliestRestoreTime?: Date

Property Value

Date

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. 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

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. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: SimplePrivateEndpointConnection[]

Property Value

SimplePrivateEndpointConnection[]

provisioningState

Provisioning state of the cluster NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

readReplicas

The array of read replica clusters. NOTE: This property will not be serialized. It can only be populated by the server.

readReplicas?: string[]

Property Value

string[]

serverNames

The list of server names in the cluster NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

state?: string

Property Value

string

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 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 NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.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 TrackedResource.systemData

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

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 TrackedResource.type