Cluster Class

Represents a cluster.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Constructor

Cluster(*, location: str, tags: Dict[str, str] | None = None, administrator_login_password: str | None = None, postgresql_version: str | None = None, citus_version: str | None = None, maintenance_window: _models.MaintenanceWindow | None = None, preferred_primary_zone: str | None = None, enable_shards_on_coordinator: bool | None = None, enable_ha: bool | None = None, coordinator_server_edition: str | None = None, coordinator_storage_quota_in_mb: int | None = None, coordinator_v_cores: int | None = None, coordinator_enable_public_ip_access: bool | None = None, node_server_edition: str | None = None, node_count: int | None = None, node_storage_quota_in_mb: int | None = None, node_v_cores: int | None = None, node_enable_public_ip_access: bool | None = None, source_resource_id: str | None = None, source_location: str | None = None, point_in_time_utc: datetime | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
tags	dict[str, str] Resource tags. Default value: None
location	str The geo-location where the resource lives. Required.
administrator_login_password	str The password of the administrator login. Required for creation. Default value: None
postgresql_version	str The major PostgreSQL version on all cluster servers. Default value: None
citus_version	str The Citus extension version on all cluster servers. Default value: None
maintenance_window	MaintenanceWindow Maintenance window of a cluster. Default value: None
preferred_primary_zone	str Preferred primary availability zone (AZ) for all cluster servers. Default value: None
enable_shards_on_coordinator	bool 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. Default value: None
enable_ha	bool If high availability (HA) is enabled or not for the cluster. Default value: None
coordinator_server_edition	str The edition of a coordinator server (default: GeneralPurpose). Required for creation. Default value: None
coordinator_storage_quota_in_mb	int The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. Default value: None
coordinator_v_cores	int 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. Default value: None
coordinator_enable_public_ip_access	bool If public access is enabled on coordinator. Default value: None
node_server_edition	str The edition of a node server (default: MemoryOptimized). Default value: None
node_count	int 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. Default value: None
node_storage_quota_in_mb	int The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. Default value: None
node_v_cores	int The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. Default value: None
node_enable_public_ip_access	bool If public access is enabled on worker nodes. Default value: None
source_resource_id	str The resource id of source cluster for read replica clusters. Default value: None
source_location	str The Azure region of source cluster for read replica clusters. Default value: None
point_in_time_utc	datetime Date and time in UTC (ISO8601 format) for cluster restore. Default value: None

Variables

Name	Description
id	str Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	str The name of the resource.
type	str The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
system_data	SystemData Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	dict[str, str] Resource tags.
location	str The geo-location where the resource lives. Required.
administrator_login	str The administrator's login name of the servers in the cluster.
administrator_login_password	str The password of the administrator login. Required for creation.
provisioning_state	str Provisioning state of the cluster.
state	str A state of a cluster/server that is visible to user.
postgresql_version	str The major PostgreSQL version on all cluster servers.
citus_version	str The Citus extension version on all cluster servers.
maintenance_window	MaintenanceWindow Maintenance window of a cluster.
preferred_primary_zone	str Preferred primary availability zone (AZ) for all cluster servers.
enable_shards_on_coordinator	bool 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.
enable_ha	bool If high availability (HA) is enabled or not for the cluster.
coordinator_server_edition	str The edition of a coordinator server (default: GeneralPurpose). Required for creation.
coordinator_storage_quota_in_mb	int The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
coordinator_v_cores	int 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.
coordinator_enable_public_ip_access	bool If public access is enabled on coordinator.
node_server_edition	str The edition of a node server (default: MemoryOptimized).
node_count	int 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.
node_storage_quota_in_mb	int The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
node_v_cores	int The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
node_enable_public_ip_access	bool If public access is enabled on worker nodes.
server_names	list[ServerNameItem] The list of server names in the cluster.
source_resource_id	str The resource id of source cluster for read replica clusters.
source_location	str The Azure region of source cluster for read replica clusters.
point_in_time_utc	datetime Date and time in UTC (ISO8601 format) for cluster restore.
read_replicas	list[str] The array of read replica clusters.
earliest_restore_time	datetime The earliest restore point time (ISO8601 format) for the cluster.
private_endpoint_connections	list[SimplePrivateEndpointConnection] The private endpoint connections for a cluster.