Cluster interface

Пакет:

@azure/arm-cosmosdbforpostgresql

Представляет кластер.

Extends

TrackedResource

Свойства

administratorLogin	Имя входа администратора серверов в кластере. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
administratorLoginPassword	Пароль для входа администратора. Требуется для создания. Это значение содержит учетные данные. Прежде чем отображать пользователям, рекомендуется скрыть
citusVersion	Версия расширения Citus на всех серверах кластера.
coordinatorEnablePublicIpAccess	Если общедоступный доступ включен в координаторе.
coordinatorServerEdition	Выпуск сервера координатора (по умолчанию: GeneralPurpose). Требуется для создания.
coordinatorStorageQuotaInMb	Хранилище сервера в МБ. Требуется для создания. Дополнительные сведения см. в 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	Хранилище в МБ на каждом рабочем узле. Дополнительные сведения см. в 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	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
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

Хранилище сервера в МБ. Требуется для создания. Дополнительные сведения см. в 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

Хранилище в МБ на каждом рабочем узле. Дополнительные сведения см. в 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

Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

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