Compartir a través de

Clusters - Update

  • Referencia
Servicio:
Cosmos DB for PostgreSQL
Versión de la API:
2023-03-02-preview

Actualiza un clúster existente. El cuerpo de la solicitud puede contener una o varias propiedades de la definición del clúster.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
clusterName
 path True

string

minLength: 3
maxLength: 40
pattern: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?

Nombre del clúster.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId
 path True

string (uuid)

Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version
 query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre Tipo Description
identity

IdentityProperties

Describe la identidad del clúster.
properties.administratorLoginPassword

string (password)

Contraseña del inicio de sesión del administrador. Cada clúster se crea con un rol administrativo predefinido denominado "citus". 
properties.citusVersion

string

La versión de la extensión Citus en todos los servidores de clúster.
properties.coordinatorEnablePublicIpAccess

boolean

Si el acceso público está habilitado en el coordinador.
properties.coordinatorServerEdition

string

Edición del coordinador (valor predeterminado: GeneralPurpose).
properties.coordinatorStorageQuotaInMb

integer (int32)

Almacenamiento del coordinador en MB.
properties.coordinatorVCores

integer (int32)

Recuento de núcleos virtuales del coordinador (máximo: 96).
properties.enableHa

boolean

Si la alta disponibilidad (HA) está habilitada o no para el clúster.
properties.enableShardsOnCoordinator

boolean

Si las tablas distribuidas se colocan en el coordinador o no. Debe establecerse en "true" en clústeres de un solo nodo. Requiere reequilibrio de particiones después de cambiar el valor.
properties.maintenanceWindow

MaintenanceWindow

Ventana de mantenimiento de un clúster.
properties.nodeCount

integer (int32)

Recuento de nodos de trabajo del clúster. Cuando el número de nodos es 0, representa una configuración de nodo único con la capacidad de crear tablas distribuidas en ese nodo. 2 o más nodos de trabajo representan la configuración de varios nodos. El valor de recuento de nodos no puede ser 1.
properties.nodeServerEdition

string

Edición de un nodo (valor predeterminado: MemoryOptimized).
properties.nodeStorageQuotaInMb

integer (int32)

Almacenamiento en MB en cada nodo de trabajo.
properties.nodeVCores

integer (int32)

Proceso en núcleos virtuales en cada nodo de trabajo (máximo: 104).
properties.postgresqlVersion

string

La versión principal de PostgreSQL en todos los servidores de clúster.
properties.preferredPrimaryZone

string

Zona de disponibilidad principal preferida (AZ) para todos los servidores de clúster.
tags

object

Metadatos específicos de la aplicación en forma de pares clave-valor.

Respuestas

Nombre Tipo Description
200 OK

Cluster

De acuerdo
202 Accepted

Cluster

Aceptado

Encabezados

  • location: string
  • azure-async-operation: string
Other Status Codes

ErrorResponse

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation Suplantar la cuenta de usuario.

Ejemplos

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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
200 
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0,
      "customWindow": "Disabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 3,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "serverNames": [
      {
        "name": "testcluster1-c",
        "fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w0",
        "fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w1",
        "fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w2",
        "fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
      }
    ],
    "sourceResourceId": null,
    "readReplicas": [],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  },
  "location": "westus"
}
status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0,
      "customWindow": "Disabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 3,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "serverNames": [
      {
        "name": "testcluster1-c",
        "fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w0",
        "fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w1",
        "fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w2",
        "fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
      }
    ],
    "sourceResourceId": null,
    "readReplicas": [],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  },
  "location": "westus"
}

Scale out: Add new worker nodes

Solicitud de ejemplo

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

Respuesta de muestra

