Partager via


Clusters - Get

Obtient des informations sur un cluster, telles que la configuration de calcul et de stockage et les métadonnées de cycle de vie du cluster, telles que la date et l’heure de création du cluster.

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

Paramètres URI

Nom Dans Obligatoire Type Description
clusterName
path True

string

Nom du cluster.

Modèle d’expression régulière: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$

resourceGroupName
path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string

uuid

ID de l’abonnement cible. La valeur doit être un UUID.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

Cluster

Ok

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Empruntez l’identité de votre compte d’utilisateur.

Exemples

Get the cluster

Exemple de requête

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

Exemple de réponse

{
  "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": []
  }
}

Définitions

Nom Description
AadEnabledEnum

Indique si le cluster a été créé à l’aide de l’authentification AAD.

ActiveDirectoryAuth
AuthConfig

Configuration d’authentification d’un cluster.

Cluster

Représente un cluster.

createdByType

Type d’identité qui a créé la ressource.

DataEncryption

Propriétés de chiffrement des données d’un cluster.

DataEncryptionType
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

IdentityProperties

Décrit l’identité du cluster.

IdentityType
MaintenanceWindow

Planifier les paramètres pour les mises à jour régulières du cluster.

PasswordAuth
PasswordEnabledEnum

Indique si le cluster a été créé avec un mot de passe ou à l’aide de l’authentification AAD.

PrivateEndpointProperty

Propriété pour représenter l’ID de ressource du point de terminaison privé.

PrivateEndpointServiceConnectionStatus

La connexion de point de terminaison privé status.

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

ServerNameItem

Objet name d’un serveur.

SimplePrivateEndpointConnection

Connexion de point de terminaison privé.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

UserAssignedIdentity

Propriétés d’identité attribuées par l’utilisateur

AadEnabledEnum

Indique si le cluster a été créé à l’aide de l’authentification AAD.

Nom Type Description
disabled

string

enabled

string

ActiveDirectoryAuth

Nom Type Description
disabled

string

enabled

string

AuthConfig

Configuration d’authentification d’un cluster.

Nom Type Description
activeDirectoryAuth

ActiveDirectoryAuth

passwordAuth

PasswordAuth

Cluster

Représente un cluster.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »

identity

IdentityProperties

Décrit l’identité du cluster.

location

string

Emplacement géographique où réside la ressource

name

string

nom de la ressource.

properties.aadAuthEnabled

AadEnabledEnum

Indique si le cluster a été créé à l’aide de l’authentification AAD.

properties.administratorLogin

string

Nom de connexion de l’administrateur des serveurs dans le cluster.

properties.administratorLoginPassword

string

Mot de passe de la connexion administrateur. Obligatoire pour la création.

properties.authConfig

AuthConfig

Configuration d’authentification d’un cluster.

properties.citusVersion

string

Version de l’extension Citus sur tous les serveurs de cluster.

properties.coordinatorEnablePublicIpAccess

boolean

Si l’accès public est activé sur le coordinateur.

properties.coordinatorServerEdition

string

Édition d’un serveur coordinateur (par défaut : GeneralPurpose). Obligatoire pour la création.

properties.coordinatorStorageQuotaInMb

integer

Stockage d’un serveur en Mo. Obligatoire pour la création. Consultez la rubrique https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute (éventuellement en anglais) pour plus d'informations.

properties.coordinatorVCores

integer

Nombre de vCores d’un serveur (max : 96). Obligatoire pour la création. Consultez la rubrique https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute (éventuellement en anglais) pour plus d'informations.

properties.dataEncryption

DataEncryption

Propriétés de chiffrement des données d’un cluster.

properties.databaseName

string

Nom de la base de données du cluster. Une seule base de données par cluster est prise en charge.

properties.earliestRestoreTime

string

Heure de point de restauration la plus ancienne (format ISO8601) pour le cluster.

properties.enableGeoBackup

boolean

Si la sauvegarde du cluster est stockée dans une autre région Azure en plus de la copie de la sauvegarde stockée dans la région du cluster. Activé uniquement au moment de la création du cluster.

properties.enableHa

boolean

Si la haute disponibilité est activée ou non pour le cluster.

properties.enableShardsOnCoordinator

boolean

Si les tables distribuées sont placées sur le coordinateur ou non. Doit être défini sur « true » sur les clusters à nœud unique. Nécessite un rééquilibrage des partitions après la modification de la valeur.

properties.maintenanceWindow

MaintenanceWindow

Fenêtre de maintenance d’un cluster.

properties.nodeCount

integer

Nombre de nœuds Worker du cluster. Lorsque le nombre de nœuds est 0, il représente une configuration de nœud unique avec la possibilité de créer des tables distribuées sur ce nœud. 2 nœuds worker ou plus représentent une configuration à plusieurs nœuds. La valeur du nombre de nœuds ne peut pas être 1. Obligatoire pour la création.

