你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Cluster interface

表示群集。

扩展

属性

administratorLogin

群集中服务器的管理员登录名。 注意:此属性不会序列化。 它只能由服务器填充。

administratorLoginPassword

管理员登录名的密码。 创建时需要。 此值包含凭据。 在向用户显示之前,请考虑模糊

citusVersion

所有群集服务器上的 Citus 扩展版本。

coordinatorEnablePublicIpAccess

如果在协调器上启用了公共访问。

coordinatorServerEdition

协调器服务器的版本(默认值:GeneralPurpose)。 创建时需要。

coordinatorStorageQuotaInMb

服务器的存储(以 MB 为单位)。 创建时需要。 有关详细信息,请参阅 https://free.blessedness.top/azure/cosmos-db/postgresql/resources-compute

coordinatorVCores

服务器的 vCore 计数(最大值:96)。 创建时需要。 有关详细信息,请参阅 https://free.blessedness.top/azure/cosmos-db/postgresql/resources-compute

earliestRestoreTime

群集的最早还原点时间(ISO8601格式)。 注意:此属性不会序列化。 它只能由服务器填充。

enableHa

如果为群集启用了或未启用高可用性(HA)。

enableShardsOnCoordinator

如果分布式表放置在协调器上,则为未放置。 应在单节点群集上设置为“true”。 更改值后需要分片重新均衡。

maintenanceWindow

群集的维护时段。

nodeCount

群集的工作器节点计数。 当节点计数为 0 时,它表示单个节点配置,能够在该节点上创建分布式表。 2 个或更多个工作器节点表示多节点配置。 节点计数值不能为 1。 创建时需要。

nodeEnablePublicIpAccess

如果在工作器节点上启用了公共访问。

nodeServerEdition

节点服务器的版本(默认值:MemoryOptimized)。

nodeStorageQuotaInMb

每个工作器节点上的存储(以 MB 为单位)。 有关详细信息,请参阅 https://free.blessedness.top/azure/cosmos-db/postgresql/resources-compute

nodeVCores

每个工作器节点上 vCore 中的计算(最大值:104)。 有关详细信息,请参阅 https://free.blessedness.top/azure/cosmos-db/postgresql/resources-compute

pointInTimeUTC

群集还原的日期和时间(ISO8601格式)。

postgresqlVersion

所有群集服务器上的主要 PostgreSQL 版本。

preferredPrimaryZone

所有群集服务器的首选主可用性区域 (AZ)。

privateEndpointConnections

群集的专用终结点连接。 注意:此属性不会序列化。 它只能由服务器填充。

provisioningState

群集的预配状态注意:此属性不会序列化。 它只能由服务器填充。

readReplicas

只读副本群集的数组。 注意:此属性不会序列化。 它只能由服务器填充。

serverNames

群集中的服务器名称列表注意:此属性不会序列化。 它只能由服务器填充。

sourceLocation

只读副本群集的源群集的 Azure 区域。

sourceResourceId

只读副本群集的源群集的资源 ID。

state

用户可见的群集/服务器的状态。 注意:此属性不会序列化。 它只能由服务器填充。

继承属性

id

资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”注意:此属性不会序列化。 它只能由服务器填充。

location

资源所在的地理位置

name

资源说明的名称:此属性不会序列化。 它只能由服务器填充。

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意:此属性不会序列化。 它只能由服务器填充。

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://free.blessedness.top/azure/cosmos-db/postgresql/resources-compute

coordinatorStorageQuotaInMb?: number

属性值

number

coordinatorVCores

服务器的 vCore 计数(最大值:96)。 创建时需要。 有关详细信息,请参阅 https://free.blessedness.top/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

属性值

nodeCount

群集的工作器节点计数。 当节点计数为 0 时,它表示单个节点配置,能够在该节点上创建分布式表。 2 个或更多个工作器节点表示多节点配置。 节点计数值不能为 1。 创建时需要。

nodeCount?: number

属性值

number

nodeEnablePublicIpAccess

如果在工作器节点上启用了公共访问。

nodeEnablePublicIpAccess?: boolean

属性值

boolean

nodeServerEdition

节点服务器的版本(默认值:MemoryOptimized)。

nodeServerEdition?: string

属性值

string

nodeStorageQuotaInMb

每个工作器节点上的存储(以 MB 为单位)。 有关详细信息,请参阅 https://free.blessedness.top/azure/cosmos-db/postgresql/resources-compute

nodeStorageQuotaInMb?: number

属性值

number

nodeVCores

每个工作器节点上 vCore 中的计算(最大值:104)。 有关详细信息,请参阅 https://free.blessedness.top/azure/cosmos-db/postgresql/resources-compute

nodeVCores?: number

属性值

number

pointInTimeUTC

群集还原的日期和时间(ISO8601格式)。

pointInTimeUTC?: Date

属性值

Date

postgresqlVersion

所有群集服务器上的主要 PostgreSQL 版本。

postgresqlVersion?: string

属性值

string

preferredPrimaryZone

所有群集服务器的首选主可用性区域 (AZ)。

preferredPrimaryZone?: string

属性值

string

privateEndpointConnections

群集的专用终结点连接。 注意:此属性不会序列化。 它只能由服务器填充。

privateEndpointConnections?: SimplePrivateEndpointConnection[]

属性值

provisioningState

群集的预配状态注意:此属性不会序列化。 它只能由服务器填充。

provisioningState?: string

属性值

string

readReplicas

只读副本群集的数组。 注意:此属性不会序列化。 它只能由服务器填充。

readReplicas?: string[]

属性值

string[]

serverNames

群集中的服务器名称列表注意:此属性不会序列化。 它只能由服务器填充。

serverNames?: ServerNameItem[]

属性值

sourceLocation

只读副本群集的源群集的 Azure 区域。

sourceLocation?: string

属性值

string

sourceResourceId

只读副本群集的源群集的资源 ID。

sourceResourceId?: string

属性值

string

state

用户可见的群集/服务器的状态。 注意:此属性不会序列化。 它只能由服务器填充。

state?: string

属性值

string

继承属性详细信息

id

资源的完全限定资源 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 资源管理器元数据。 注意:此属性不会序列化。 它只能由服务器填充。

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