status code:
200 
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Provisioning",
    "state": "Provisioning",
    "aadAuthEnabled": "disabled",
    "postgresqlVersion": "15",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "preferredPrimaryZone": "1",
    "nodeCount": 2,
    "enableShardsOnCoordinator": false,
    "enableGeoBackup": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 524288,
    "coordinatorVCores": 4,
    "coordinatorEnablePublicIpAccess": true,
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeStorageQuotaInMb": 524288,
    "nodeVCores": 8,
    "nodeEnablePublicIpAccess": false,
    "passwordEnabled": "enabled",
    "serverNames": [
      {
        "name": "testcluster-c",
        "fullyQualifiedDomainName": "c.testcluster.postgres.database.azure.com"
      },
      {
        "name": "testcluster-w0",
        "fullyQualifiedDomainName": "w0.testcluster.postgres.database.azure.com"
      },
      {
        "name": "testcluster-w1",
        "fullyQualifiedDomainName": "w1.testcluster.postgres.database.azure.com"
      }
    ],
    "sourceResourceId": null,
    "enableHa": true,
    "readReplicas": [],
    "earliestRestoreTime": null,
    "privateEndpointConnections": []
  },
  "location": "westus"
}
status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Provisioning",
    "state": "Provisioning",
    "postgresqlVersion": "15",
    "aadAuthEnabled": "disabled",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "preferredPrimaryZone": "1",
    "nodeCount": 2,
    "enableShardsOnCoordinator": false,
    "enableGeoBackup": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 524288,
    "coordinatorVCores": 4,
    "coordinatorEnablePublicIpAccess": true,
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeStorageQuotaInMb": 524288,
    "nodeVCores": 8,
    "nodeEnablePublicIpAccess": false,
    "passwordEnabled": "enabled",
    "serverNames": [
      {
        "name": "testcluster-c",
        "fullyQualifiedDomainName": "c.testcluster.postgres.database.azure.com"
      },
      {
        "name": "testcluster-w0",
        "fullyQualifiedDomainName": "w0.testcluster.postgres.database.azure.com"
      },
      {
        "name": "testcluster-w1",
        "fullyQualifiedDomainName": "w1.testcluster.postgres.database.azure.com"
      }
    ],
    "sourceResourceId": null,
    "enableHa": true,
    "readReplicas": [],
    "earliestRestoreTime": null,
    "privateEndpointConnections": []
  },
  "location": "westus"
}

Scale up storage

Solicitud de ejemplo

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

Respuesta de muestra

status code:
200 
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0,
      "customWindow": "Disabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 3,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "serverNames": [
      {
        "name": "testcluster1-c",
        "fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w0",
        "fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w1",
        "fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w2",
        "fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
      }
    ],
    "sourceResourceId": null,
    "readReplicas": [],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  },
  "location": "westus"
}
status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0,
      "customWindow": "Disabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 3,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "serverNames": [
      {
        "name": "testcluster1-c",
        "fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w0",
        "fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w1",
        "fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w2",
        "fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
      }
    ],
    "sourceResourceId": null,
    "readReplicas": [],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  },
  "location": "westus"
}

Update multiple configuration settings of the cluster

Solicitud de ejemplo

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

Respuesta de muestra

status code:
200 
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1",
  "name": "testcluster1",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "tags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "location": "westus",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0,
      "customWindow": "Disabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 4,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "serverNames": [
      {
        "name": "testcluster1-c",
        "fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w0",
        "fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w1",
        "fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w2",
        "fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w3",
        "fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
      }
    ],
    "sourceResourceId": null,
    "readReplicas": [
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSQL/serverGroupsv2/testreadreplica-01",
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSQL/serverGroupsv2/testreadreplica-02"
    ],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  }
}
status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1",
  "name": "testcluster1",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "tags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "location": "westus",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0,
      "customWindow": "Disabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 4,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "serverNames": [
      {
        "name": "testcluster1-c",
        "fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w0",
        "fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w1",
        "fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w2",
        "fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w3",
        "fullyQualifiedDomainName": "testcluster1-w2.postgres.database.azure.com"
      }
    ],
    "sourceResourceId": null,
    "readReplicas": [
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSQL/serverGroupsv2/testreadreplica-01",
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSQL/serverGroupsv2/testreadreplica-02"
    ],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  }
}

Update or define maintenance window

Solicitud de ejemplo

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster?api-version=2023-03-02-preview

{
  "properties": {
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 8,
      "startMinute": 0,
      "customWindow": "Enabled"
    }
  }
}

Respuesta de muestra

