Clusters - Update
既存のクラスターを更新します。 要求本文には、クラスター定義の 1 つまたは複数のプロパティを含めることができます。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}?api-version=2023-03-02-preview
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
cluster
|
path | True |
string minLength: 3maxLength: 40 pattern: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(? |
クラスターの名前。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
リソース グループの名前。 名前では大文字と小文字が区別されません。 |
|
subscription
|
path | True |
string (uuid) |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| identity |
クラスターの ID について説明します。 |
|
| properties.administratorLoginPassword |
string (password) |
管理者ログインのパスワード。 各クラスターは、"citus" と呼ばれる定義済みの管理ロールを使用して作成されます。 |
| properties.citusVersion |
string |
すべてのクラスター サーバー上の Citus 拡張機能バージョン。 |
| properties.coordinatorEnablePublicIpAccess |
boolean |
コーディネーターでパブリック アクセスが有効になっている場合。 |
| properties.coordinatorServerEdition |
string |
コーディネーターのエディション (既定値: GeneralPurpose)。 |
| properties.coordinatorStorageQuotaInMb |
integer (int32) |
コーディネーターのストレージ (MB 単位)。 |
| properties.coordinatorVCores |
integer (int32) |
コーディネーターの仮想コア数 (最大: 96)。 |
| properties.enableHa |
boolean |
高可用性 (HA) がクラスターに対して有効になっているかどうか。 |
| properties.enableShardsOnCoordinator |
boolean |
分散テーブルがコーディネーターに配置されているかどうか。 単一ノード クラスターで 'true' に設定する必要があります。 値が変更された後にシャードの再調整が必要です。 |
| properties.maintenanceWindow |
クラスターのメンテナンス期間。 |
|
| properties.nodeCount |
integer (int32) |
クラスターのワーカー ノード数。 ノード数が 0 の場合、ノードに分散テーブルを作成する機能を持つ単一のノード構成を表します。 2 つ以上のワーカー ノードがマルチノード構成を表します。 ノード数の値を 1 にすることはできません。 |
| properties.nodeServerEdition |
string |
ノードのエディション (既定値: MemoryOptimized)。 |
| properties.nodeStorageQuotaInMb |
integer (int32) |
各ワーカー ノードのストレージ (MB 単位)。 |
| properties.nodeVCores |
integer (int32) |
各ワーカー ノードの仮想コア単位のコンピューティング (最大: 104)。 |
| properties.postgresqlVersion |
string |
すべてのクラスター サーバー上の PostgreSQL のメジャー バージョン。 |
| properties.preferredPrimaryZone |
string |
すべてのクラスター サーバーの優先プライマリ可用性ゾーン (AZ)。 |
| tags |
object |
キーと値のペアの形式のアプリケーション固有のメタデータ。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
Azure 操作は正常に完了しました。 |
|
| 202 Accepted |
要求は処理のために受け入れ済みですが、処理はまだ完了していません。 ヘッダー
|
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
例
| Scale compute up or down |
| Scale out: Add new worker nodes |
| Scale up storage |
| Update multiple configuration settings of the cluster |
| Update or define maintenance window |
Scale compute up or down
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster?api-version=2023-03-02-preview
{
"properties": {
"nodeVCores": 16
}
}
応答のサンプル
{
"name": "testcluster",
"type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
"location": "westus",
"properties": {
"aadAuthEnabled": "disabled",
"administratorLogin": "citus",
"citusVersion": "11.1",
"coordinatorEnablePublicIpAccess": true,
"coordinatorServerEdition": "GeneralPurpose",
"coordinatorStorageQuotaInMb": 2097152,
"coordinatorVCores": 16,
"dataEncryption": {
"type": "SystemManaged"
},
"databaseName": "citus",
"earliestRestoreTime": "2020-09-14T00:00:37.467Z",
"enableHa": false,
"enableShardsOnCoordinator": false,
"maintenanceWindow": {
"customWindow": "Disabled",
"dayOfWeek": 0,
"startHour": 0,
"startMinute": 0
},
"nodeCount": 3,
"nodeEnablePublicIpAccess": false,
"nodeServerEdition": "MemoryOptimized",
"nodeStorageQuotaInMb": 2097152,
"nodeVCores": 16,
"passwordEnabled": "enabled",
"postgresqlVersion": "14",
"preferredPrimaryZone": "1",
"privateEndpointConnections": [],
"provisioningState": "Succeeded",
"readReplicas": [],
"serverNames": [
{
"name": "testcluster1-c",
"fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
},
{
"name": "testcluster1-w0",
"fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
},
{
"name": "testcluster1-w1",
"fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
},
{
"name": "testcluster1-w2",
"fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
}
],
"sourceResourceId": null,
"state": "Ready"
},
"systemData": {
"createdAt": "2020-01-01T17:18:19.1234567Z",
"createdBy": "user1",
"createdByType": "User",
"lastModifiedAt": "2020-01-02T17:18:19.1234567Z",
"lastModifiedBy": "user2",
"lastModifiedByType": "User"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
{
"name": "testcluster",
"type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
"location": "westus",
"properties": {
"aadAuthEnabled": "disabled",
"administratorLogin": "citus",
"citusVersion": "11.1",
"coordinatorEnablePublicIpAccess": true,
"coordinatorServerEdition": "GeneralPurpose",
"coordinatorStorageQuotaInMb": 2097152,
"coordinatorVCores": 16,
"dataEncryption": {
"type": "SystemManaged"
},
"databaseName": "citus",
"earliestRestoreTime": "2020-09-14T00:00:37.467Z",
"enableHa": false,
"enableShardsOnCoordinator": false,
"maintenanceWindow": {
"customWindow": "Disabled",
"dayOfWeek": 0,
"startHour": 0,
"startMinute": 0
},
"nodeCount": 3,
"nodeEnablePublicIpAccess": false,
"nodeServerEdition": "MemoryOptimized",
"nodeStorageQuotaInMb": 2097152,
"nodeVCores": 16,
"passwordEnabled": "enabled",
"postgresqlVersion": "14",
"preferredPrimaryZone": "1",
"privateEndpointConnections": [],
"provisioningState": "Succeeded",
"readReplicas": [],
"serverNames": [
{
"name": "testcluster1-c",
"fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
},
{
"name": "testcluster1-w0",
"fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
},
{
"name": "testcluster1-w1",
"fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
},
{
"name": "testcluster1-w2",
"fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
}
],
"sourceResourceId": null,
"state": "Ready"
},
"systemData": {
"createdAt": "2020-01-01T17:18:19.1234567Z",
"createdBy": "user1",
"createdByType": "User",
"lastModifiedAt": "2020-01-02T17:18:19.1234567Z",
"lastModifiedBy": "user2",
"lastModifiedByType": "User"
}
}
Scale out: Add new worker nodes
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster?api-version=2023-03-02-preview
{
"properties": {
"nodeCount": 2
}
}
応答のサンプル
{
"name": "testcluster",
"type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
"location": "westus",
"properties": {
"aadAuthEnabled": "disabled",
"citusVersion": "11.1",
"coordinatorEnablePublicIpAccess": true,
"coordinatorServerEdition": "GeneralPurpose",
"coordinatorStorageQuotaInMb": 524288,
"coordinatorVCores": 4,
"dataEncryption": {
"type": "SystemManaged"
},
"databaseName": "citus",
"earliestRestoreTime": null,
"enableGeoBackup": false,
"enableHa": true,
"enableShardsOnCoordinator": false,
"maintenanceWindow": {
"customWindow": "Disabled",
"dayOfWeek": 0,
"startHour": 0,
"startMinute": 0
},
"nodeCount": 2,
"nodeEnablePublicIpAccess": false,
"nodeServerEdition": "MemoryOptimized",
"nodeStorageQuotaInMb": 524288,
"nodeVCores": 8,
"passwordEnabled": "enabled",
"postgresqlVersion": "15",
"preferredPrimaryZone": "1",
"privateEndpointConnections": [],
"provisioningState": "Provisioning",
"readReplicas": [],
"serverNames": [
{
"name": "testcluster-c",
"fullyQualifiedDomainName": "c.testcluster.postgres.database.azure.com"
},
{
"name": "testcluster-w0",
"fullyQualifiedDomainName": "w0.testcluster.postgres.database.azure.com"
},
{
"name": "testcluster-w1",
"fullyQualifiedDomainName": "w1.testcluster.postgres.database.azure.com"
}
],
"sourceResourceId": null,
"state": "Provisioning"
},
"systemData": {
"createdAt": "2020-01-01T17:18:19.1234567Z",
"createdBy": "user1",
"createdByType": "User",
"lastModifiedAt": "2020-01-02T17:18:19.1234567Z",
"lastModifiedBy": "user2",
"lastModifiedByType": "User"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
{
"name": "testcluster",
"type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
"location": "westus",
"properties": {
"aadAuthEnabled": "disabled",
"citusVersion": "11.1",
"coordinatorEnablePublicIpAccess": true,
"coordinatorServerEdition": "GeneralPurpose",
"coordinatorStorageQuotaInMb": 524288,
"coordinatorVCores": 4,
"dataEncryption": {
"type": "SystemManaged"
},
"databaseName": "citus",
"earliestRestoreTime": null,
"enableGeoBackup": false,
"enableHa": true,
"enableShardsOnCoordinator": false,
"maintenanceWindow": {
"customWindow": "Disabled",
"dayOfWeek": 0,
"startHour": 0,
"startMinute": 0
},
"nodeCount": 2,
"nodeEnablePublicIpAccess": false,
"nodeServerEdition": "MemoryOptimized",
"nodeStorageQuotaInMb": 524288,
"nodeVCores": 8,
"passwordEnabled": "enabled",
"postgresqlVersion": "15",
"preferredPrimaryZone": "1",
"privateEndpointConnections": [],
"provisioningState": "Provisioning",
"readReplicas": [],
"serverNames": [
{
"name": "testcluster-c",
"fullyQualifiedDomainName": "c.testcluster.postgres.database.azure.com"
},
{
"name": "testcluster-w0",
"fullyQualifiedDomainName": "w0.testcluster.postgres.database.azure.com"
},
{
"name": "testcluster-w1",
"fullyQualifiedDomainName": "w1.testcluster.postgres.database.azure.com"
}
],
"sourceResourceId": null,
"state": "Provisioning"
},
"systemData": {
"createdAt": "2020-01-01T17:18:19.1234567Z",
"createdBy": "user1",
"createdByType": "User",
"lastModifiedAt": "2020-01-02T17:18:19.1234567Z",
"lastModifiedBy": "user2",
"lastModifiedByType": "User"
}
}
Scale up storage
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster?api-version=2023-03-02-preview
{
"properties": {
"nodeStorageQuotaInMb": 2097152
}
}
応答のサンプル
{
"name": "testcluster",
"type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
"location": "westus",
"properties": {
"aadAuthEnabled": "disabled",
"administratorLogin": "citus",
"citusVersion": "11.1",
"coordinatorEnablePublicIpAccess": true,
"coordinatorServerEdition": "GeneralPurpose",
"coordinatorStorageQuotaInMb": 2097152,
"coordinatorVCores": 16,
"dataEncryption": {
"type": "SystemManaged"
},
"databaseName": "citus",
"earliestRestoreTime": "2020-09-14T00:00:37.467Z",
"enableHa": false,
"enableShardsOnCoordinator": false,
"maintenanceWindow": {
"customWindow": "Disabled",
"dayOfWeek": 0,
"startHour": 0,
"startMinute": 0
},
"nodeCount": 3,
"nodeEnablePublicIpAccess": false,
"nodeServerEdition": "MemoryOptimized",
"nodeStorageQuotaInMb": 2097152,
"nodeVCores": 16,
"passwordEnabled": "enabled",
"postgresqlVersion": "14",
"preferredPrimaryZone": "1",
"privateEndpointConnections": [],
"provisioningState": "Succeeded",
"readReplicas": [],
"serverNames": [
{
"name": "testcluster1-c",
"fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
},
{
"name": "testcluster1-w0",
"fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
},
{
"name": "testcluster1-w1",
"fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
},
{
"name": "testcluster1-w2",
"fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
}
],
"sourceResourceId": null,
"state": "Ready"
},
"systemData": {
"createdAt": "2020-01-01T17:18:19.1234567Z",
"createdBy": "user1",
"createdByType": "User",
"lastModifiedAt": "2020-01-02T17:18:19.1234567Z",
"lastModifiedBy": "user2",
"lastModifiedByType": "User"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
{
"name": "testcluster",
"type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
"location": "westus",
"properties": {
"aadAuthEnabled": "disabled",
"administratorLogin": "citus",
"citusVersion": "11.1",
"coordinatorEnablePublicIpAccess": true,
"coordinatorServerEdition": "GeneralPurpose",
"coordinatorStorageQuotaInMb": 2097152,
"coordinatorVCores": 16,
"dataEncryption": {
"type": "SystemManaged"
},
"databaseName": "citus",
"earliestRestoreTime": "2020-09-14T00:00:37.467Z",
"enableHa": false,
"enableShardsOnCoordinator": false,
"maintenanceWindow": {
"customWindow": "Disabled",
"dayOfWeek": 0,
"startHour": 0,
"startMinute": 0
},
"nodeCount": 3,
"nodeEnablePublicIpAccess": false,
"nodeServerEdition": "MemoryOptimized",
"nodeStorageQuotaInMb": 2097152,
"nodeVCores": 16,
"passwordEnabled": "enabled",
"postgresqlVersion": "14",
"preferredPrimaryZone": "1",
"privateEndpointConnections": [],
"provisioningState": "Succeeded",
"readReplicas": [],
"serverNames": [
{
"name": "testcluster1-c",
"fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
},
{
"name": "testcluster1-w0",
"fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
},
{
"name": "testcluster1-w1",
"fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
},
{
"name": "testcluster1-w2",
"fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
}
],
"sourceResourceId": null,
"state": "Ready"
},
"systemData": {
"createdAt": "2020-01-01T17:18:19.1234567Z",
"createdBy": "user1",
"createdByType": "User",
"lastModifiedAt": "2020-01-02T17:18:19.1234567Z",
"lastModifiedBy": "user2",
"lastModifiedByType": "User"
}
}
Update multiple configuration settings of the cluster
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster?api-version=2023-03-02-preview
{
"properties": {
"administratorLoginPassword": "newpassword",
"coordinatorVCores": 16,
"nodeCount": 4,
"nodeVCores": 16
}
}
応答のサンプル
{
"name": "testcluster1",
"type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1",
"location": "westus",
"properties": {
"aadAuthEnabled": "disabled",
"administratorLogin": "citus",
"citusVersion": "11.1",
"coordinatorEnablePublicIpAccess": true,
"coordinatorServerEdition": "GeneralPurpose",
"coordinatorStorageQuotaInMb": 2097152,
"coordinatorVCores": 16,
"dataEncryption": {
"type": "SystemManaged"
},
"databaseName": "citus",
"earliestRestoreTime": "2020-09-14T00:00:37.467Z",
"enableHa": false,
"enableShardsOnCoordinator": false,
"maintenanceWindow": {
"customWindow": "Disabled",
"dayOfWeek": 0,
"startHour": 0,
"startMinute": 0
},
"nodeCount": 4,
"nodeEnablePublicIpAccess": false,
"nodeServerEdition": "MemoryOptimized",
"nodeStorageQuotaInMb": 2097152,
"nodeVCores": 16,
"passwordEnabled": "enabled",
"postgresqlVersion": "14",
"preferredPrimaryZone": "1",
"privateEndpointConnections": [],
"provisioningState": "Succeeded",
"readReplicas": [
"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSQL/serverGroupsv2/testreadreplica-01",
"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSQL/serverGroupsv2/testreadreplica-02"
],
"serverNames": [
{
"name": "testcluster1-c",
"fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
},
{
"name": "testcluster1-w0",
"fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
},
{
"name": "testcluster1-w1",
"fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
},
{
"name": "testcluster1-w2",
"fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
},
{
"name": "testcluster1-w3",
"fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
}
],
"sourceResourceId": null,
"state": "Ready"
},
"systemData": {
"createdAt": "2020-01-01T17:18:19.1234567Z",
"createdBy": "user1",
"createdByType": "User",
"lastModifiedAt": "2020-01-02T17:18:19.1234567Z",
"lastModifiedBy": "user2",
"lastModifiedByType": "User"
},
"tags": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
{
"name": "testcluster1",
"type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1",
"location": "westus",
"properties": {
"aadAuthEnabled": "disabled",
"administratorLogin": "citus",
"citusVersion": "11.1",
"coordinatorEnablePublicIpAccess": true,
"coordinatorServerEdition": "GeneralPurpose",
"coordinatorStorageQuotaInMb": 2097152,
"coordinatorVCores": 16,
"dataEncryption": {
"type": "SystemManaged"
},
"databaseName": "citus",
"earliestRestoreTime": "2020-09-14T00:00:37.467Z",
"enableHa": false,
"enableShardsOnCoordinator": false,
"maintenanceWindow": {
"customWindow": "Disabled",
"dayOfWeek": 0,
"startHour": 0,
"startMinute": 0
},
"nodeCount": 4,
"nodeEnablePublicIpAccess": false,
"nodeServerEdition": "MemoryOptimized",
"nodeStorageQuotaInMb": 2097152,
"nodeVCores": 16,
"passwordEnabled": "enabled",
"postgresqlVersion": "14",
"preferredPrimaryZone": "1",
"privateEndpointConnections": [],
"provisioningState": "Succeeded",
"readReplicas": [
"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSQL/serverGroupsv2/testreadreplica-01",
"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSQL/serverGroupsv2/testreadreplica-02"
],
"serverNames": [
{
"name": "testcluster1-c",
"fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
},
{
"name": "testcluster1-w0",
"fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
},
{
"name": "testcluster1-w1",
"fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
},
{
"name": "testcluster1-w2",
"fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
},
{
"name": "testcluster1-w3",
"fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
}
],
"sourceResourceId": null,
"state": "Ready"
},
"systemData": {
"createdAt": "2020-01-01T17:18:19.1234567Z",
"createdBy": "user1",
"createdByType": "User",
"lastModifiedAt": "2020-01-02T17:18:19.1234567Z",
"lastModifiedBy": "user2",
"lastModifiedByType": "User"
},
"tags": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
Update or define maintenance window
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster?api-version=2023-03-02-preview
{
"properties": {
"maintenanceWindow": {
"customWindow": "Enabled",
"dayOfWeek": 0,
"startHour": 8,
"startMinute": 0
}
}
}
応答のサンプル
{
"name": "testcluster",
"type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
"location": "westus",
"properties": {
"aadAuthEnabled": "disabled",
"administratorLogin": "citus",
"citusVersion": "11.1",
"coordinatorEnablePublicIpAccess": true,
"coordinatorServerEdition": "GeneralPurpose",
"coordinatorStorageQuotaInMb": 2097152,
"coordinatorVCores": 16,
"dataEncryption": {
"type": "SystemManaged"
},
"databaseName": "citus",
"earliestRestoreTime": "2020-09-14T00:00:37.467Z",
"enableHa": false,
"enableShardsOnCoordinator": false,
"maintenanceWindow": {
"customWindow": "Enabled",
"dayOfWeek": 0,
"startHour": 8,
"startMinute": 0
},
"nodeCount": 2,
"nodeEnablePublicIpAccess": false,
"nodeServerEdition": "MemoryOptimized",
"nodeStorageQuotaInMb": 2097152,
"nodeVCores": 16,
"passwordEnabled": "enabled",
"postgresqlVersion": "14",
"preferredPrimaryZone": "1",
"privateEndpointConnections": [],
"provisioningState": "Succeeded",
"readReplicas": [],
"serverNames": [
{
"name": "testcluster1-c",
"fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
},
{
"name": "testcluster1-w0",
"fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
},
{
"name": "testcluster1-w1",
"fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
}
],
"sourceResourceId": null,
"state": "Ready"
},
"systemData": {
"createdAt": "2020-01-01T17:18:19.1234567Z",
"createdBy": "user1",
"createdByType": "User",
"lastModifiedAt": "2020-01-02T17:18:19.1234567Z",
"lastModifiedBy": "user2",
"lastModifiedByType": "User"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
{
"name": "testcluster",
"type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
"location": "westus",
"properties": {
"aadAuthEnabled": "disabled",
"administratorLogin": "citus",
"citusVersion": "11.1",
"coordinatorEnablePublicIpAccess": true,
"coordinatorServerEdition": "GeneralPurpose",
"coordinatorStorageQuotaInMb": 2097152,
"coordinatorVCores": 16,
"dataEncryption": {
"type": "SystemManaged"
},
"databaseName": "citus",
"earliestRestoreTime": "2020-09-14T00:00:37.467Z",
"enableHa": false,
"enableShardsOnCoordinator": false,
"maintenanceWindow": {
"customWindow": "Enabled",
"dayOfWeek": 0,
"startHour": 8,
"startMinute": 0
},
"nodeCount": 2,
"nodeEnablePublicIpAccess": false,
"nodeServerEdition": "MemoryOptimized",
"nodeStorageQuotaInMb": 2097152,
"nodeVCores": 16,
"passwordEnabled": "enabled",
"postgresqlVersion": "14",
"preferredPrimaryZone": "1",
"privateEndpointConnections": [],
"provisioningState": "Succeeded",
"readReplicas": [],
"serverNames": [
{
"name": "testcluster1-c",
"fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
},
{
"name": "testcluster1-w0",
"fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
},
{
"name": "testcluster1-w1",
"fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
}
],
"sourceResourceId": null,
"state": "Ready"
},
"systemData": {
"createdAt": "2020-01-01T17:18:19.1234567Z",
"createdBy": "user1",
"createdByType": "User",
"lastModifiedAt": "2020-01-02T17:18:19.1234567Z",
"lastModifiedBy": "user2",
"lastModifiedByType": "User"
}
}
定義
| 名前 | 説明 |
|---|---|
|
Aad |
クラスターが AAD 認証を使用して作成されたかどうかを示します。 |
|
Active |
|
|
Auth |
クラスターの認証構成。 |
| Cluster |
クラスターを表します。 |
|
Cluster |
更新対象のクラスターを表します。 |
|
created |
リソースを作成した ID の種類。 |
|
Data |
クラスターのデータ暗号化プロパティ。 |
|
Data |
|
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
|
Identity |
クラスターの ID について説明します。 |
|
Identity |
|
|
Maintenance |
定期的なクラスター更新プログラムの設定をスケジュールします。 |
|
Password |
|
|
Password |
クラスターがパスワードで作成されたか、AAD 認証を使用して作成されたかを示します。 |
|
Private |
プライベート エンドポイントのリソース ID を表すプロパティ。 |
|
Private |
プライベート エンドポイント接続の状態。 |
|
Private |
サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 |
|
Server |
サーバーの名前オブジェクト。 |
|
Simple |
プライベート エンドポイント接続。 |
|
system |
リソースの作成と最後の変更に関連するメタデータ。 |
|
User |
ユーザー割り当て ID プロパティ |
AadEnabledEnum
クラスターが AAD 認証を使用して作成されたかどうかを示します。
| 値 | 説明 |
|---|---|
| enabled | |
| disabled |
ActiveDirectoryAuth
| 値 | 説明 |
|---|---|
| enabled | |
| disabled |
AuthConfig
クラスターの認証構成。
| 名前 | 型 | 説明 |
|---|---|---|
| activeDirectoryAuth | ||
| passwordAuth |
Cluster
クラスターを表します。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string (arm-id) |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| identity |
クラスターの ID について説明します。 |
|
| location |
string |
リソースが存在する地理的な場所 |
| name |
string |
リソースの名前 |
| properties.aadAuthEnabled |
クラスターが AAD 認証を使用して作成されたかどうかを示します。 |
|
| properties.administratorLogin |
string |
クラスター内のサーバーの管理者のログイン名。 |
| properties.administratorLoginPassword |
string (password) |
管理者ログインのパスワード。 作成に必要です。 |
| properties.authConfig |
クラスターの認証構成。 |
|
| properties.citusVersion |
string |
すべてのクラスター サーバー上の Citus 拡張機能バージョン。 |
| properties.coordinatorEnablePublicIpAccess |
boolean |
コーディネーターでパブリック アクセスが有効になっている場合。 |
| properties.coordinatorServerEdition |
string |
コーディネーター サーバーのエディション (既定値: GeneralPurpose)。 作成に必要です。 |
| properties.coordinatorStorageQuotaInMb |
integer (int32) |
サーバーのストレージ (MB 単位)。 作成に必要です。 詳細については、https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute を参照してください。 |
| properties.coordinatorVCores |
integer (int32) |
サーバーの仮想コア数 (最大: 96)。 作成に必要です。 詳細については、https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute を参照してください。 |
| properties.dataEncryption |
クラスターのデータ暗号化プロパティ。 |
|
| properties.databaseName |
string |
クラスターのデータベース名。 サポートされているデータベースは、クラスターごとに 1 つだけです。 |
| properties.earliestRestoreTime |
string (date-time) |
クラスターの最も古い復元ポイント時間 (ISO8601形式)。 |
| properties.enableGeoBackup |
boolean |
クラスターのバックアップが、クラスターのリージョンに格納されているバックアップのコピーに加えて、別の Azure リージョンに格納されている場合。 クラスターの作成時にのみ有効になります。 |
| properties.enableHa |
boolean |
高可用性 (HA) がクラスターに対して有効になっているかどうか。 |
| properties.enableShardsOnCoordinator |
boolean |
分散テーブルがコーディネーターに配置されているかどうか。 単一ノード クラスターで 'true' に設定する必要があります。 値が変更された後にシャードの再調整が必要です。 |
| properties.maintenanceWindow |
クラスターのメンテナンス期間。 |
|
| properties.nodeCount |
integer (int32) |
クラスターのワーカー ノード数。 ノード数が 0 の場合、ノードに分散テーブルを作成する機能を持つ単一のノード構成を表します。 2 つ以上のワーカー ノードがマルチノード構成を表します。 ノード数の値を 1 にすることはできません。 作成に必要です。 |
| properties.nodeEnablePublicIpAccess |
boolean |
ワーカー ノードでパブリック アクセスが有効になっている場合。 |
| properties.nodeServerEdition |
string |
ノード サーバーのエディション (既定値: MemoryOptimized)。 |
| properties.nodeStorageQuotaInMb |
integer (int32) |
各ワーカー ノードのストレージ (MB 単位)。 詳細については、https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute を参照してください。 |
| properties.nodeVCores |
integer (int32) |
各ワーカー ノードの仮想コア単位のコンピューティング (最大: 104)。 詳細については、https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute を参照してください。 |
| properties.passwordEnabled |
クラスターがパスワードで作成されたか、AAD 認証を使用して作成されたかを示します。 |
|
| properties.pointInTimeUTC |
string (date-time) |
クラスターの復元の UTC (ISO8601形式) の日付と時刻。 |
| properties.postgresqlVersion |
string |
すべてのクラスター サーバー上の PostgreSQL のメジャー バージョン。 |
| properties.preferredPrimaryZone |
string |
すべてのクラスター サーバーの優先プライマリ可用性ゾーン (AZ)。 |
| properties.privateEndpointConnections |
クラスターのプライベート エンドポイント接続。 |
|
| properties.provisioningState |
string |
クラスターのプロビジョニング状態 |
| properties.readReplicas |
string[] |
読み取りレプリカ クラスターの配列。 |
| properties.serverNames |
クラスター内のサーバー名の一覧 |
|
| properties.sourceLocation |
string |
読み取りレプリカ クラスターのソース クラスターの Azure リージョン。 |
| properties.sourceResourceId |
string |
読み取りレプリカ クラスターのソース クラスターのリソース ID。 |
| properties.state |
string |
ユーザーに表示されるクラスター/サーバーの状態。 |
| systemData |
createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
|
| tags |
object |
リソース タグ。 |
| type |
string |
リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
ClusterForUpdate
更新対象のクラスターを表します。
| 名前 | 型 | 説明 |
|---|---|---|
| identity |
クラスターの ID について説明します。 |
|
| properties.administratorLoginPassword |
string (password) |
管理者ログインのパスワード。 各クラスターは、"citus" と呼ばれる定義済みの管理ロールを使用して作成されます。 |
| properties.citusVersion |
string |
すべてのクラスター サーバー上の Citus 拡張機能バージョン。 |
| properties.coordinatorEnablePublicIpAccess |
boolean |
コーディネーターでパブリック アクセスが有効になっている場合。 |
| properties.coordinatorServerEdition |
string |
コーディネーターのエディション (既定値: GeneralPurpose)。 |
| properties.coordinatorStorageQuotaInMb |
integer (int32) |
コーディネーターのストレージ (MB 単位)。 |
| properties.coordinatorVCores |
integer (int32) |
コーディネーターの仮想コア数 (最大: 96)。 |
| properties.enableHa |
boolean |
高可用性 (HA) がクラスターに対して有効になっているかどうか。 |
| properties.enableShardsOnCoordinator |
boolean |
分散テーブルがコーディネーターに配置されているかどうか。 単一ノード クラスターで 'true' に設定する必要があります。 値が変更された後にシャードの再調整が必要です。 |
| properties.maintenanceWindow |
クラスターのメンテナンス期間。 |
|
| properties.nodeCount |
integer (int32) |
クラスターのワーカー ノード数。 ノード数が 0 の場合、ノードに分散テーブルを作成する機能を持つ単一のノード構成を表します。 2 つ以上のワーカー ノードがマルチノード構成を表します。 ノード数の値を 1 にすることはできません。 |
| properties.nodeEnablePublicIpAccess |
boolean |
ワーカー ノードでパブリック アクセスが有効になっている場合。 |
| properties.nodeServerEdition |
string |
ノードのエディション (既定値: MemoryOptimized)。 |
| properties.nodeStorageQuotaInMb |
integer (int32) |
各ワーカー ノードのストレージ (MB 単位)。 |
| properties.nodeVCores |
integer (int32) |
各ワーカー ノードの仮想コア単位のコンピューティング (最大: 104)。 |
| properties.postgresqlVersion |
string |
すべてのクラスター サーバー上の PostgreSQL のメジャー バージョン。 |
| properties.preferredPrimaryZone |
string |
すべてのクラスター サーバーの優先プライマリ可用性ゾーン (AZ)。 |
| tags |
object |
キーと値のペアの形式のアプリケーション固有のメタデータ。 |
createdByType
リソースを作成した ID の種類。
| 値 | 説明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DataEncryption
クラスターのデータ暗号化プロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| primaryKeyUri |
string |
プライマリ サーバーのデータ暗号化のための keyvault 内のキーの URI。 |
| primaryUserAssignedIdentityId |
string |
プライマリ サーバーのデータ暗号化に使用するユーザー割り当て ID のリソース ID。 |
| type |
DataEncryptionType
| 値 | 説明 |
|---|---|
| AzureKeyVault | |
| SystemAssigned |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
IdentityProperties
クラスターの ID について説明します。
| 名前 | 型 | 説明 |
|---|---|---|
| type | ||
| userAssignedIdentities |
<string,
User |
リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 |
IdentityType
| 値 | 説明 |
|---|---|
| UserAssigned | |
| SystemAssigned |
MaintenanceWindow
定期的なクラスター更新プログラムの設定をスケジュールします。
| 名前 | 型 | 説明 |
|---|---|---|
| customWindow |
string |
カスタム メンテナンス期間が有効かどうかを示します。 |
| dayOfWeek |
integer (int32) |
メンテナンス期間の優先曜日。 |
| startHour |
integer (int32) |
メンテナンス期間の希望する曜日内の開始時間。 |
| startMinute |
integer (int32) |
メンテナンス期間の開始時刻内の開始分。 |
PasswordAuth
| 値 | 説明 |
|---|---|
| enabled | |
| disabled |
PasswordEnabledEnum
クラスターがパスワードで作成されたか、AAD 認証を使用して作成されたかを示します。
| 値 | 説明 |
|---|---|
| enabled | |
| disabled |
PrivateEndpointProperty
プライベート エンドポイントのリソース ID を表すプロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string |
プライベート エンドポイントのリソース ID。 |
PrivateEndpointServiceConnectionStatus
プライベート エンドポイント接続の状態。
| 値 | 説明 |
|---|---|
| Pending | |
| Approved | |
| Rejected |
PrivateLinkServiceConnectionState
サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
| 名前 | 型 | 説明 |
|---|---|---|
| actionsRequired |
string |
サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。 |
| description |
string |
接続の承認/拒否の理由。 |
| status |
接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。 |
ServerNameItem
サーバーの名前オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| fullyQualifiedDomainName |
string |
サーバーの完全修飾ドメイン名。 |
| name |
string |
サーバーの名前。 |
SimplePrivateEndpointConnection
プライベート エンドポイント接続。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string (arm-id) |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| name |
string |
リソースの名前 |
| properties.groupIds |
string[] |
プライベート エンドポイント接続のグループ ID。 |
| properties.privateEndpoint |
接続が属するプライベート エンドポイント。 |
|
| properties.privateLinkServiceConnectionState |
サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 |
|
| systemData |
createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
|
| type |
string |
リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
systemData
リソースの作成と最後の変更に関連するメタデータ。
| 名前 | 型 | 説明 |
|---|---|---|
| createdAt |
string (date-time) |
リソース作成のタイムスタンプ (UTC)。 |
| createdBy |
string |
リソースを作成した ID。 |
| createdByType |
リソースを作成した ID の種類。 |
|
| lastModifiedAt |
string (date-time) |
リソースの最終変更のタイムスタンプ (UTC) |
| lastModifiedBy |
string |
リソースを最後に変更した ID。 |
| lastModifiedByType |
リソースを最後に変更した ID の種類。 |
UserAssignedIdentity
ユーザー割り当て ID プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
| clientId |
string (uuid) |
割り当てられた ID のクライアント ID。 |
| principalId |
string (uuid) |
割り当てられた ID のプリンシパル ID。 |