Cluster interface

套件:

@azure/arm-cosmosdbforpostgresql

表示叢集。

Extends

TrackedResource

屬性

administratorLogin	系統管理員在叢集中伺服器的登入名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。
administratorLoginPassword	系統管理員登入的密碼。 建立的必要專案。 此值包含認證。 在向用戶顯示之前，請考慮遮蔽
citusVersion	所有叢集伺服器上的 Citus 擴充功能版本。
coordinatorEnablePublicIpAccess	如果在協調器上啟用公用存取。
coordinatorServerEdition	協調器伺服器的版本（預設值：GeneralPurpose）。 建立的必要專案。
coordinatorStorageQuotaInMb	以 MB 為單位的伺服器記憶體。 建立的必要專案。 如需詳細資訊，請參閱 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute。
coordinatorVCores	伺服器的虛擬核心計數（最大值：96）。 建立的必要專案。 如需詳細資訊，請參閱 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute。
earliestRestoreTime	叢集最早的還原時間點時間（ISO8601格式）。 注意：這個屬性不會串行化。 它只能由伺服器填入。
enableHa	如果已啟用或未啟用叢集的高可用性 （HA）。
enableShardsOnCoordinator	如果分散式資料表放在協調器上，則為 。 應該在單一節點叢集上設定為 『true』。 變更值之後，需要分區重新平衡。
maintenanceWindow	叢集的維護時間範圍。
nodeCount	叢集的背景工作節點計數。 當節點計數為 0 時，它代表單一節點組態，能夠在該節點上建立分散式數據表。 2 個以上的背景工作節點代表多節點組態。 節點計數值不能是 1。 建立的必要專案。
nodeEnablePublicIpAccess	如果在背景工作節點上啟用公用存取。
nodeServerEdition	節點伺服器的版本（預設值：MemoryOptimized）。
nodeStorageQuotaInMb	每個背景工作節點上以 MB 為單位的記憶體。 如需詳細資訊，請參閱 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute。
nodeVCores	每個背景工作節點上虛擬核心中的計算（最大值：104）。 如需詳細資訊，請參閱 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute。
pointInTimeUTC	叢集還原的UTC日期和時間（ISO8601格式）。
postgresqlVersion	所有叢集伺服器上的主要 PostgreSQL 版本。
preferredPrimaryZone	所有叢集伺服器的慣用主要可用性區域 （AZ）。
privateEndpointConnections	叢集的私人端點連線。 注意：這個屬性不會串行化。 它只能由伺服器填入。
provisioningState	叢集布建狀態注意：此屬性將不會串行化。 它只能由伺服器填入。
readReplicas	讀取複本叢集的陣列。 注意：這個屬性不會串行化。 它只能由伺服器填入。
serverNames	叢集中的伺服器名稱清單注意：此屬性將不會串行化。 它只能由伺服器填入。
sourceLocation	讀取複本叢集的來源叢集 Azure 區域。
sourceResourceId	讀取複本叢集的來源叢集資源標識碼。
state	使用者可以看到的叢集/伺服器狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。

繼承的屬性

id	資源的完整資源標識碼。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” 附注：此屬性將不會串行化。 它只能由伺服器填入。
location	資源所在的地理位置
name	資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。
systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。
tags	資源標籤。
type	資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” 附注：此屬性將不會串行化。 它只能由伺服器填入。

屬性詳細資料

administratorLogin

系統管理員在叢集中伺服器的登入名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。

administratorLogin?: string

屬性值

string

administratorLoginPassword

系統管理員登入的密碼。 建立的必要專案。 此值包含認證。 在向用戶顯示之前，請考慮遮蔽

administratorLoginPassword?: string

屬性值

string

citusVersion

所有叢集伺服器上的 Citus 擴充功能版本。

citusVersion?: string

屬性值

string

coordinatorEnablePublicIpAccess

如果在協調器上啟用公用存取。

coordinatorEnablePublicIpAccess?: boolean

屬性值

boolean

coordinatorServerEdition

協調器伺服器的版本（預設值：GeneralPurpose）。 建立的必要專案。

coordinatorServerEdition?: string

屬性值

string

coordinatorStorageQuotaInMb

以 MB 為單位的伺服器記憶體。 建立的必要專案。 如需詳細資訊，請參閱 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute。