status code:
200 
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 8,
      "startMinute": 0,
      "customWindow": "Enabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 2,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "serverNames": [
      {
        "name": "testcluster1-c",
        "fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w0",
        "fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w1",
        "fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
      }
    ],
    "sourceResourceId": null,
    "readReplicas": [],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  },
  "location": "westus"
}
status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-03-02-preview
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster",
  "name": "testcluster",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 8,
      "startMinute": 0,
      "customWindow": "Enabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 16,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 2,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 16,
    "nodeEnablePublicIpAccess": false,
    "serverNames": [
      {
        "name": "testcluster1-c",
        "fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w0",
        "fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w1",
        "fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
      }
    ],
    "sourceResourceId": null,
    "readReplicas": [],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  },
  "location": "westus"
}

Definiciones

Nombre Description
AadEnabledEnum

Indica si el clúster se creó mediante la autenticación de AAD.
ActiveDirectoryAuth
AuthConfig

Configuración de autenticación de un clúster.
Cluster

Representa un clúster.
ClusterForUpdate

Representa un clúster para la actualización.
createdByType

Tipo de identidad que creó el recurso.
DataEncryption

Propiedades de cifrado de datos de un clúster.
DataEncryptionType
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

Respuesta de error
IdentityProperties

Describe la identidad del clúster.
IdentityType
MaintenanceWindow

Programe la configuración de las actualizaciones de clúster normales.
PasswordAuth
PasswordEnabledEnum

Indica si el clúster se creó con una contraseña o mediante la autenticación de AAD.
PrivateEndpointProperty

Propiedad para representar el identificador de recurso del punto de conexión privado.
PrivateEndpointServiceConnectionStatus

Estado de conexión del punto de conexión privado.
PrivateLinkServiceConnectionState

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
ServerNameItem

El objeto name de un servidor.
SimplePrivateEndpointConnection

Una conexión de punto de conexión privado.
systemData

Metadatos relativos a la creación y última modificación del recurso.
UserAssignedIdentity

Propiedades de identidad asignadas por el usuario

AadEnabledEnum

Enumeración

Indica si el clúster se creó mediante la autenticación de AAD.

Valor Description
disabled
enabled

ActiveDirectoryAuth

Enumeración
Valor Description
disabled
enabled

AuthConfig

Object

Configuración de autenticación de un clúster.

Nombre Tipo Description
activeDirectoryAuth

ActiveDirectoryAuth

passwordAuth

PasswordAuth

Cluster

Object

Representa un clúster.

Nombre Tipo Description
id

string (arm-id)

Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity

IdentityProperties

Describe la identidad del clúster.
location

string

Ubicación geográfica donde reside el recurso
name

string

Nombre del recurso
properties.aadAuthEnabled

AadEnabledEnum

Indica si el clúster se creó mediante la autenticación de AAD.
properties.administratorLogin

string

Nombre de inicio de sesión del administrador de los servidores del clúster.
properties.administratorLoginPassword

string (password)

Contraseña del inicio de sesión del administrador. Necesario para la creación.
properties.authConfig

AuthConfig

Configuración de autenticación de un clúster.
properties.citusVersion

string

La versión de la extensión Citus en todos los servidores de clúster.
properties.coordinatorEnablePublicIpAccess

boolean

Si el acceso público está habilitado en el coordinador.
properties.coordinatorServerEdition

string

Edición de un servidor de coordinación (valor predeterminado: GeneralPurpose). Necesario para la creación.
properties.coordinatorStorageQuotaInMb

integer (int32)

Almacenamiento de un servidor en MB. Necesario para la creación. Consulte https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute para obtener más información.
properties.coordinatorVCores

integer (int32)

Recuento de núcleos virtuales de un servidor (máximo: 96). Necesario para la creación. Consulte https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute para obtener más información.
properties.dataEncryption

DataEncryption

Propiedades de cifrado de datos de un clúster.
properties.databaseName

string

Nombre de la base de datos del clúster. Solo se admite una base de datos por clúster.
properties.earliestRestoreTime

string (date-time)

El tiempo de punto de restauración más antiguo (ISO8601 formato) para el clúster.
properties.enableGeoBackup

boolean

Si la copia de seguridad del clúster se almacena en otra región de Azure además de la copia de seguridad almacenada en la región del clúster. Habilitado solo en el momento de la creación del clúster.
properties.enableHa

