Clusters - Update

Dienst:: Cosmos DB for PostgreSQL

API-Version:: 2023-03-02-preview

Aktualisiert einen vorhandenen Cluster. Der Anforderungstext kann eine oder mehrere Eigenschaften aus der Clusterdefinition enthalten.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
clusterName	path	True	string minLength: 3 maxLength: 40 pattern: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?	Der Name des Clusters.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
identity	IdentityProperties	Beschreibt die Identität des Clusters.
properties.administratorLoginPassword	string (password)	Das Kennwort der Administratoranmeldung. Jeder Cluster wird mit vordefinierter administrativer Rolle namens "citus" erstellt.
properties.citusVersion	string	Die Citus-Erweiterungsversion auf allen Clusterservern.
properties.coordinatorEnablePublicIpAccess	boolean	Wenn der öffentliche Zugriff für den Koordinator aktiviert ist.
properties.coordinatorServerEdition	string	Die Ausgabe des Koordinators (Standard: GeneralPurpose).
properties.coordinatorStorageQuotaInMb	integer (int32)	Die Speicherung des Koordinators in MB.
properties.coordinatorVCores	integer (int32)	Die vCores-Anzahl des Koordinators (max. 96).
properties.enableHa	boolean	Wenn hohe Verfügbarkeit (HA) für den Cluster aktiviert ist oder nicht.
properties.enableShardsOnCoordinator	boolean	Wenn verteilte Tabellen auf Koordinator platziert werden oder nicht. Sollte auf "true" für einzelne Knotencluster festgelegt werden. Erfordert eine Shard rebalancing, nachdem der Wert geändert wurde.
properties.maintenanceWindow	MaintenanceWindow	Wartungsfenster eines Clusters.
properties.nodeCount	integer (int32)	Anzahl der Arbeitsknoten des Clusters. Wenn die Knotenanzahl 0 ist, stellt sie eine Konfiguration mit einem einzelnen Knoten dar, mit der die Möglichkeit besteht, verteilte Tabellen auf diesem Knoten zu erstellen. 2 oder mehr Workerknoten stellen die Konfiguration mit mehreren Knoten dar. Der Knotenanzahlswert darf nicht 1 sein.
properties.nodeServerEdition	string	Die Edition eines Knotens (Standard: MemoryOptimized).
properties.nodeStorageQuotaInMb	integer (int32)	Der Speicher in MB auf jedem Arbeitsknoten.
properties.nodeVCores	integer (int32)	Die Berechnung in vCores auf jedem Arbeitsknoten (max. 104).
properties.postgresqlVersion	string	Die haupt-PostgreSQL-Version auf allen Clusterservern.
properties.preferredPrimaryZone	string	Bevorzugte primäre Verfügbarkeitszone (AZ) für alle Clusterserver.
tags	object	Anwendungsspezifische Metadaten in Form von Schlüsselwertpaaren.

Antworten

Name	Typ	Beschreibung
200 OK	Cluster	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
202 Accepted	Cluster	Die Anforderung wurde zur Verarbeitung angenommen, die Verarbeitung ist jedoch noch nicht abgeschlossen. Header Azure-AsyncOperation: string Location: string
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

Cluster

Der Azure-Vorgang wurde erfolgreich abgeschlossen.

202 Accepted

Cluster

Die Anforderung wurde zur Verarbeitung angenommen, die Verarbeitung ist jedoch noch nicht abgeschlossen.

Header

Azure-AsyncOperation: string
Location: string

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

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


import com.azure.resourcemanager.cosmosdbforpostgresql.models.Cluster;

/**
 * Samples for Clusters Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2023-03-02-preview/ClusterScaleCompute.json
     */
    /**
     * Sample code: Scale compute up or down.
     * 
     * @param manager Entry point to CosmosDBForPostgreSqlManager.
     */
    public static void
        scaleComputeUpOrDown(com.azure.resourcemanager.cosmosdbforpostgresql.CosmosDBForPostgreSqlManager manager) {
        Cluster resource = manager.clusters()
            .getByResourceGroupWithResponse("TestGroup", "testcluster", com.azure.core.util.Context.NONE).getValue();
        resource.update().withNodeVCores(16).apply();
    }
}

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

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 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

