Clusters - Update

リファレンス

サービス:: Cosmos DB for PostgreSQL

API バージョン:: 2023-03-02-preview

既存のクラスターをUpdatesします。要求本文には、クラスター定義の 1 つまたは複数のプロパティを含めることができます。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}?api-version=2023-03-02-preview

URI パラメーター

名前	/	必須	型	説明
clusterName	path	True	string	クラスターの名前です。正規表現パターン: `^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$`
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
subscriptionId	path	True	string uuid	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	型	説明
identity	IdentityProperties	クラスターの ID について説明します。
properties.administratorLoginPassword	string	管理者ログインのパスワード。各クラスターは、'citus' と呼ばれる定義済みの管理ロールを使用して作成されます。
properties.citusVersion	string	すべてのクラスターサーバー上の Citus 拡張機能バージョン。
properties.coordinatorEnablePublicIpAccess	boolean	コーディネーターでパブリックアクセスが有効になっている場合。
properties.coordinatorServerEdition	string	コーディネーターのエディション (既定値: GeneralPurpose)。
properties.coordinatorStorageQuotaInMb	integer	コーディネーターのストレージ (MB 単位)。
properties.coordinatorVCores	integer	コーディネーターの仮想コア数 (最大: 96)。
properties.enableHa	boolean	高可用性 (HA) がクラスターに対して有効になっているかどうか。
properties.enableShardsOnCoordinator	boolean	分散テーブルがコーディネーターに配置されているかどうか。単一ノードクラスターでは、"true" に設定する必要があります。値が変更された後にシャードの再調整が必要です。
properties.maintenanceWindow	MaintenanceWindow	クラスターのメンテナンス期間。
properties.nodeCount	integer	クラスターのワーカーノード数。ノード数が 0 の場合は、そのノードに分散テーブルを作成できる単一のノード構成を表します。 2 つ以上のワーカーノードがマルチノード構成を表します。ノード数の値を 1 にすることはできません。
properties.nodeServerEdition	string	ノードのエディション (既定値: MemoryOptimized)。
properties.nodeStorageQuotaInMb	integer	各ワーカーノードのストレージ (MB 単位)。
properties.nodeVCores	integer	各ワーカーノードの仮想コア単位のコンピューティング (最大: 104)。
properties.postgresqlVersion	string	すべてのクラスターサーバー上の PostgreSQL のメジャーバージョン。
properties.preferredPrimaryZone	string	すべてのクラスターサーバーに推奨されるプライマリ可用性ゾーン (AZ)。
tags	object	キーと値のペアの形式による、アプリケーション固有のメタデータ。

応答

名前	型	説明
200 OK	Cluster	OK
202 Accepted	Cluster	同意ヘッダー location: string azure-async-operation: string
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

Cluster

202 Accepted

Cluster

同意

ヘッダー