boolean

Si la alta disponibilidad (HA) está habilitada o no para el clúster.
properties.enableShardsOnCoordinator

boolean

Si las tablas distribuidas se colocan en el coordinador o no. Debe establecerse en "true" en clústeres de un solo nodo. Requiere reequilibrio de particiones después de cambiar el valor.
properties.maintenanceWindow

MaintenanceWindow

Ventana de mantenimiento de un clúster.
properties.nodeCount

integer (int32)

Recuento de nodos de trabajo del clúster. Cuando el número de nodos es 0, representa una configuración de nodo único con la capacidad de crear tablas distribuidas en ese nodo. 2 o más nodos de trabajo representan la configuración de varios nodos. El valor de recuento de nodos no puede ser 1. Necesario para la creación.
properties.nodeEnablePublicIpAccess

boolean

Si el acceso público está habilitado en los nodos de trabajo.
properties.nodeServerEdition

string

Edición de un servidor de nodo (valor predeterminado: MemoryOptimized).
properties.nodeStorageQuotaInMb

integer (int32)

Almacenamiento en MB en cada nodo de trabajo. Consulte https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute para obtener más información.
properties.nodeVCores

integer (int32)

Proceso en núcleos virtuales en cada nodo de trabajo (máximo: 104). Consulte https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute para obtener más información.
properties.passwordEnabled

PasswordEnabledEnum

Indica si el clúster se creó con una contraseña o mediante la autenticación de AAD.
properties.pointInTimeUTC

string (date-time)

Fecha y hora en formato UTC (ISO8601) para la restauración del clúster.
properties.postgresqlVersion

string

La versión principal de PostgreSQL en todos los servidores de clúster.
properties.preferredPrimaryZone

string

Zona de disponibilidad principal preferida (AZ) para todos los servidores de clúster.
properties.privateEndpointConnections

SimplePrivateEndpointConnection[]

Conexiones de punto de conexión privado para un clúster.
properties.provisioningState

string

Estado de aprovisionamiento del clúster
properties.readReplicas

string[]

Matriz de clústeres de réplica de lectura.
properties.serverNames

ServerNameItem[]

Lista de nombres de servidor en el clúster
properties.sourceLocation

string

Región de Azure del clúster de origen para clústeres de réplica de lectura.
properties.sourceResourceId

string

Identificador de recurso del clúster de origen para clústeres de réplica de lectura.
properties.state

string

Estado de un clúster o servidor que es visible para el usuario.
systemData

systemData

Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags

object

Etiquetas de recursos.
type

string

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ClusterForUpdate

Object

Representa un clúster para la actualización.

Nombre Tipo Description
identity

IdentityProperties

Describe la identidad del clúster.
properties.administratorLoginPassword

string (password)

Contraseña del inicio de sesión del administrador. Cada clúster se crea con un rol administrativo predefinido denominado "citus". 
properties.citusVersion

string

La versión de la extensión Citus en todos los servidores de clúster.
properties.coordinatorEnablePublicIpAccess

boolean

Si el acceso público está habilitado en el coordinador.
properties.coordinatorServerEdition

string

Edición del coordinador (valor predeterminado: GeneralPurpose).
properties.coordinatorStorageQuotaInMb

integer (int32)

Almacenamiento del coordinador en MB.
properties.coordinatorVCores

integer (int32)

Recuento de núcleos virtuales del coordinador (máximo: 96).
properties.enableHa

boolean

Si la alta disponibilidad (HA) está habilitada o no para el clúster.
properties.enableShardsOnCoordinator

boolean

Si las tablas distribuidas se colocan en el coordinador o no. Debe establecerse en "true" en clústeres de un solo nodo. Requiere reequilibrio de particiones después de cambiar el valor.
properties.maintenanceWindow

MaintenanceWindow

Ventana de mantenimiento de un clúster.
properties.nodeCount

integer (int32)

Recuento de nodos de trabajo del clúster. Cuando el número de nodos es 0, representa una configuración de nodo único con la capacidad de crear tablas distribuidas en ese nodo. 2 o más nodos de trabajo representan la configuración de varios nodos. El valor de recuento de nodos no puede ser 1.
properties.nodeEnablePublicIpAccess