{
  "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

Beispielanforderung

HTTP
Java

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


import com.azure.resourcemanager.cosmosdbforpostgresql.models.Cluster;

/**
 * Samples for Clusters Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2023-03-02-preview/ClusterAddNode.json
     */
    /**
     * Sample code: Scale out: Add new worker nodes.
     * 
     * @param manager Entry point to CosmosDBForPostgreSqlManager.
     */
    public static void scaleOutAddNewWorkerNodes(
        com.azure.resourcemanager.cosmosdbforpostgresql.CosmosDBForPostgreSqlManager manager) {
        Cluster resource = manager.clusters()
            .getByResourceGroupWithResponse("TestGroup", "testcluster", com.azure.core.util.Context.NONE).getValue();
        resource.update().withNodeCount(2).apply();
    }
}

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

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 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

{
  "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

Beispielanforderung

HTTP
Java

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


import com.azure.resourcemanager.cosmosdbforpostgresql.models.Cluster;

/**
 * Samples for Clusters Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2023-03-02-preview/ClusterScaleStorage.json
     */
    /**
     * Sample code: Scale up storage.
     * 
     * @param manager Entry point to CosmosDBForPostgreSqlManager.
     */
    public static void
        scaleUpStorage(com.azure.resourcemanager.cosmosdbforpostgresql.CosmosDBForPostgreSqlManager manager) {
        Cluster resource = manager.clusters()
            .getByResourceGroupWithResponse("TestGroup", "testcluster", com.azure.core.util.Context.NONE).getValue();
        resource.update().withNodeStorageQuotaInMb(2097152).apply();
    }
}

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

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 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

{
  "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

Beispielanforderung

HTTP
Java

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


import com.azure.resourcemanager.cosmosdbforpostgresql.models.Cluster;

/**
 * Samples for Clusters Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2023-03-02-preview/ClusterUpdate.json
     */
    /**
     * Sample code: Update multiple configuration settings of the cluster.
     * 
     * @param manager Entry point to CosmosDBForPostgreSqlManager.
     */
    public static void updateMultipleConfigurationSettingsOfTheCluster(
        com.azure.resourcemanager.cosmosdbforpostgresql.CosmosDBForPostgreSqlManager manager) {
        Cluster resource = manager.clusters()
            .getByResourceGroupWithResponse("TestGroup", "testcluster", com.azure.core.util.Context.NONE).getValue();
        resource.update().withAdministratorLoginPassword("newpassword").withCoordinatorVCores(16).withNodeCount(4)
            .withNodeVCores(16).apply();
    }
}

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

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 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

{
  "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

Beispielanforderung

HTTP
Java

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


import com.azure.resourcemanager.cosmosdbforpostgresql.models.Cluster;
import com.azure.resourcemanager.cosmosdbforpostgresql.models.MaintenanceWindow;

/**
 * Samples for Clusters Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2023-03-02-preview/ClusterUpdateMaintenanceWindow.json
     */
    /**
     * Sample code: Update or define maintenance window.
     * 
     * @param manager Entry point to CosmosDBForPostgreSqlManager.
     */
    public static void updateOrDefineMaintenanceWindow(
        com.azure.resourcemanager.cosmosdbforpostgresql.CosmosDBForPostgreSqlManager manager) {
        Cluster resource = manager.clusters()
            .getByResourceGroupWithResponse("TestGroup", "testcluster", com.azure.core.util.Context.NONE).getValue();
        resource.update().withMaintenanceWindow(
            new MaintenanceWindow().withCustomWindow("Enabled").withStartHour(8).withStartMinute(0).withDayOfWeek(0))
            .apply();
    }
}

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

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 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

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

Definitionen

