Compartir a través de


Clusters - Get

Obtiene información sobre un clúster, como la configuración de proceso y almacenamiento y los metadatos del ciclo de vida del clúster, como la fecha y hora de creación del clúster.

GET 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

Nombre del clúster.

Patrón de Regex: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$

resourceGroupName
path True

string

Nombre del grupo de recursos. El nombre 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

Versión de API que se usará para la operación.

Respuestas

Nombre Tipo Description
200 OK

Cluster

Aceptar

Other Status Codes

ErrorResponse

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo 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

Get the cluster

Solicitud de ejemplo

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

Respuesta de muestra

{
  "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": "eastus",
  "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": 4,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 2,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 8,
    "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": [
      "/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": []
  }
}

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.

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

Objeto de nombre de un servidor.

SimplePrivateEndpointConnection

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

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

UserAssignedIdentity

Propiedades de identidad asignadas por el usuario

AadEnabledEnum

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

Nombre Tipo Description
disabled

string

enabled

string

ActiveDirectoryAuth

Nombre Tipo Description
disabled

string

enabled

string

AuthConfig

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

Nombre Tipo Description
activeDirectoryAuth

ActiveDirectoryAuth

passwordAuth

PasswordAuth

Cluster

Representa un clúster.

Nombre Tipo Description
id

string

Identificador de recurso completo del 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

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

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

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

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. Solo se habilita 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

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 número 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

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

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

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 los 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 sobre los valores de createdBy y modifiedBy.

tags

object

Etiquetas del recurso.

type

string

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

createdByType

Tipo de identidad que creó el recurso.

Nombre Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataEncryption

Propiedades de cifrado de datos de un clúster.

Nombre Tipo Description
primaryKeyUri

string

URI de la clave en keyvault 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

Nombre Tipo Description
AzureKeyVault

string

SystemAssigned

string

ErrorAdditionalInfo

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

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Los detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

IdentityProperties

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

Nombre Tipo Description
SystemAssigned

string

UserAssigned

string

MaintenanceWindow

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

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

startHour

integer

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

startMinute

integer

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

PasswordAuth

Nombre Tipo Description
disabled

string

enabled

string

PasswordEnabledEnum

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

Nombre Tipo Description
disabled

string

enabled

string

PrivateEndpointProperty

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

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

Nombre Tipo Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

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, rechazado o quitado la conexión.

ServerNameItem

Objeto de nombre de un servidor.

Nombre Tipo Description
fullyQualifiedDomainName

string

Nombre de dominio completo de un servidor.

name

string

Nombre de un servidor.

SimplePrivateEndpointConnection

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

Nombre Tipo Description
id

string

Identificador de recurso completo del 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 sobre los valores de createdBy y modifiedBy.

type

string

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

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre Tipo Description
createdAt

string

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

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

Propiedades de identidad asignadas por el usuario

Nombre Tipo Description
clientId

string

Identificador de cliente de la identidad asignada.

principalId

string

Identificador de entidad de seguridad de la identidad asignada.