boolean

Si el acceso público está habilitado en los nodos de trabajo.
properties.nodeServerEdition

string

Edición de un nodo (valor predeterminado: MemoryOptimized).
properties.nodeStorageQuotaInMb

integer (int32)

Almacenamiento en MB en cada nodo de trabajo.
properties.nodeVCores

integer (int32)

Proceso en núcleos virtuales en cada nodo de trabajo (máximo: 104).
properties.postgresqlVersion

string

La versión principal de PostgreSQL en todos los servidores de clúster.
properties.preferredPrimaryZone

string

Zona de disponibilidad principal preferida (AZ) para todos los servidores de clúster.
tags

object

Metadatos específicos de la aplicación en forma de pares clave-valor.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor Description
Application
Key
ManagedIdentity
User

DataEncryption

Object

Propiedades de cifrado de datos de un clúster.

Nombre Tipo Description
primaryKeyUri

string

URI de la clave del almacén de claves para el cifrado de datos del servidor principal.
primaryUserAssignedIdentityId

string

Identificador de recurso de la identidad asignada por el usuario que se usará para el cifrado de datos del servidor principal.
type

DataEncryptionType

DataEncryptionType

Enumeración
Valor Description
AzureKeyVault
SystemAssigned

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Detalles del error.
message

string

Mensaje de error.
target

string

Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

IdentityProperties

Object

Describe la identidad del clúster.

Nombre Tipo Description
type

IdentityType

userAssignedIdentities

<string,  UserAssignedIdentity>

identidades de User-Assigned
Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes.

IdentityType

Enumeración
Valor Description
SystemAssigned
UserAssigned

MaintenanceWindow

Object

Programe la configuración de las actualizaciones de clúster normales.

Nombre Tipo Description
customWindow

string

Indica si la ventana de mantenimiento personalizada está habilitada o no.
dayOfWeek

integer (int32)

Día preferido de la semana para la ventana de mantenimiento.
startHour

integer (int32)

Hora de inicio dentro del día preferido de la semana para la ventana de mantenimiento.
startMinute

integer (int32)

Minuto de inicio dentro de la hora de inicio de la ventana de mantenimiento.

PasswordAuth

Enumeración
Valor Description
disabled
enabled

PasswordEnabledEnum

Enumeración

Indica si el clúster se creó con una contraseña o mediante la autenticación de AAD.

Valor Description
disabled
enabled

PrivateEndpointProperty

Object

Propiedad para representar el identificador de recurso del punto de conexión privado.

Nombre Tipo Description
id

string

Identificador de recurso del punto de conexión privado.

PrivateEndpointServiceConnectionStatus

Enumeración

Estado de conexión del punto de conexión privado.

Valor Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.

Nombre Tipo Description
actionsRequired

string

Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
description

string

Motivo de aprobación o rechazo de la conexión.
status

PrivateEndpointServiceConnectionStatus

Indica si el propietario del servicio ha aprobado o rechazado o eliminado la conexión.

ServerNameItem

Object

El objeto name de un servidor.

Nombre Tipo Description
fullyQualifiedDomainName

string

Nombre de dominio completo de un servidor.
name

string

Nombre de un servidor.

SimplePrivateEndpointConnection

Object

Una conexión de punto de conexión privado.

Nombre Tipo Description
id

string (arm-id)

Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

Nombre del recurso
properties.groupIds

string[]

Identificadores de grupo de la conexión de punto de conexión privado.
properties.privateEndpoint

PrivateEndpointProperty

Punto de conexión privado al que pertenece la conexión.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
systemData

systemData

Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type

string

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre Tipo Description
createdAt

string (date-time)

Marca de tiempo de creación de recursos (UTC).
createdBy

string

Identidad que creó el recurso.
createdByType

createdByType

Tipo de identidad que creó el recurso.
lastModifiedAt

string (date-time)

Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy

string

Identidad que modificó por última vez el recurso.
lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.

UserAssignedIdentity

Object

Propiedades de identidad asignadas por el usuario

Nombre Tipo Description
clientId

string (uuid)

Identificador de cliente de la identidad asignada.
principalId

string (uuid)

Identificador de entidad de seguridad de la identidad asignada.