Name	Beschreibung
AadEnabledEnum	Gibt an, ob der Cluster mithilfe der AAD-Authentifizierung erstellt wurde.
ActiveDirectoryAuth
AuthConfig	Authentifizierungskonfiguration eines Clusters.
Cluster	Stellt einen Cluster dar.
ClusterForUpdate	Stellt einen Cluster für die Aktualisierung dar.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DataEncryption	Die Datenverschlüsselungseigenschaften eines Clusters.
DataEncryptionType
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
IdentityProperties	Beschreibt die Identität des Clusters.
IdentityType
MaintenanceWindow	Planen Sie Einstellungen für regelmäßige Clusterupdates.
PasswordAuth
PasswordEnabledEnum	Gibt an, ob der Cluster mit einem Kennwort oder mit AAD-Authentifizierung erstellt wurde.
PrivateEndpointProperty	Eigenschaft, die die Ressourcen-ID des privaten Endpunkts darstellt.
PrivateEndpointServiceConnectionStatus	Der Status der privaten Endpunktverbindung.
PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
ServerNameItem	Das Name-Objekt für einen Server.
SimplePrivateEndpointConnection	Eine private Endpunktverbindung.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserAssignedIdentity	Benutzer zugewiesene Identitätseigenschaften

AadEnabledEnum

Enumeration

Gibt an, ob der Cluster mithilfe der AAD-Authentifizierung erstellt wurde.

Wert	Beschreibung
enabled
disabled

ActiveDirectoryAuth

Enumeration

Wert	Beschreibung
enabled
disabled

AuthConfig

Objekt

Authentifizierungskonfiguration eines Clusters.

Name	Typ	Beschreibung
activeDirectoryAuth	ActiveDirectoryAuth
passwordAuth	PasswordAuth

Cluster

Objekt

Stellt einen Cluster dar.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	IdentityProperties	Beschreibt die Identität des Clusters.
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.aadAuthEnabled	AadEnabledEnum	Gibt an, ob der Cluster mithilfe der AAD-Authentifizierung erstellt wurde.
properties.administratorLogin	string	Der Anmeldename des Administrators der Server im Cluster.
properties.administratorLoginPassword	string (password)	Das Kennwort der Administratoranmeldung. Erforderlich für die Erstellung.
properties.authConfig	AuthConfig	Authentifizierungskonfiguration eines Clusters.
properties.citusVersion	string	Die Citus-Erweiterungsversion auf allen Clusterservern.
properties.coordinatorEnablePublicIpAccess	boolean	Wenn der öffentliche Zugriff für den Koordinator aktiviert ist.
properties.coordinatorServerEdition	string	Die Edition eines Koordinatorservers (Standard: GeneralPurpose). Erforderlich für die Erstellung.
properties.coordinatorStorageQuotaInMb	integer (int32)	Der Speicher eines Servers in MB. Erforderlich für die Erstellung. Weitere Informationen finden Sie unter https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.
properties.coordinatorVCores	integer (int32)	Die vCores-Anzahl eines Servers (max. 96). Erforderlich für die Erstellung. Weitere Informationen finden Sie unter https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.
properties.dataEncryption	DataEncryption	Die Datenverschlüsselungseigenschaften eines Clusters.
properties.databaseName	string	Der Datenbankname des Clusters. Es wird nur eine Datenbank pro Cluster unterstützt.
properties.earliestRestoreTime	string (date-time)	Die früheste Wiederherstellungspunktzeit (ISO8601 Format) für den Cluster.
properties.enableGeoBackup	boolean	Wenn die Clustersicherung zusätzlich zur Kopie der in der Region des Clusters gespeicherten Sicherung in einer anderen Azure-Region gespeichert ist. Aktiviert nur zum Zeitpunkt der Clustererstellung.
properties.enableHa	boolean	Wenn hohe Verfügbarkeit (HA) für den Cluster aktiviert ist oder nicht.
properties.enableShardsOnCoordinator	boolean	Wenn verteilte Tabellen auf Koordinator platziert werden oder nicht. Sollte auf "true" für einzelne Knotencluster festgelegt werden. Erfordert eine Shard rebalancing, nachdem der Wert geändert wurde.
properties.maintenanceWindow	MaintenanceWindow	Wartungsfenster eines Clusters.
properties.nodeCount	integer (int32)	Anzahl der Arbeitsknoten des Clusters. Wenn die Knotenanzahl 0 ist, stellt sie eine Konfiguration mit einem einzelnen Knoten dar, mit der die Möglichkeit besteht, verteilte Tabellen auf diesem Knoten zu erstellen. 2 oder mehr Workerknoten stellen die Konfiguration mit mehreren Knoten dar. Der Knotenanzahlswert darf nicht 1 sein. Erforderlich für die Erstellung.
properties.nodeEnablePublicIpAccess	boolean	Wenn der öffentliche Zugriff auf Arbeitsknoten aktiviert ist.
properties.nodeServerEdition	string	Die Edition eines Knotenservers (Standard: MemoryOptimized).
properties.nodeStorageQuotaInMb	integer (int32)	Der Speicher in MB auf jedem Arbeitsknoten. Weitere Informationen finden Sie unter https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.
properties.nodeVCores	integer (int32)	Die Berechnung in vCores auf jedem Arbeitsknoten (max. 104). Weitere Informationen finden Sie unter https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.
properties.passwordEnabled	PasswordEnabledEnum	Gibt an, ob der Cluster mit einem Kennwort oder mit AAD-Authentifizierung erstellt wurde.
properties.pointInTimeUTC	string (date-time)	Datum und Uhrzeit in UTC (ISO8601 Format) für die Clusterwiederherstellung.
properties.postgresqlVersion	string	Die haupt-PostgreSQL-Version auf allen Clusterservern.
properties.preferredPrimaryZone	string	Bevorzugte primäre Verfügbarkeitszone (AZ) für alle Clusterserver.
properties.privateEndpointConnections	SimplePrivateEndpointConnection[]	Die privaten Endpunktverbindungen für einen Cluster.
properties.provisioningState	string	Bereitstellungsstatus des Clusters
properties.readReplicas	string[]	Das Array von Lesereplikatclustern.
properties.serverNames	ServerNameItem[]	Die Liste der Servernamen im Cluster
properties.sourceLocation	string	Die Azure-Region des Quellclusters zum Lesen von Replikatclustern.
properties.sourceResourceId	string	Die Ressourcen-ID des Quellclusters für Lesereplikatcluster.
properties.state	string	Ein Status eines Clusters/Servers, der für den Benutzer sichtbar ist.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ClusterForUpdate