location: string
azure-async-operation: string

Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

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
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdbforpostgresql import CosmosdbForPostgresqlMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdbforpostgresql
# USAGE
    python cluster_scale_compute.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosdbForPostgresqlMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.clusters.begin_update(
        resource_group_name="TestGroup",
        cluster_name="testcluster",
        parameters={"properties": {"nodeVCores": 16}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterScaleCompute.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmosforpostgresql_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmosforpostgresql/armcosmosforpostgresql"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterScaleCompute.json
func ExampleClustersClient_BeginUpdate_scaleComputeUpOrDown() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmosforpostgresql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClustersClient().BeginUpdate(ctx, "TestGroup", "testcluster", armcosmosforpostgresql.ClusterForUpdate{
		Properties: &armcosmosforpostgresql.ClusterPropertiesForUpdate{
			NodeVCores: to.Ptr[int32](16),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Cluster = armcosmosforpostgresql.Cluster{
	// 	Name: to.Ptr("testcluster"),
	// 	Type: to.Ptr("Microsoft.DBforPostgreSQL/serverGroupsv2"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster"),
	// 	SystemData: &armcosmosforpostgresql.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("westus"),
	// 	Properties: &armcosmosforpostgresql.ClusterProperties{
	// 		AdministratorLogin: to.Ptr("citus"),
	// 		CitusVersion: to.Ptr("11.1"),
	// 		CoordinatorEnablePublicIPAccess: to.Ptr(true),
	// 		CoordinatorServerEdition: to.Ptr("GeneralPurpose"),
	// 		CoordinatorStorageQuotaInMb: to.Ptr[int32](2097152),
	// 		CoordinatorVCores: to.Ptr[int32](16),
	// 		EarliestRestoreTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-14T00:00:37.467Z"); return t}()),
	// 		EnableHa: to.Ptr(false),
	// 		EnableShardsOnCoordinator: to.Ptr(false),
	// 		MaintenanceWindow: &armcosmosforpostgresql.MaintenanceWindow{
	// 			CustomWindow: to.Ptr("Disabled"),
	// 			DayOfWeek: to.Ptr[int32](0),
	// 			StartHour: to.Ptr[int32](0),
	// 			StartMinute: to.Ptr[int32](0),
	// 		},
	// 		NodeCount: to.Ptr[int32](3),
	// 		NodeEnablePublicIPAccess: to.Ptr(false),
	// 		NodeServerEdition: to.Ptr("MemoryOptimized"),
	// 		NodeStorageQuotaInMb: to.Ptr[int32](2097152),
	// 		NodeVCores: to.Ptr[int32](16),
	// 		PostgresqlVersion: to.Ptr("14"),
	// 		PreferredPrimaryZone: to.Ptr("1"),
	// 		PrivateEndpointConnections: []*armcosmosforpostgresql.SimplePrivateEndpointConnection{
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ReadReplicas: []*string{
	// 		},
	// 		ServerNames: []*armcosmosforpostgresql.ServerNameItem{
	// 			{
	// 				Name: to.Ptr("testcluster1-c"),
	// 				FullyQualifiedDomainName: to.Ptr("testcluster1-c.postgres.database.azure.com"),
	// 			},
	// 			{
	// 				Name: to.Ptr("testcluster1-w0"),
	// 				FullyQualifiedDomainName: to.Ptr("testcluster1-w0.postgres.database.azure.com"),
	// 			},
	// 			{
	// 				Name: to.Ptr("testcluster1-w1"),
	// 				FullyQualifiedDomainName: to.Ptr("testcluster1-w1.postgres.database.azure.com"),
	// 			},
	// 			{
	// 				Name: to.Ptr("testcluster1-w2"),
	// 				FullyQualifiedDomainName: to.Ptr("testcluster1-w2.postgres.database.azure.com"),
	// 		}},
	// 		State: to.Ptr("Ready"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBForPostgreSQL } = require("@azure/arm-cosmosdbforpostgresql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
 *
 * @summary Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
 * x-ms-original-file: specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterScaleCompute.json
 */
async function scaleComputeUpOrDown() {
  const subscriptionId =
    process.env["COSMOSFORPOSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["COSMOSFORPOSTGRESQL_RESOURCE_GROUP"] || "TestGroup";
  const clusterName = "testcluster";
  const parameters = { nodeVCores: 16 };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBForPostgreSQL(credential, subscriptionId);
  const result = await client.clusters.beginUpdateAndWait(
    resourceGroupName,
    clusterName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0,
      "customWindow": "Disabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 3,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "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,
    "readReplicas": [],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  },
  "location": "westus"
}

状態コード:: 202

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

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0,
      "customWindow": "Disabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 3,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "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,
    "readReplicas": [],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  },
  "location": "westus"
}

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
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdbforpostgresql import CosmosdbForPostgresqlMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdbforpostgresql
# USAGE
    python cluster_add_node.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosdbForPostgresqlMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.clusters.begin_update(
        resource_group_name="TestGroup",
        cluster_name="testcluster",
        parameters={"properties": {"nodeCount": 2}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterAddNode.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmosforpostgresql_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmosforpostgresql/armcosmosforpostgresql"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterAddNode.json
func ExampleClustersClient_BeginUpdate_scaleOutAddNewWorkerNodes() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmosforpostgresql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClustersClient().BeginUpdate(ctx, "TestGroup", "testcluster", armcosmosforpostgresql.ClusterForUpdate{
		Properties: &armcosmosforpostgresql.ClusterPropertiesForUpdate{
			NodeCount: to.Ptr[int32](2),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Cluster = armcosmosforpostgresql.Cluster{
	// 	Name: to.Ptr("testcluster"),
	// 	Type: to.Ptr("Microsoft.DBforPostgreSQL/serverGroupsv2"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster"),
	// 	SystemData: &armcosmosforpostgresql.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("westus"),
	// 	Properties: &armcosmosforpostgresql.ClusterProperties{
	// 		CitusVersion: to.Ptr("11.1"),
	// 		CoordinatorEnablePublicIPAccess: to.Ptr(true),
	// 		CoordinatorServerEdition: to.Ptr("GeneralPurpose"),
	// 		CoordinatorStorageQuotaInMb: to.Ptr[int32](524288),
	// 		CoordinatorVCores: to.Ptr[int32](4),
	// 		EnableHa: to.Ptr(true),
	// 		EnableShardsOnCoordinator: to.Ptr(false),
	// 		MaintenanceWindow: &armcosmosforpostgresql.MaintenanceWindow{
	// 			CustomWindow: to.Ptr("Disabled"),
	// 			DayOfWeek: to.Ptr[int32](0),
	// 			StartHour: to.Ptr[int32](0),
	// 			StartMinute: to.Ptr[int32](0),
	// 		},
	// 		NodeCount: to.Ptr[int32](2),
	// 		NodeEnablePublicIPAccess: to.Ptr(false),
	// 		NodeServerEdition: to.Ptr("MemoryOptimized"),
	// 		NodeStorageQuotaInMb: to.Ptr[int32](524288),
	// 		NodeVCores: to.Ptr[int32](8),
	// 		PostgresqlVersion: to.Ptr("15"),
	// 		PreferredPrimaryZone: to.Ptr("1"),
	// 		PrivateEndpointConnections: []*armcosmosforpostgresql.SimplePrivateEndpointConnection{
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ReadReplicas: []*string{
	// 		},
	// 		ServerNames: []*armcosmosforpostgresql.ServerNameItem{
	// 			{
	// 				Name: to.Ptr("testcluster-c"),
	// 				FullyQualifiedDomainName: to.Ptr("c.testcluster.postgres.database.azure.com"),
	// 			},
	// 			{
	// 				Name: to.Ptr("testcluster-w0"),
	// 				FullyQualifiedDomainName: to.Ptr("w0.testcluster.postgres.database.azure.com"),
	// 			},
	// 			{
	// 				Name: to.Ptr("testcluster-w1"),
	// 				FullyQualifiedDomainName: to.Ptr("w1.testcluster.postgres.database.azure.com"),
	// 		}},
	// 		State: to.Ptr("Provisioning"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBForPostgreSQL } = require("@azure/arm-cosmosdbforpostgresql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
 *
 * @summary Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
 * x-ms-original-file: specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterAddNode.json
 */
async function scaleOutAddNewWorkerNodes() {
  const subscriptionId =
    process.env["COSMOSFORPOSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["COSMOSFORPOSTGRESQL_RESOURCE_GROUP"] || "TestGroup";
  const clusterName = "testcluster";
  const parameters = { nodeCount: 2 };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBForPostgreSQL(credential, subscriptionId);
  const result = await client.clusters.beginUpdateAndWait(
    resourceGroupName,
    clusterName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Provisioning",
    "state": "Provisioning",
    "aadAuthEnabled": "disabled",
    "postgresqlVersion": "15",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "preferredPrimaryZone": "1",
    "nodeCount": 2,
    "enableShardsOnCoordinator": false,
    "enableGeoBackup": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 524288,
    "coordinatorVCores": 4,
    "coordinatorEnablePublicIpAccess": true,
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeStorageQuotaInMb": 524288,
    "nodeVCores": 8,
    "nodeEnablePublicIpAccess": false,
    "passwordEnabled": "enabled",
    "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,
    "enableHa": true,
    "readReplicas": [],
    "earliestRestoreTime": null,
    "privateEndpointConnections": []
  },
  "location": "westus"
}

状態コード:: 202

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

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Provisioning",
    "state": "Provisioning",
    "postgresqlVersion": "15",
    "aadAuthEnabled": "disabled",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "preferredPrimaryZone": "1",
    "nodeCount": 2,
    "enableShardsOnCoordinator": false,
    "enableGeoBackup": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 524288,
    "coordinatorVCores": 4,
    "coordinatorEnablePublicIpAccess": true,
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeStorageQuotaInMb": 524288,
    "nodeVCores": 8,
    "nodeEnablePublicIpAccess": false,
    "passwordEnabled": "enabled",
    "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,
    "enableHa": true,
    "readReplicas": [],
    "earliestRestoreTime": null,
    "privateEndpointConnections": []
  },
  "location": "westus"
}

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
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdbforpostgresql import CosmosdbForPostgresqlMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdbforpostgresql
# USAGE
    python cluster_scale_storage.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosdbForPostgresqlMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.clusters.begin_update(
        resource_group_name="TestGroup",
        cluster_name="testcluster",
        parameters={"properties": {"nodeStorageQuotaInMb": 2097152}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterScaleStorage.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmosforpostgresql_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmosforpostgresql/armcosmosforpostgresql"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterScaleStorage.json
func ExampleClustersClient_BeginUpdate_scaleUpStorage() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmosforpostgresql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClustersClient().BeginUpdate(ctx, "TestGroup", "testcluster", armcosmosforpostgresql.ClusterForUpdate{
		Properties: &armcosmosforpostgresql.ClusterPropertiesForUpdate{
			NodeStorageQuotaInMb: to.Ptr[int32](2097152),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Cluster = armcosmosforpostgresql.Cluster{
	// 	Name: to.Ptr("testcluster"),
	// 	Type: to.Ptr("Microsoft.DBforPostgreSQL/serverGroupsv2"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster"),
	// 	SystemData: &armcosmosforpostgresql.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("westus"),
	// 	Properties: &armcosmosforpostgresql.ClusterProperties{
	// 		AdministratorLogin: to.Ptr("citus"),
	// 		CitusVersion: to.Ptr("11.1"),
	// 		CoordinatorEnablePublicIPAccess: to.Ptr(true),
	// 		CoordinatorServerEdition: to.Ptr("GeneralPurpose"),
	// 		CoordinatorStorageQuotaInMb: to.Ptr[int32](2097152),
	// 		CoordinatorVCores: to.Ptr[int32](16),
	// 		EarliestRestoreTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-14T00:00:37.467Z"); return t}()),
	// 		EnableHa: to.Ptr(false),
	// 		EnableShardsOnCoordinator: to.Ptr(false),
	// 		MaintenanceWindow: &armcosmosforpostgresql.MaintenanceWindow{
	// 			CustomWindow: to.Ptr("Disabled"),
	// 			DayOfWeek: to.Ptr[int32](0),
	// 			StartHour: to.Ptr[int32](0),
	// 			StartMinute: to.Ptr[int32](0),
	// 		},
	// 		NodeCount: to.Ptr[int32](3),
	// 		NodeEnablePublicIPAccess: to.Ptr(false),
	// 		NodeServerEdition: to.Ptr("MemoryOptimized"),
	// 		NodeStorageQuotaInMb: to.Ptr[int32](2097152),
	// 		NodeVCores: to.Ptr[int32](16),
	// 		PostgresqlVersion: to.Ptr("14"),
	// 		PreferredPrimaryZone: to.Ptr("1"),
	// 		PrivateEndpointConnections: []*armcosmosforpostgresql.SimplePrivateEndpointConnection{
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ReadReplicas: []*string{
	// 		},
	// 		ServerNames: []*armcosmosforpostgresql.ServerNameItem{
	// 			{
	// 				Name: to.Ptr("testcluster1-c"),
	// 				FullyQualifiedDomainName: to.Ptr("testcluster1-c.postgres.database.azure.com"),
	// 			},
	// 			{
	// 				Name: to.Ptr("testcluster1-w0"),
	// 				FullyQualifiedDomainName: to.Ptr("testcluster1-w0.postgres.database.azure.com"),
	// 			},
	// 			{
	// 				Name: to.Ptr("testcluster1-w1"),
	// 				FullyQualifiedDomainName: to.Ptr("testcluster1-w1.postgres.database.azure.com"),
	// 			},
	// 			{
	// 				Name: to.Ptr("testcluster1-w2"),
	// 				FullyQualifiedDomainName: to.Ptr("testcluster1-w2.postgres.database.azure.com"),
	// 		}},
	// 		State: to.Ptr("Ready"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBForPostgreSQL } = require("@azure/arm-cosmosdbforpostgresql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
 *
 * @summary Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
 * x-ms-original-file: specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterScaleStorage.json
 */
async function scaleUpStorage() {
  const subscriptionId =
    process.env["COSMOSFORPOSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["COSMOSFORPOSTGRESQL_RESOURCE_GROUP"] || "TestGroup";
  const clusterName = "testcluster";
  const parameters = { nodeStorageQuotaInMb: 2097152 };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBForPostgreSQL(credential, subscriptionId);
  const result = await client.clusters.beginUpdateAndWait(
    resourceGroupName,
    clusterName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0,
      "customWindow": "Disabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 3,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "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,
    "readReplicas": [],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  },
  "location": "westus"
}

状態コード:: 202

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

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0,
      "customWindow": "Disabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 3,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "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,
    "readReplicas": [],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  },
  "location": "westus"
}

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
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdbforpostgresql import CosmosdbForPostgresqlMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdbforpostgresql
# USAGE
    python cluster_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosdbForPostgresqlMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.clusters.begin_update(
        resource_group_name="TestGroup",
        cluster_name="testcluster",
        parameters={
            "properties": {
                "administratorLoginPassword": "newpassword",
                "coordinatorVCores": 16,
                "nodeCount": 4,
                "nodeVCores": 16,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmosforpostgresql_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmosforpostgresql/armcosmosforpostgresql"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterUpdate.json
func ExampleClustersClient_BeginUpdate_updateMultipleConfigurationSettingsOfTheCluster() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmosforpostgresql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClustersClient().BeginUpdate(ctx, "TestGroup", "testcluster", armcosmosforpostgresql.ClusterForUpdate{
		Properties: &armcosmosforpostgresql.ClusterPropertiesForUpdate{
			AdministratorLoginPassword: to.Ptr("newpassword"),
			CoordinatorVCores:          to.Ptr[int32](16),
			NodeCount:                  to.Ptr[int32](4),
			NodeVCores:                 to.Ptr[int32](16),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Cluster = armcosmosforpostgresql.Cluster{
	// 	Name: to.Ptr("testcluster1"),
	// 	Type: to.Ptr("Microsoft.DBforPostgreSQL/serverGroupsv2"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1"),
	// 	SystemData: &armcosmosforpostgresql.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"additionalProp1": to.Ptr("string"),
	// 		"additionalProp2": to.Ptr("string"),
	// 		"additionalProp3": to.Ptr("string"),
	// 	},
	// 	Properties: &armcosmosforpostgresql.ClusterProperties{
	// 		AdministratorLogin: to.Ptr("citus"),
	// 		CitusVersion: to.Ptr("11.1"),
	// 		CoordinatorEnablePublicIPAccess: to.Ptr(true),
	// 		CoordinatorServerEdition: to.Ptr("GeneralPurpose"),
	// 		CoordinatorStorageQuotaInMb: to.Ptr[int32](2097152),
	// 		CoordinatorVCores: to.Ptr[int32](16),
	// 		EarliestRestoreTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-14T00:00:37.467Z"); return t}()),
	// 		EnableHa: to.Ptr(false),
	// 		EnableShardsOnCoordinator: to.Ptr(false),
	// 		MaintenanceWindow: &armcosmosforpostgresql.MaintenanceWindow{
	// 			CustomWindow: to.Ptr("Disabled"),
	// 			DayOfWeek: to.Ptr[int32](0),
	// 			StartHour: to.Ptr[int32](0),
	// 			StartMinute: to.Ptr[int32](0),
	// 		},
	// 		NodeCount: to.Ptr[int32](4),
	// 		NodeEnablePublicIPAccess: to.Ptr(false),
	// 		NodeServerEdition: to.Ptr("MemoryOptimized"),
	// 		NodeStorageQuotaInMb: to.Ptr[int32](2097152),
	// 		NodeVCores: to.Ptr[int32](16),
	// 		PostgresqlVersion: to.Ptr("14"),
	// 		PreferredPrimaryZone: to.Ptr("1"),
	// 		PrivateEndpointConnections: []*armcosmosforpostgresql.SimplePrivateEndpointConnection{
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ReadReplicas: []*string{
	// 			to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSQL/serverGroupsv2/testreadreplica-01"),
	// 			to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSQL/serverGroupsv2/testreadreplica-02")},
	// 			ServerNames: []*armcosmosforpostgresql.ServerNameItem{
	// 				{
	// 					Name: to.Ptr("testcluster1-c"),
	// 					FullyQualifiedDomainName: to.Ptr("testcluster1-c.postgres.database.azure.com"),
	// 				},
	// 				{
	// 					Name: to.Ptr("testcluster1-w0"),
	// 					FullyQualifiedDomainName: to.Ptr("testcluster1-w0.postgres.database.azure.com"),
	// 				},
	// 				{
	// 					Name: to.Ptr("testcluster1-w1"),
	// 					FullyQualifiedDomainName: to.Ptr("testcluster1-w1.postgres.database.azure.com"),
	// 				},
	// 				{
	// 					Name: to.Ptr("testcluster1-w2"),
	// 					FullyQualifiedDomainName: to.Ptr("testcluster1-w2.postgres.database.azure.com"),
	// 				},
	// 				{
	// 					Name: to.Ptr("testcluster1-w3"),
	// 					FullyQualifiedDomainName: to.Ptr("testcluster1-w2.postgres.database.azure.com"),
	// 			}},
	// 			State: to.Ptr("Ready"),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBForPostgreSQL } = require("@azure/arm-cosmosdbforpostgresql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
 *
 * @summary Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
 * x-ms-original-file: specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterUpdate.json
 */
async function updateMultipleConfigurationSettingsOfTheCluster() {
  const subscriptionId =
    process.env["COSMOSFORPOSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["COSMOSFORPOSTGRESQL_RESOURCE_GROUP"] || "TestGroup";
  const clusterName = "testcluster";
  const parameters = {
    administratorLoginPassword: "newpassword",
    coordinatorVCores: 16,
    nodeCount: 4,
    nodeVCores: 16,
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBForPostgreSQL(credential, subscriptionId);
  const result = await client.clusters.beginUpdateAndWait(
    resourceGroupName,
    clusterName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1",
  "name": "testcluster1",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "tags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "location": "westus",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0,
      "customWindow": "Disabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 4,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "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,
    "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"
    ],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  }
}

状態コード:: 202

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

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1",
  "name": "testcluster1",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "tags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "location": "westus",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0,
      "customWindow": "Disabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 4,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "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,
    "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"
    ],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  }
}

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": {
      "dayOfWeek": 0,
      "startHour": 8,
      "startMinute": 0,
      "customWindow": "Enabled"
    }
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdbforpostgresql import CosmosdbForPostgresqlMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdbforpostgresql
# USAGE
    python cluster_update_maintenance_window.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosdbForPostgresqlMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.clusters.begin_update(
        resource_group_name="TestGroup",
        cluster_name="testcluster",
        parameters={
            "properties": {
                "maintenanceWindow": {"customWindow": "Enabled", "dayOfWeek": 0, "startHour": 8, "startMinute": 0}
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterUpdateMaintenanceWindow.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmosforpostgresql_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmosforpostgresql/armcosmosforpostgresql"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterUpdateMaintenanceWindow.json
func ExampleClustersClient_BeginUpdate_updateOrDefineMaintenanceWindow() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmosforpostgresql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClustersClient().BeginUpdate(ctx, "TestGroup", "testcluster", armcosmosforpostgresql.ClusterForUpdate{
		Properties: &armcosmosforpostgresql.ClusterPropertiesForUpdate{
			MaintenanceWindow: &armcosmosforpostgresql.MaintenanceWindow{
				CustomWindow: to.Ptr("Enabled"),
				DayOfWeek:    to.Ptr[int32](0),
				StartHour:    to.Ptr[int32](8),
				StartMinute:  to.Ptr[int32](0),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Cluster = armcosmosforpostgresql.Cluster{
	// 	Name: to.Ptr("testcluster"),
	// 	Type: to.Ptr("Microsoft.DBforPostgreSQL/serverGroupsv2"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster"),
	// 	SystemData: &armcosmosforpostgresql.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("westus"),
	// 	Properties: &armcosmosforpostgresql.ClusterProperties{
	// 		AdministratorLogin: to.Ptr("citus"),
	// 		CitusVersion: to.Ptr("11.1"),
	// 		CoordinatorEnablePublicIPAccess: to.Ptr(true),
	// 		CoordinatorServerEdition: to.Ptr("GeneralPurpose"),
	// 		CoordinatorStorageQuotaInMb: to.Ptr[int32](2097152),
	// 		CoordinatorVCores: to.Ptr[int32](16),
	// 		EarliestRestoreTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-14T00:00:37.467Z"); return t}()),
	// 		EnableHa: to.Ptr(false),
	// 		EnableShardsOnCoordinator: to.Ptr(false),
	// 		MaintenanceWindow: &armcosmosforpostgresql.MaintenanceWindow{
	// 			CustomWindow: to.Ptr("Enabled"),
	// 			DayOfWeek: to.Ptr[int32](0),
	// 			StartHour: to.Ptr[int32](8),
	// 			StartMinute: to.Ptr[int32](0),
	// 		},
	// 		NodeCount: to.Ptr[int32](2),
	// 		NodeEnablePublicIPAccess: to.Ptr(false),
	// 		NodeServerEdition: to.Ptr("MemoryOptimized"),
	// 		NodeStorageQuotaInMb: to.Ptr[int32](2097152),
	// 		NodeVCores: to.Ptr[int32](16),
	// 		PostgresqlVersion: to.Ptr("14"),
	// 		PreferredPrimaryZone: to.Ptr("1"),
	// 		PrivateEndpointConnections: []*armcosmosforpostgresql.SimplePrivateEndpointConnection{
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ReadReplicas: []*string{
	// 		},
	// 		ServerNames: []*armcosmosforpostgresql.ServerNameItem{
	// 			{
	// 				Name: to.Ptr("testcluster1-c"),
	// 				FullyQualifiedDomainName: to.Ptr("testcluster1-c.postgres.database.azure.com"),
	// 			},
	// 			{
	// 				Name: to.Ptr("testcluster1-w0"),
	// 				FullyQualifiedDomainName: to.Ptr("testcluster1-w0.postgres.database.azure.com"),
	// 			},
	// 			{
	// 				Name: to.Ptr("testcluster1-w1"),
	// 				FullyQualifiedDomainName: to.Ptr("testcluster1-w1.postgres.database.azure.com"),
	// 		}},
	// 		State: to.Ptr("Ready"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBForPostgreSQL } = require("@azure/arm-cosmosdbforpostgresql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
 *
 * @summary Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
 * x-ms-original-file: specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ClusterUpdateMaintenanceWindow.json
 */
async function updateOrDefineMaintenanceWindow() {
  const subscriptionId =
    process.env["COSMOSFORPOSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["COSMOSFORPOSTGRESQL_RESOURCE_GROUP"] || "TestGroup";
  const clusterName = "testcluster";
  const parameters = {
    maintenanceWindow: {
      customWindow: "Enabled",
      dayOfWeek: 0,
      startHour: 8,
      startMinute: 0,
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBForPostgreSQL(credential, subscriptionId);
  const result = await client.clusters.beginUpdateAndWait(
    resourceGroupName,
    clusterName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 8,
      "startMinute": 0,
      "customWindow": "Enabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 2,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "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,
    "readReplicas": [],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  },
  "location": "westus"
}

状態コード:: 202

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

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 8,
      "startMinute": 0,
      "customWindow": "Enabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 2,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "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,
    "readReplicas": [],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  },
  "location": "westus"
}

定義

名前	説明
AadEnabledEnum	クラスターが AAD 認証を使用して作成されたかどうかを示します。
ActiveDirectoryAuth
AuthConfig	クラスターの認証構成。
Cluster	クラスターを表します。
ClusterForUpdate	更新用のクラスターを表します。
createdByType	リソースを作成した ID の種類。
DataEncryption	クラスターのデータ暗号化プロパティ。
DataEncryptionType
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
IdentityProperties	クラスターの ID について説明します。
IdentityType
MaintenanceWindow	定期的なクラスター更新プログラムの設定をスケジュールします。
PasswordAuth
PasswordEnabledEnum	クラスターがパスワードで作成されたか、AAD 認証を使用して作成されたかを示します。
PrivateEndpointProperty	プライベートエンドポイントのリソース ID を表すプロパティ。
PrivateEndpointServiceConnectionStatus	プライベートエンドポイント接続の状態。
PrivateLinkServiceConnectionState	サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
ServerNameItem	サーバーの名前オブジェクト。
SimplePrivateEndpointConnection	プライベートエンドポイント接続。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserAssignedIdentity	ユーザー割り当て ID プロパティ

AadEnabledEnum

クラスターが AAD 認証を使用して作成されたかどうかを示します。

名前	型	説明
disabled	string
enabled	string

ActiveDirectoryAuth

名前	型	説明
disabled	string
enabled	string

AuthConfig

クラスターの認証構成。

名前	型	説明
activeDirectoryAuth	ActiveDirectoryAuth
passwordAuth	PasswordAuth

Cluster

クラスターを表します。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	IdentityProperties	クラスターの ID について説明します。
location	string	リソースが保存されている地理的な場所
name	string	リソースの名前
properties.aadAuthEnabled	AadEnabledEnum	クラスターが AAD 認証を使用して作成されたかどうかを示します。
properties.administratorLogin	string	クラスター内のサーバーの管理者のログイン名。
properties.administratorLoginPassword	string	管理者ログインのパスワード。作成に必要です。
properties.authConfig	AuthConfig	クラスターの認証構成。
properties.citusVersion	string	すべてのクラスターサーバー上の Citus 拡張機能バージョン。
properties.coordinatorEnablePublicIpAccess	boolean	コーディネーターでパブリックアクセスが有効になっている場合。
properties.coordinatorServerEdition	string	コーディネーターサーバーのエディション (既定値: GeneralPurpose)。作成に必要です。
properties.coordinatorStorageQuotaInMb	integer	サーバーのストレージ (MB 単位)。作成に必要です。詳細については、「 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute 」を参照してください。
properties.coordinatorVCores	integer	サーバーの仮想コア数 (最大: 96)。作成に必要です。詳細については、「 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute 」を参照してください。
properties.dataEncryption	DataEncryption	クラスターのデータ暗号化プロパティ。
properties.databaseName	string	クラスターのデータベース名。クラスターごとに 1 つのデータベースのみがサポートされます。
properties.earliestRestoreTime	string	クラスターの最も早い復元ポイント時間 (ISO8601形式)。
properties.enableGeoBackup	boolean	クラスターのバックアップが、クラスターのリージョンに格納されているバックアップのコピーに加えて、別の Azure リージョンに格納されている場合。クラスターの作成時にのみ有効になります。
properties.enableHa	boolean	高可用性 (HA) がクラスターに対して有効になっているか、有効になっていない場合。
properties.enableShardsOnCoordinator	boolean	分散テーブルがコーディネーターに配置されているかどうか。単一ノードクラスターでは、"true" に設定する必要があります。値が変更された後にシャードの再調整が必要です。
properties.maintenanceWindow	MaintenanceWindow	クラスターのメンテナンス期間。
properties.nodeCount	integer	クラスターのワーカーノード数。ノード数が 0 の場合は、そのノードに分散テーブルを作成する機能を持つ単一のノード構成を表します。 2 つ以上のワーカーノードがマルチノード構成を表します。ノード数の値を 1 にすることはできません。作成に必要です。
properties.nodeEnablePublicIpAccess	boolean	ワーカーノードでパブリックアクセスが有効になっている場合。
properties.nodeServerEdition	string	ノードサーバーのエディション (既定値: MemoryOptimized)。
properties.nodeStorageQuotaInMb	integer	各ワーカーノードのストレージ (MB 単位)。詳細については、「 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute 」を参照してください。
properties.nodeVCores	integer	各ワーカーノードの仮想コア単位のコンピューティング (最大: 104)。詳細については、「 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute 」を参照してください。
properties.passwordEnabled	PasswordEnabledEnum	クラスターがパスワードで作成されたか、AAD 認証を使用して作成されたかを示します。
properties.pointInTimeUTC	string	クラスターの復元の UTC (ISO8601形式) の日付と時刻。
properties.postgresqlVersion	string	すべてのクラスターサーバー上の PostgreSQL のメジャーバージョン。
properties.preferredPrimaryZone	string	すべてのクラスターサーバーに推奨されるプライマリ可用性ゾーン (AZ)。
properties.privateEndpointConnections	SimplePrivateEndpointConnection[]	クラスターのプライベートエンドポイント接続。
properties.provisioningState	string	クラスターのプロビジョニング状態
properties.readReplicas	string[]	読み取りレプリカクラスターの配列。
properties.serverNames	ServerNameItem[]	クラスター内のサーバー名の一覧
properties.sourceLocation	string	読み取りレプリカクラスターのソースクラスターの Azure リージョン。
properties.sourceResourceId	string	読み取りレプリカクラスターのソースクラスターのリソース ID。
properties.state	string	ユーザーに表示されるクラスター/サーバーの状態。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースタグ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ClusterForUpdate

更新用のクラスターを表します。

名前	型	説明
identity	IdentityProperties	クラスターの ID について説明します。
properties.administratorLoginPassword	string	管理者ログインのパスワード。各クラスターは、'citus' と呼ばれる定義済みの管理ロールを使用して作成されます。
properties.citusVersion	string	すべてのクラスターサーバー上の Citus 拡張機能バージョン。
properties.coordinatorEnablePublicIpAccess	boolean	コーディネーターでパブリックアクセスが有効になっている場合。
properties.coordinatorServerEdition	string	コーディネーターのエディション (既定値: GeneralPurpose)。
properties.coordinatorStorageQuotaInMb	integer	コーディネーターのストレージ (MB 単位)。
properties.coordinatorVCores	integer	コーディネーターの仮想コア数 (最大: 96)。
properties.enableHa	boolean	高可用性 (HA) がクラスターに対して有効になっているか、有効になっていない場合。
properties.enableShardsOnCoordinator	boolean	分散テーブルがコーディネーターに配置されているかどうか。単一ノードクラスターでは、"true" に設定する必要があります。値が変更された後にシャードの再調整が必要です。
properties.maintenanceWindow	MaintenanceWindow	クラスターのメンテナンス期間。
properties.nodeCount	integer	クラスターのワーカーノード数。ノード数が 0 の場合は、そのノードに分散テーブルを作成する機能を持つ単一のノード構成を表します。 2 つ以上のワーカーノードがマルチノード構成を表します。ノード数の値を 1 にすることはできません。
properties.nodeEnablePublicIpAccess	boolean	ワーカーノードでパブリックアクセスが有効になっている場合。
properties.nodeServerEdition	string	ノードのエディション (既定値: MemoryOptimized)。
properties.nodeStorageQuotaInMb	integer	各ワーカーノードのストレージ (MB 単位)。
properties.nodeVCores	integer	各ワーカーノードの仮想コア単位のコンピューティング (最大: 104)。
properties.postgresqlVersion	string	すべてのクラスターサーバー上の PostgreSQL のメジャーバージョン。
properties.preferredPrimaryZone	string	すべてのクラスターサーバーに推奨されるプライマリ可用性ゾーン (AZ)。
tags	object	キーと値のペアの形式による、アプリケーション固有のメタデータ。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

DataEncryption

クラスターのデータ暗号化プロパティ。

名前	型	説明
primaryKeyUri	string	プライマリサーバーのデータ暗号化のための keyvault のキーの URI。
primaryUserAssignedIdentityId	string	プライマリサーバーのデータ暗号化に使用するユーザー割り当て ID のリソース ID。
type	DataEncryptionType

DataEncryptionType

名前	型	説明
AzureKeyVault	string
SystemAssigned	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

IdentityProperties

クラスターの ID について説明します。

名前	型	説明
type	IdentityType
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned ID リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリキーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。ディクショナリ値には、要求で空のオブジェクト ({}) を指定できます。

IdentityType

名前	型	説明
SystemAssigned	string
UserAssigned	string

MaintenanceWindow

定期的なクラスター更新プログラムの設定をスケジュールします。

名前	型	説明
customWindow	string	カスタムメンテナンス期間が有効かどうかを示します。
dayOfWeek	integer	メンテナンス期間に推奨される曜日。
startHour	integer	メンテナンス期間の任意の曜日内の開始時間。
startMinute	integer	メンテナンス期間の開始時刻内の開始分。

PasswordAuth

名前	型	説明
disabled	string
enabled	string

PasswordEnabledEnum

クラスターがパスワードで作成されたか、AAD 認証を使用して作成されたかを示します。

名前	型	説明
disabled	string
enabled	string

PrivateEndpointProperty

プライベートエンドポイントのリソース ID を表すプロパティ。

名前	型	説明
id	string	プライベートエンドポイントのリソース ID。

PrivateEndpointServiceConnectionStatus

プライベートエンドポイント接続の状態。

名前	型	説明
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。

名前	型	説明
actionsRequired	string	サービスプロバイダーの変更にコンシューマーに対する更新が必要かどうかを示すメッセージ。
description	string	接続の承認/拒否の理由。
status	PrivateEndpointServiceConnectionStatus	サービスの所有者によって接続が承認/拒否/削除されたかどうかを示します。

ServerNameItem

サーバーの名前オブジェクト。

名前	型	説明
fullyQualifiedDomainName	string	サーバーの完全修飾ドメイン名。
name	string	サーバーの名前。

SimplePrivateEndpointConnection

プライベートエンドポイント接続。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.groupIds	string[]	プライベートエンドポイント接続のグループ ID。
properties.privateEndpoint	PrivateEndpointProperty	接続が属するプライベートエンドポイント。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UserAssignedIdentity

ユーザー割り当て ID プロパティ

名前	型	説明
clientId	string	割り当てられた ID のクライアント ID。
principalId	string	割り当てられた ID のプリンシパル ID。

次の方法で共有

Clusters - Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

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

要求のサンプル

応答のサンプル

定義

AadEnabledEnum

ActiveDirectoryAuth

AuthConfig

Cluster

ClusterForUpdate

createdByType

DataEncryption

DataEncryptionType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityProperties

IdentityType

MaintenanceWindow

PasswordAuth

PasswordEnabledEnum

PrivateEndpointProperty

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

ServerNameItem

SimplePrivateEndpointConnection

systemData

UserAssignedIdentity

その他のリソース