Delen via


Clusters - Get

Hiermee haalt u informatie op over een cluster, zoals reken- en opslagconfiguratie en metagegevens van de levenscyclus van het cluster, zoals de datum en tijd waarop het cluster is gemaakt.

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

URI-parameters

Name In Vereist Type Description
clusterName
path True

string

De naam van het cluster.

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

resourceGroupName
path True

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

subscriptionId
path True

string

uuid

De id van het doelabonnement. De waarde moet een UUID zijn.

api-version
query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name Type Description
200 OK

Cluster

OK

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Imiteer uw gebruikersaccount.

Voorbeelden

Get the cluster

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
AadEnabledEnum

Hiermee wordt aangegeven of het cluster is gemaakt met behulp van AAD-verificatie.

ActiveDirectoryAuth
AuthConfig

Verificatieconfiguratie van een cluster.

Cluster

Vertegenwoordigt een cluster.

createdByType

Het type identiteit waarmee de resource is gemaakt.

DataEncryption

De gegevensversleutelingseigenschappen van een cluster.

DataEncryptionType
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

IdentityProperties

Beschrijft de identiteit van het cluster.

IdentityType
MaintenanceWindow

Planningsinstellingen voor reguliere clusterupdates.

PasswordAuth
PasswordEnabledEnum

Geeft aan of het cluster is gemaakt met een wachtwoord of met behulp van AAD-verificatie.

PrivateEndpointProperty

Eigenschap voor resource-id van het privé-eindpunt.

PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.

ServerNameItem

Het naamobject voor een server.

SimplePrivateEndpointConnection

Een privé-eindpuntverbinding.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

UserAssignedIdentity

Eigenschappen van door de gebruiker toegewezen identiteit

AadEnabledEnum

Hiermee wordt aangegeven of het cluster is gemaakt met behulp van AAD-verificatie.

Name Type Description
disabled

string

enabled

string

ActiveDirectoryAuth

Name Type Description
disabled

string

enabled

string

AuthConfig

Verificatieconfiguratie van een cluster.

Name Type Description
activeDirectoryAuth

ActiveDirectoryAuth

passwordAuth

PasswordAuth

Cluster

Vertegenwoordigt een cluster.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

IdentityProperties

Beschrijft de identiteit van het cluster.

location

string

De geografische locatie waar de resource zich bevindt

name

string

De naam van de resource

properties.aadAuthEnabled

AadEnabledEnum

Hiermee wordt aangegeven of het cluster is gemaakt met behulp van AAD-verificatie.

properties.administratorLogin

string

De aanmeldingsnaam van de beheerder van de servers in het cluster.

properties.administratorLoginPassword

string

Het wachtwoord van de beheerdersaanmelding. Vereist voor het maken.

properties.authConfig

AuthConfig

Verificatieconfiguratie van een cluster.

properties.citusVersion

string

De Versie van de Citus-extensie op alle clusterservers.

properties.coordinatorEnablePublicIpAccess

boolean

Als openbare toegang is ingeschakeld voor de coördinator.

properties.coordinatorServerEdition

string

De editie van een coördinatorserver (standaard: GeneralPurpose). Vereist voor het maken.

properties.coordinatorStorageQuotaInMb

integer

De opslag van een server in MB. Vereist voor het maken. Zie https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute voor meer informatie.

properties.coordinatorVCores

integer

Het aantal vCores van een server (max: 96). Vereist voor het maken. Zie https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute voor meer informatie.

properties.dataEncryption

DataEncryption

De gegevensversleutelingseigenschappen van een cluster.

properties.databaseName

string

De databasenaam van het cluster. Er wordt slechts één database per cluster ondersteund.

properties.earliestRestoreTime

string

De vroegste herstelpunttijd (ISO8601-indeling) voor het cluster.

properties.enableGeoBackup

boolean

Als de back-up van het cluster wordt opgeslagen in een andere Azure-regio naast de kopie van de back-up die is opgeslagen in de regio van het cluster. Alleen ingeschakeld op het moment dat het cluster wordt gemaakt.

properties.enableHa

boolean

Of hoge beschikbaarheid (HA) is ingeschakeld voor het cluster.

properties.enableShardsOnCoordinator

boolean

Als gedistribueerde tabellen al dan niet op de coördinator worden geplaatst. Moet worden ingesteld op 'true' voor clusters met één knooppunt. Vereist opnieuw verdelen van shards nadat de waarde is gewijzigd.

properties.maintenanceWindow

MaintenanceWindow

Onderhoudsvenster van een cluster.

properties.nodeCount

integer

Aantal werkknooppunten van het cluster. Wanneer het aantal knooppunten 0 is, vertegenwoordigt dit een configuratie van één knooppunt met de mogelijkheid om gedistribueerde tabellen op dat knooppunt te maken. Twee of meer werkknooppunten vertegenwoordigen configuratie met meerdere knooppunten. De waarde van het aantal knooppunten kan niet 1 zijn. Vereist voor het maken.

properties.nodeEnablePublicIpAccess

boolean

Als openbare toegang is ingeschakeld op werkknooppunten.