Objekt

Stellt einen Cluster für die Aktualisierung dar.

Name	Typ	Beschreibung
identity	IdentityProperties	Beschreibt die Identität des Clusters.
properties.administratorLoginPassword	string (password)	Das Kennwort der Administratoranmeldung. Jeder Cluster wird mit vordefinierter administrativer Rolle namens "citus" erstellt.
properties.citusVersion	string	Die Citus-Erweiterungsversion auf allen Clusterservern.
properties.coordinatorEnablePublicIpAccess	boolean	Wenn der öffentliche Zugriff für den Koordinator aktiviert ist.
properties.coordinatorServerEdition	string	Die Ausgabe des Koordinators (Standard: GeneralPurpose).
properties.coordinatorStorageQuotaInMb	integer (int32)	Die Speicherung des Koordinators in MB.
properties.coordinatorVCores	integer (int32)	Die vCores-Anzahl des Koordinators (max. 96).
properties.enableHa	boolean	Wenn hohe Verfügbarkeit (HA) für den Cluster aktiviert ist oder nicht.
properties.enableShardsOnCoordinator	boolean	Wenn verteilte Tabellen auf Koordinator platziert werden oder nicht. Sollte auf "true" für einzelne Knotencluster festgelegt werden. Erfordert eine Shard rebalancing, nachdem der Wert geändert wurde.
properties.maintenanceWindow	MaintenanceWindow	Wartungsfenster eines Clusters.
properties.nodeCount	integer (int32)	Anzahl der Arbeitsknoten des Clusters. Wenn die Knotenanzahl 0 ist, stellt sie eine Konfiguration mit einem einzelnen Knoten dar, mit der die Möglichkeit besteht, verteilte Tabellen auf diesem Knoten zu erstellen. 2 oder mehr Workerknoten stellen die Konfiguration mit mehreren Knoten dar. Der Knotenanzahlswert darf nicht 1 sein.
properties.nodeEnablePublicIpAccess	boolean	Wenn der öffentliche Zugriff auf Arbeitsknoten aktiviert ist.
properties.nodeServerEdition	string	Die Edition eines Knotens (Standard: MemoryOptimized).
properties.nodeStorageQuotaInMb	integer (int32)	Der Speicher in MB auf jedem Arbeitsknoten.
properties.nodeVCores	integer (int32)	Die Berechnung in vCores auf jedem Arbeitsknoten (max. 104).
properties.postgresqlVersion	string	Die haupt-PostgreSQL-Version auf allen Clusterservern.
properties.preferredPrimaryZone	string	Bevorzugte primäre Verfügbarkeitszone (AZ) für alle Clusterserver.
tags	object	Anwendungsspezifische Metadaten in Form von Schlüsselwertpaaren.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DataEncryption

