Clusters - Update

Tjänst:: Cosmos DB for PostgreSQL

API-versionen:: 2023-03-02-preview

Uppdaterar ett befintligt kluster. Begärandetexten kan innehålla en eller flera egenskaper från klusterdefinitionen.

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
clusterName	path	True	string minLength: 3 maxLength: 40 pattern: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?	Namnet på klustret.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begäranarorgan

Namn	Typ	Beskrivning
identity	IdentityProperties	Beskriver klustrets identitet.
properties.administratorLoginPassword	string (password)	Lösenordet för administratörsinloggningen. Varje kluster skapas med fördefinierade administrativa roller som kallas "citus".
properties.citusVersion	string	Citus-tilläggsversionen på alla klusterservrar.
properties.coordinatorEnablePublicIpAccess	boolean	Om offentlig åtkomst är aktiverad på koordinatorn.
properties.coordinatorServerEdition	string	Koordinatorversionen (standard: GeneralPurpose).
properties.coordinatorStorageQuotaInMb	integer (int32)	Lagringen av koordinatorn i MB.
properties.coordinatorVCores	integer (int32)	Antalet virtuella kärnor för koordinatorn (max: 96).
properties.enableHa	boolean	Om hög tillgänglighet (HA) är aktiverat eller inte för klustret.
properties.enableShardsOnCoordinator	boolean	Om distribuerade tabeller placeras på koordinator eller inte. Ska anges till "true" i kluster med en enda nod. Kräver horisontell ombalansering när värdet har ändrats.
properties.maintenanceWindow	MaintenanceWindow	Underhållsperiod för ett kluster.
properties.nodeCount	integer (int32)	Antal arbetsnoder i klustret. När antalet noder är 0 representerar det en konfiguration med en enda nod med möjlighet att skapa distribuerade tabeller på noden. 2 eller fler arbetsnoder representerar konfiguration med flera noder. Värdet för antal noder får inte vara 1.
properties.nodeServerEdition	string	Utgåvan av en nod (standard: MemoryOptimized).
properties.nodeStorageQuotaInMb	integer (int32)	Lagringen i MB på varje arbetsnod.
properties.nodeVCores	integer (int32)	Beräkningen i virtuella kärnor på varje arbetsnod (max: 104).
properties.postgresqlVersion	string	Den större PostgreSQL-versionen på alla klusterservrar.
properties.preferredPrimaryZone	string	Prioriterad primär tillgänglighetszon (AZ) för alla klusterservrar.
tags	object	Programspecifika metadata i form av nyckel/värde-par.

Svaren

Namn	Typ	Beskrivning
200 OK	Cluster	Azure-åtgärden har slutförts.
202 Accepted	Cluster	Begäran har godkänts för behandling, men bearbetningen har ännu inte slutförts. Headers Azure-AsyncOperation: string Location: string
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Namn

Typ

Beskrivning

200 OK

Cluster

Azure-åtgärden har slutförts.

202 Accepted

Cluster

Begäran har godkänts för behandling, men bearbetningen har ännu inte slutförts.

Headers

Azure-AsyncOperation: string
Location: string

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Rinna: implicit
Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/authorize

Scope

Namn	Beskrivning
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelsvar

Statuskod:: 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"
  }
}

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

Exempelförfrågan

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

Exempelsvar

Statuskod:: 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"
  }
}

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

Exempelförfrågan

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

Exempelsvar

Statuskod:: 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"
  }
}

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

Exempelförfrågan

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

Exempelsvar

Statuskod:: 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"
  }
}

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

Exempelförfrågan

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

Exempelsvar

Statuskod:: 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"
  }
}

Statuskod:: 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"
  }
}

Definitioner