properties.nodeServerEdition

string

De editie van een knooppuntserver (standaard: MemoryOptimized).

properties.nodeStorageQuotaInMb

integer

De opslag in MB op elk werkknooppunt. Zie https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute voor meer informatie.

properties.nodeVCores

integer

De berekening in vCores op elk werkknooppunt (max: 104). Zie https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute voor meer informatie.

properties.passwordEnabled

PasswordEnabledEnum

Geeft aan of het cluster is gemaakt met een wachtwoord of met behulp van AAD-verificatie.

properties.pointInTimeUTC

string

Datum en tijd in UTC (ISO8601-indeling) voor clusterherstel.

properties.postgresqlVersion

string

De primaire PostgreSQL-versie op alle clusterservers.

properties.preferredPrimaryZone

string

Voorkeurszone voor primaire beschikbaarheid (AZ) voor alle clusterservers.

properties.privateEndpointConnections

SimplePrivateEndpointConnection[]

De privé-eindpuntverbindingen voor een cluster.

properties.provisioningState

string

Inrichtingsstatus van het cluster

properties.readReplicas

string[]

De matrix met leesreplicaclusters.

properties.serverNames

ServerNameItem[]

De lijst met servernamen in het cluster

properties.sourceLocation

string

De Azure-regio van het broncluster voor leesreplicaclusters.

properties.sourceResourceId

string

De resource-id van het broncluster voor leesreplicaclusters.

properties.state

string

Een status van een cluster/server die zichtbaar is voor de gebruiker.

systemData

systemData

Azure Resource Manager metagegevens met informatie over createdBy en modifiedBy.

tags

object

Resourcetags.

type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataEncryption

De gegevensversleutelingseigenschappen van een cluster.

Name Type Description
primaryKeyUri

string

URI voor de sleutel in keyvault voor gegevensversleuteling van de primaire server.

primaryUserAssignedIdentityId

string

Resource-id voor de door de gebruiker toegewezen identiteit die moet worden gebruikt voor gegevensversleuteling van de primaire server.

type

DataEncryptionType

DataEncryptionType

Name Type Description
AzureKeyVault

string

SystemAssigned

string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout aanvullende informatie.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

IdentityProperties

Beschrijft de identiteit van het cluster.

Name Type Description
type

IdentityType

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned identiteiten
De set door de gebruiker toegewezen identiteiten die aan de resource zijn gekoppeld. De userAssignedIdentities-woordenlijstsleutels zijn ARM-resource-id's in de volgende notatie: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. De woordenlijstwaarden kunnen lege objecten ({}) in aanvragen zijn.

IdentityType

Name Type Description
SystemAssigned

string

UserAssigned

string

MaintenanceWindow

Planningsinstellingen voor reguliere clusterupdates.

Name Type Description
customWindow

string

Geeft aan of het aangepaste onderhoudsvenster is ingeschakeld of niet.

dayOfWeek

integer

Voorkeursdag van de week voor onderhoudsvenster.

startHour

integer

Begintijd binnen de voorkeursdag van de week voor het onderhoudsvenster.

startMinute

integer

Begin minuut binnen het beginuur voor het onderhoudsvenster.

PasswordAuth

Name Type Description
disabled

string

enabled

string

PasswordEnabledEnum

Geeft aan of het cluster is gemaakt met een wachtwoord of met behulp van AAD-verificatie.

Name Type Description
disabled

string

enabled

string

PrivateEndpointProperty

Eigenschap voor resource-id van het privé-eindpunt.

Name Type Description
id

string

Resource-id van het privé-eindpunt.

PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.

Name Type Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.

Name Type Description
actionsRequired

string

Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates van de consument vereisen.

description

string

De reden voor goedkeuring/afwijzing van de verbinding.

status

PrivateEndpointServiceConnectionStatus

Hiermee wordt aangegeven of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.

ServerNameItem

Het naamobject voor een server.

Name Type Description
fullyQualifiedDomainName

string

De volledig gekwalificeerde domeinnaam van een server.

name

string

De naam van een server.

SimplePrivateEndpointConnection

Een privé-eindpuntverbinding.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

De naam van de resource

properties.groupIds

string[]

Groeps-id's van de privé-eindpuntverbinding.

properties.privateEndpoint

PrivateEndpointProperty

Privé-eindpunt waartoe de verbinding behoort.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.

systemData

systemData

Azure Resource Manager metagegevens met informatie over createdBy en modifiedBy.

type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name Type Description
createdAt

string

De tijdstempel van het maken van resources (UTC).

createdBy

string

De identiteit die de resource heeft gemaakt.

createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.

lastModifiedAt

string

Het tijdstempel van de laatste wijziging van de resource (UTC)

lastModifiedBy

string

De identiteit die de resource het laatst heeft gewijzigd.

lastModifiedByType

createdByType

Het type identiteit dat de resource het laatst heeft gewijzigd.

UserAssignedIdentity

Eigenschappen van door de gebruiker toegewezen identiteit

Name Type Description
clientId

string

De client-id van de toegewezen identiteit.

principalId

string

De principal-id van de toegewezen identiteit.