Share via


ClusterServer Class

Represents a server in a cluster.

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

Constructor

ClusterServer(*, server_edition: str | None = None, storage_quota_in_mb: int | None = None, v_cores: int | None = None, enable_ha: bool | None = None, role: str | _models.ServerRole | None = None, availability_zone: str | None = None, postgresql_version: str | None = None, citus_version: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
server_edition
str

The edition of a server.

Default value: None
storage_quota_in_mb
int

The storage of a server in MB.

Default value: None
v_cores
int

The vCores count of a server.

Default value: None
enable_ha

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

Default value: None
role

The role of server in the cluster. Known values are: "Coordinator" and "Worker".

Default value: None
availability_zone
str

Availability Zone information of the server.

Default value: None
postgresql_version
str

The major PostgreSQL version of server.

Default value: None
citus_version
str

The Citus extension version of server.

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

Azure Resource Manager metadata containing createdBy and modifiedBy information.

server_edition
str

The edition of a server.

storage_quota_in_mb
int

The storage of a server in MB.

v_cores
int

The vCores count of a server.

enable_ha

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

enable_public_ip_access

If public access is enabled on server.

is_read_only

If server database is set to read-only by system maintenance depending on high disk space usage.

administrator_login
str

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

fully_qualified_domain_name
str

The fully qualified domain name of a server.

role

The role of server in the cluster. Known values are: "Coordinator" and "Worker".

state
str

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

ha_state
str

A state of HA feature for the cluster.

availability_zone
str

Availability Zone information of the server.

postgresql_version
str

The major PostgreSQL version of server.

citus_version
str

The Citus extension version of server.