Namn	Beskrivning
AadEnabledEnum	Anger om klustret skapades med AAD-autentisering.
ActiveDirectoryAuth
AuthConfig	Autentiseringskonfiguration för ett kluster.
Cluster	Representerar ett kluster.
ClusterForUpdate	Representerar ett kluster för uppdatering.
createdByType	Den typ av identitet som skapade resursen.
DataEncryption	Datakrypteringsegenskaperna för ett kluster.
DataEncryptionType
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
IdentityProperties	Beskriver klustrets identitet.
IdentityType
MaintenanceWindow	Schemalägg inställningar för regelbundna klusteruppdateringar.
PasswordAuth
PasswordEnabledEnum	Anger om klustret skapades med ett lösenord eller med hjälp av AAD-autentisering.
PrivateEndpointProperty	Egenskap som representerar resurs-ID för den privata slutpunkten.
PrivateEndpointServiceConnectionStatus	Anslutningsstatus för privat slutpunkt.
PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
ServerNameItem	Namnobjektet för en server.
SimplePrivateEndpointConnection	En privat slutpunktsanslutning.
systemData	Metadata som rör skapande och senaste ändring av resursen.
UserAssignedIdentity	Användartilldelade identitetsegenskaper

AadEnabledEnum

Uppräkning

Anger om klustret skapades med AAD-autentisering.

Värde	Beskrivning
enabled
disabled

ActiveDirectoryAuth

Uppräkning

Värde	Beskrivning
enabled
disabled

AuthConfig

Objekt

Autentiseringskonfiguration för ett kluster.

Namn	Typ	Beskrivning
activeDirectoryAuth	ActiveDirectoryAuth
passwordAuth	PasswordAuth

Cluster

Objekt

Representerar ett kluster.

Namn	Typ	Beskrivning
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	IdentityProperties	Beskriver klustrets identitet.
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.aadAuthEnabled	AadEnabledEnum	Anger om klustret skapades med AAD-autentisering.
properties.administratorLogin	string	Administratörens inloggningsnamn för servrarna i klustret.
properties.administratorLoginPassword	string (password)	Lösenordet för administratörsinloggningen. Krävs för att skapa.
properties.authConfig	AuthConfig	Autentiseringskonfiguration för ett kluster.
properties.citusVersion	string	Citus-tilläggsversionen på alla klusterservrar.
properties.coordinatorEnablePublicIpAccess	boolean	Om offentlig åtkomst är aktiverad på koordinatorn.
properties.coordinatorServerEdition	string	Utgåvan av en koordinatorserver (standard: GeneralPurpose). Krävs för att skapa.
properties.coordinatorStorageQuotaInMb	integer (int32)	Lagring av en server i MB. Krävs för att skapa. Mer information finns i https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.
properties.coordinatorVCores	integer (int32)	Antalet virtuella kärnor för en server (max: 96). Krävs för att skapa. Mer information finns i https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.
properties.dataEncryption	DataEncryption	Datakrypteringsegenskaperna för ett kluster.
properties.databaseName	string	Klustrets databasnamn. Endast en databas per kluster stöds.
properties.earliestRestoreTime	string (date-time)	Den tidigaste återställningspunkten (ISO8601 format) för klustret.
properties.enableGeoBackup	boolean	Om klustersäkerhetskopiering lagras i en annan Azure-region utöver kopian av säkerhetskopian som lagras i klustrets region. Aktiverad endast när klustret skapas.
properties.enableHa	boolean	Om hög tillgänglighet (HA) är aktiverat eller inte för klustret.
properties.enableShardsOnCoordinator	boolean	Om distribuerade tabeller placeras på koordinator eller inte. Ska anges till "true" i kluster med en enda nod. Kräver horisontell ombalansering när värdet har ändrats.
properties.maintenanceWindow	MaintenanceWindow	Underhållsperiod för ett kluster.
properties.nodeCount	integer (int32)	Antal arbetsnoder i klustret. När antalet noder är 0 representerar det en konfiguration med en enda nod med möjlighet att skapa distribuerade tabeller på noden. 2 eller fler arbetsnoder representerar konfiguration med flera noder. Värdet för antal noder får inte vara 1. Krävs för att skapa.
properties.nodeEnablePublicIpAccess	boolean	Om offentlig åtkomst är aktiverad på arbetsnoder.
properties.nodeServerEdition	string	Utgåvan av en nodserver (standard: MemoryOptimized).
properties.nodeStorageQuotaInMb	integer (int32)	Lagringen i MB på varje arbetsnod. Mer information finns i https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.
properties.nodeVCores	integer (int32)	Beräkningen i virtuella kärnor på varje arbetsnod (max: 104). Mer information finns i https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.
properties.passwordEnabled	PasswordEnabledEnum	Anger om klustret skapades med ett lösenord eller med hjälp av AAD-autentisering.
properties.pointInTimeUTC	string (date-time)	Datum och tid i UTC (ISO8601 format) för klusteråterställning.
properties.postgresqlVersion	string	Den större PostgreSQL-versionen på alla klusterservrar.
properties.preferredPrimaryZone	string	Prioriterad primär tillgänglighetszon (AZ) för alla klusterservrar.
properties.privateEndpointConnections	SimplePrivateEndpointConnection[]	Privata slutpunktsanslutningar för ett kluster.
properties.provisioningState	string	Etableringstillstånd för klustret
properties.readReplicas	string[]	Matrisen med skrivskyddade replikkluster.
properties.serverNames	ServerNameItem[]	Listan över servernamn i klustret
properties.sourceLocation	string	Azure-regionen för källkluster för skrivskyddade replikkluster.
properties.sourceResourceId	string	Resurs-ID för källkluster för skrivskyddade replikkluster.
properties.state	string	Ett tillstånd för ett kluster/en server som är synligt för användaren.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Resurstaggar.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ClusterForUpdate