coordinatorStorageQuotaInMb?: number

屬性值

number

coordinatorVCores

伺服器的虛擬核心計數（最大值：96）。 建立的必要專案。 如需詳細資訊，請參閱 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute。

coordinatorVCores?: number

屬性值

number

earliestRestoreTime

叢集最早的還原時間點時間（ISO8601格式）。 注意：這個屬性不會串行化。 它只能由伺服器填入。

earliestRestoreTime?: Date

屬性值

Date

enableHa

如果已啟用或未啟用叢集的高可用性 （HA）。

enableHa?: boolean

屬性值

boolean

enableShardsOnCoordinator

如果分散式資料表放在協調器上，則為 。 應該在單一節點叢集上設定為 『true』。 變更值之後，需要分區重新平衡。

enableShardsOnCoordinator?: boolean

屬性值

boolean

maintenanceWindow

叢集的維護時間範圍。

maintenanceWindow?: MaintenanceWindow

屬性值

MaintenanceWindow

nodeCount

叢集的背景工作節點計數。 當節點計數為 0 時，它代表單一節點組態，能夠在該節點上建立分散式數據表。 2 個以上的背景工作節點代表多節點組態。 節點計數值不能是 1。 建立的必要專案。

nodeCount?: number

屬性值

number

nodeEnablePublicIpAccess

如果在背景工作節點上啟用公用存取。

nodeEnablePublicIpAccess?: boolean

屬性值

boolean

nodeServerEdition

節點伺服器的版本（預設值：MemoryOptimized）。

nodeServerEdition?: string

屬性值

string

nodeStorageQuotaInMb

每個背景工作節點上以 MB 為單位的記憶體。 如需詳細資訊，請參閱 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute。

nodeStorageQuotaInMb?: number

屬性值

number

nodeVCores

每個背景工作節點上虛擬核心中的計算（最大值：104）。 如需詳細資訊，請參閱 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute。

nodeVCores?: number

屬性值

number

pointInTimeUTC

叢集還原的UTC日期和時間（ISO8601格式）。

pointInTimeUTC?: Date

屬性值

Date

postgresqlVersion

所有叢集伺服器上的主要 PostgreSQL 版本。

postgresqlVersion?: string

屬性值

string

preferredPrimaryZone

所有叢集伺服器的慣用主要可用性區域 （AZ）。

preferredPrimaryZone?: string

屬性值

string

privateEndpointConnections

叢集的私人端點連線。 注意：這個屬性不會串行化。 它只能由伺服器填入。

privateEndpointConnections?: SimplePrivateEndpointConnection[]

屬性值

SimplePrivateEndpointConnection[]

provisioningState

叢集布建狀態注意：此屬性將不會串行化。 它只能由伺服器填入。

provisioningState?: string

屬性值

string

readReplicas

讀取複本叢集的陣列。 注意：這個屬性不會串行化。 它只能由伺服器填入。

readReplicas?: string[]

屬性值

string[]

serverNames

叢集中的伺服器名稱清單注意：此屬性將不會串行化。 它只能由伺服器填入。

serverNames?: ServerNameItem[]

屬性值

ServerNameItem[]

sourceLocation

讀取複本叢集的來源叢集 Azure 區域。

sourceLocation?: string

屬性值

string

sourceResourceId

讀取複本叢集的來源叢集資源標識碼。

sourceResourceId?: string

屬性值

string

state

使用者可以看到的叢集/伺服器狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。

state?: string

屬性值

string

繼承的屬性詳細資料

id

資源的完整資源標識碼。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” 附注：此屬性將不會串行化。 它只能由伺服器填入。

id?: string

屬性值

string

繼承自TrackedResource.id

location

資源所在的地理位置

location: string

屬性值

string

繼承自TrackedResource.location

name

資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。

name?: string

屬性值

string

繼承自TrackedResource.name 的

systemData

包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。

systemData?: SystemData

屬性值

SystemData

繼承自TrackedResource.systemData

tags

資源標籤。

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

屬性值

{[propertyName: string]: string}

繼承自TrackedResource.tags

type

資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” 附注：此屬性將不會串行化。 它只能由伺服器填入。

type?: string

屬性值

string

繼承自TrackedResource.type