Objekt

Die Datenverschlüsselungseigenschaften eines Clusters.

Name	Typ	Beschreibung
primaryKeyUri	string	URI für den Schlüssel in keyvault für die Datenverschlüsselung des primären Servers.
primaryUserAssignedIdentityId	string	Ressourcen-ID für die vom Benutzer zugewiesene Identität, die für die Datenverschlüsselung des primären Servers verwendet werden soll.
type	DataEncryptionType

DataEncryptionType

Enumeration

Wert	Beschreibung
AzureKeyVault
SystemAssigned

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IdentityProperties

Objekt

Beschreibt die Identität des Clusters.

Name	Typ	Beschreibung
type	IdentityType
userAssignedIdentities	<string, UserAssignedIdentity>	Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein.

IdentityType

Enumeration

Wert	Beschreibung
UserAssigned
SystemAssigned

MaintenanceWindow

Objekt

Planen Sie Einstellungen für regelmäßige Clusterupdates.

Name	Typ	Beschreibung
customWindow	string	Gibt an, ob das benutzerdefinierte Wartungsfenster aktiviert ist oder nicht.
dayOfWeek	integer (int32)	Bevorzugter Wochentag für Wartungsfenster.
startHour	integer (int32)	Startstunde innerhalb des bevorzugten Wochentags für wartungsfenster.
startMinute	integer (int32)	Startminute innerhalb der Startstunde für Wartungsfenster.

PasswordAuth

Enumeration

Wert	Beschreibung
enabled
disabled

PasswordEnabledEnum

Enumeration

Gibt an, ob der Cluster mit einem Kennwort oder mit AAD-Authentifizierung erstellt wurde.

Wert	Beschreibung
enabled
disabled

PrivateEndpointProperty

Objekt

Eigenschaft, die die Ressourcen-ID des privaten Endpunkts darstellt.

Name	Typ	Beschreibung
id	string	Ressourcen-ID des privaten Endpunkts.

PrivateEndpointServiceConnectionStatus

Enumeration

Der Status der privaten Endpunktverbindung.

Wert	Beschreibung
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Objekt

Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.

Name	Typ	Beschreibung
actionsRequired	string	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern.
description	string	Der Grund für die Genehmigung/Ablehnung der Verbindung.
status	PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde.

ServerNameItem

Objekt

Das Name-Objekt für einen Server.

Name	Typ	Beschreibung
fullyQualifiedDomainName	string	Der vollqualifizierte Domänenname eines Servers.
name	string	Der Name eines Servers.

SimplePrivateEndpointConnection

Objekt

Eine private Endpunktverbindung.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.groupIds	string[]	Gruppen-IDs der privaten Endpunktverbindung.
properties.privateEndpoint	PrivateEndpointProperty	Privater Endpunkt, zu dem die Verbindung gehört.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserAssignedIdentity

Objekt

Benutzer zugewiesene Identitätseigenschaften

Name	Typ	Beschreibung
clientId	string (uuid)	Die Client-ID der zugewiesenen Identität.
principalId	string (uuid)	Die Prinzipal-ID der zugewiesenen Identität.

Freigeben über

Clusters - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Scale compute up or down

Beispielanforderung

Beispiel für eine Antwort

Scale out: Add new worker nodes

Beispielanforderung

Beispiel für eine Antwort

Scale up storage

Beispielanforderung

Beispiel für eine Antwort

Update multiple configuration settings of the cluster

Beispielanforderung

Beispiel für eine Antwort

Update or define maintenance window

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AadEnabledEnum

ActiveDirectoryAuth

AuthConfig

Cluster

ClusterForUpdate

createdByType

DataEncryption

DataEncryptionType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityProperties

IdentityType

MaintenanceWindow

PasswordAuth

PasswordEnabledEnum

PrivateEndpointProperty

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

ServerNameItem

SimplePrivateEndpointConnection

systemData

UserAssignedIdentity