properties.nodeEnablePublicIpAccess

boolean

Si l’accès public est activé sur les nœuds Worker.

properties.nodeServerEdition

string

Édition d’un serveur de nœud (par défaut : MemoryOptimized).

properties.nodeStorageQuotaInMb

integer

Stockage en Mo sur chaque nœud Worker. Consultez la rubrique https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute (éventuellement en anglais) pour plus d'informations.

properties.nodeVCores

integer

Calcul dans vCores sur chaque nœud Worker (max : 104). Consultez la rubrique https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute (éventuellement en anglais) pour plus d'informations.

properties.passwordEnabled

PasswordEnabledEnum

Indique si le cluster a été créé avec un mot de passe ou à l’aide de l’authentification AAD.

properties.pointInTimeUTC

string

Date et heure utc (format ISO8601) pour la restauration du cluster.

properties.postgresqlVersion

string

Version principale de PostgreSQL sur tous les serveurs de cluster.

properties.preferredPrimaryZone

string

Zone de disponibilité principale (AZ) par défaut pour tous les serveurs de cluster.

properties.privateEndpointConnections

SimplePrivateEndpointConnection[]

Connexions de point de terminaison privé pour un cluster.

properties.provisioningState

string

État d’approvisionnement du cluster

properties.readReplicas

string[]

Tableau de clusters réplica lecture.

properties.serverNames

ServerNameItem[]

Liste des noms de serveurs dans le cluster

properties.sourceLocation

string

Région Azure du cluster source pour la lecture réplica clusters.

properties.sourceResourceId

string

ID de ressource du cluster source pour la lecture réplica clusters.

properties.state

string

État d’un cluster/serveur visible par l’utilisateur.

systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.

tags

object

Balises de ressource.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataEncryption

Propriétés de chiffrement des données d’un cluster.

Nom Type Description
primaryKeyUri

string

URI de la clé dans keyvault pour le chiffrement des données du serveur principal.

primaryUserAssignedIdentityId

string

ID de ressource de l’identité affectée par l’utilisateur à utiliser pour le chiffrement des données du serveur principal.

type

DataEncryptionType

DataEncryptionType

Nom Type Description
AzureKeyVault

string

SystemAssigned

string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

IdentityProperties

Décrit l’identité du cluster.

Nom Type Description
type

IdentityType

userAssignedIdentities

<string,  UserAssignedIdentity>

identités User-Assigned
Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs du dictionnaire peuvent être des objets vides ({}) dans les requêtes.

IdentityType

Nom Type Description
SystemAssigned

string

UserAssigned

string

MaintenanceWindow

Planifier les paramètres pour les mises à jour régulières du cluster.

Nom Type Description
customWindow

string

Indique si la fenêtre de maintenance personnalisée est activée ou non.

dayOfWeek

integer

Jour de la semaine préféré pour la fenêtre de maintenance.

startHour

integer

Heure de début dans le jour de la semaine par défaut pour la fenêtre de maintenance.

startMinute

integer

Minute de début dans l’heure de début pour la fenêtre de maintenance.

PasswordAuth

Nom Type Description
disabled

string

enabled

string

PasswordEnabledEnum

Indique si le cluster a été créé avec un mot de passe ou à l’aide de l’authentification AAD.

Nom Type Description
disabled

string

enabled

string

PrivateEndpointProperty

Propriété pour représenter l’ID de ressource du point de terminaison privé.

Nom Type Description
id

string

ID de ressource du point de terminaison privé.

PrivateEndpointServiceConnectionStatus

La connexion de point de terminaison privé status.

Nom Type Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

Nom Type Description
actionsRequired

string

Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.

description

string

Raison de l’approbation/du rejet de la connexion.

status

PrivateEndpointServiceConnectionStatus

Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service.

ServerNameItem

Objet name d’un serveur.

Nom Type Description
fullyQualifiedDomainName

string

Nom de domaine complet d’un serveur.

name

string

Nom d’un serveur.

SimplePrivateEndpointConnection

Connexion de point de terminaison privé.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »

name

string

nom de la ressource.

properties.groupIds

string[]

ID de groupe de la connexion de point de terminaison privé.

properties.privateEndpoint

PrivateEndpointProperty

Point de terminaison privé auquel la connexion appartient.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la dernière ressource.

lastModifiedByType

createdByType

Type d’identité qui a modifié la dernière ressource.

UserAssignedIdentity

Propriétés d’identité attribuées par l’utilisateur

Nom Type Description
clientId

string

ID client de l’identité affectée.

principalId

string

ID principal de l’identité affectée.