Objekt

Representerar ett kluster för uppdatering.

Namn	Typ	Beskrivning
identity	IdentityProperties	Beskriver klustrets identitet.
properties.administratorLoginPassword	string (password)	Lösenordet för administratörsinloggningen. Varje kluster skapas med fördefinierade administrativa roller som kallas "citus".
properties.citusVersion	string	Citus-tilläggsversionen på alla klusterservrar.
properties.coordinatorEnablePublicIpAccess	boolean	Om offentlig åtkomst är aktiverad på koordinatorn.
properties.coordinatorServerEdition	string	Koordinatorversionen (standard: GeneralPurpose).
properties.coordinatorStorageQuotaInMb	integer (int32)	Lagringen av koordinatorn i MB.
properties.coordinatorVCores	integer (int32)	Antalet virtuella kärnor för koordinatorn (max: 96).
properties.enableHa	boolean	Om hög tillgänglighet (HA) är aktiverat eller inte för klustret.
properties.enableShardsOnCoordinator	boolean	Om distribuerade tabeller placeras på koordinator eller inte. Ska anges till "true" i kluster med en enda nod. Kräver horisontell ombalansering när värdet har ändrats.
properties.maintenanceWindow	MaintenanceWindow	Underhållsperiod för ett kluster.
properties.nodeCount	integer (int32)	Antal arbetsnoder i klustret. När antalet noder är 0 representerar det en konfiguration med en enda nod med möjlighet att skapa distribuerade tabeller på noden. 2 eller fler arbetsnoder representerar konfiguration med flera noder. Värdet för antal noder får inte vara 1.
properties.nodeEnablePublicIpAccess	boolean	Om offentlig åtkomst är aktiverad på arbetsnoder.
properties.nodeServerEdition	string	Utgåvan av en nod (standard: MemoryOptimized).
properties.nodeStorageQuotaInMb	integer (int32)	Lagringen i MB på varje arbetsnod.
properties.nodeVCores	integer (int32)	Beräkningen i virtuella kärnor på varje arbetsnod (max: 104).
properties.postgresqlVersion	string	Den större PostgreSQL-versionen på alla klusterservrar.
properties.preferredPrimaryZone	string	Prioriterad primär tillgänglighetszon (AZ) för alla klusterservrar.
tags	object	Programspecifika metadata i form av nyckel/värde-par.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Beskrivning
User
Application
ManagedIdentity
Key

DataEncryption

Objekt

