Share via


CosmosDBForPostgreSqlClusterData Class

Definition

A class representing the CosmosDBForPostgreSqlCluster data model. Represents a cluster.

public class CosmosDBForPostgreSqlClusterData : Azure.ResourceManager.Models.TrackedResourceData
type CosmosDBForPostgreSqlClusterData = class
    inherit TrackedResourceData
Public Class CosmosDBForPostgreSqlClusterData
Inherits TrackedResourceData
Inheritance
CosmosDBForPostgreSqlClusterData

Constructors

CosmosDBForPostgreSqlClusterData(AzureLocation)

Initializes a new instance of CosmosDBForPostgreSqlClusterData.

Properties

AdministratorLogin

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

AdministratorLoginPassword

The password of the administrator login. Required for creation.

CitusVersion

The Citus extension version on all cluster servers.

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.

EarliestRestoreOn

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

Id

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

(Inherited from ResourceData)
IsCoordinatorPublicIPAccessEnabled

If public access is enabled on coordinator.

IsHAEnabled

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

IsNodePublicIPAccessEnabled

If public access is enabled on worker nodes.

IsShardsOnCoordinatorEnabled

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.

Location

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
MaintenanceWindow

Maintenance window of a cluster.

Name

The name of the resource.

(Inherited from ResourceData)
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.

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.

ProvisioningState

Provisioning state of the cluster.

ReadReplicas

The array of read replica clusters.

ResourceType

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

(Inherited from ResourceData)
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.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Tags

Resource tags.

(Inherited from TrackedResourceData)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TrackedResourceData)

Applies to