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	読み取りレプリカ クラスターのソース クラスターのリソース ID。
state	ユーザーに表示されるクラスター/サーバーの状態。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

継承されたプロパティ

id	リソースの完全修飾リソース 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

読み取りレプリカ クラスターのソース クラスターのリソース 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 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から継承