Datakrypteringsegenskaperna för ett kluster.

Namn	Typ	Beskrivning
primaryKeyUri	string	URI för nyckeln i keyvault för datakryptering av den primära servern.
primaryUserAssignedIdentityId	string	Resurs-ID för den användartilldelade identitet som ska användas för datakryptering av den primära servern.
type	DataEncryptionType

DataEncryptionType

Uppräkning

Värde	Beskrivning
AzureKeyVault
SystemAssigned

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Namn	Typ	Beskrivning
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Namn	Typ	Beskrivning
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Namn	Typ	Beskrivning
error	ErrorDetail	Felobjektet.

IdentityProperties

Objekt

Beskriver klustrets identitet.

Namn	Typ	Beskrivning
type	IdentityType
userAssignedIdentities	<string, UserAssignedIdentity>	Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

IdentityType

Uppräkning

Värde	Beskrivning
UserAssigned
SystemAssigned

MaintenanceWindow

Objekt

Schemalägg inställningar för regelbundna klusteruppdateringar.

Namn	Typ	Beskrivning
customWindow	string	Anger om fönstret för anpassat underhåll är aktiverat eller inte.
dayOfWeek	integer (int32)	Önskad dag i veckan för underhållsperiod.
startHour	integer (int32)	Starttimmes inom önskad dag i veckan för underhållsperiod.
startMinute	integer (int32)	Startminut inom starttimmes för underhållsperiod.

PasswordAuth

Uppräkning

Värde	Beskrivning
enabled
disabled

PasswordEnabledEnum

Uppräkning

Anger om klustret skapades med ett lösenord eller med hjälp av AAD-autentisering.

Värde	Beskrivning
enabled
disabled

PrivateEndpointProperty

Objekt

Egenskap som representerar resurs-ID för den privata slutpunkten.

Namn	Typ	Beskrivning
id	string	Resurs-ID för den privata slutpunkten.

PrivateEndpointServiceConnectionStatus

Uppräkning

Anslutningsstatus för privat slutpunkt.

Värde	Beskrivning
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Objekt

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

Namn	Typ	Beskrivning
actionsRequired	string	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.
description	string	Orsak till godkännande/avvisande av anslutningen.
status	PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.

ServerNameItem

Objekt

Namnobjektet för en server.

Namn	Typ	Beskrivning
fullyQualifiedDomainName	string	Det fullständigt kvalificerade domännamnet för en server.
name	string	Namnet på en server.

SimplePrivateEndpointConnection

Objekt

En privat slutpunktsanslutning.

Namn	Typ	Beskrivning
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties.groupIds	string[]	Grupp-ID:t för den privata slutpunktsanslutningen.
properties.privateEndpoint	PrivateEndpointProperty	Privat slutpunkt som anslutningen tillhör.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Namn	Typ	Beskrivning
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UserAssignedIdentity

Objekt

Användartilldelade identitetsegenskaper

Namn	Typ	Beskrivning
clientId	string (uuid)	Klient-ID för den tilldelade identiteten.
principalId	string (uuid)	Huvud-ID för den tilldelade identiteten.

Dela via

Clusters - Update

URI-parametrar

Begäranarorgan

Svaren

Säkerhet

azure_auth

Scope

Exempel

Scale compute up or down

Exempelförfrågan

Exempelsvar

Scale out: Add new worker nodes

Exempelförfrågan

Exempelsvar

Scale up storage

Exempelförfrågan

Exempelsvar

Update multiple configuration settings of the cluster

Exempelförfrågan

Exempelsvar

Update or define maintenance window

Exempelförfrågan

Exempelsvar

Definitioner

AadEnabledEnum

ActiveDirectoryAuth

AuthConfig

Cluster

ClusterForUpdate

createdByType

DataEncryption

DataEncryptionType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityProperties

IdentityType

MaintenanceWindow

PasswordAuth

PasswordEnabledEnum

PrivateEndpointProperty

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

ServerNameItem

SimplePrivateEndpointConnection

systemData

UserAssignedIdentity