Megosztás a következőn keresztül:


Clusters - Get

Információt kap egy fürtről, például a számítási és tárolási konfigurációról, valamint a fürt életciklusának metaadatairól, például a fürt létrehozásának dátumáról és időpontjáról.

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

URI-paraméterek

Name In Kötelező Típus Description
clusterName
path True

string

A fürt neve.

Reguláris kifejezési minta: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$

resourceGroupName
path True

string

Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.

subscriptionId
path True

string

uuid

A cél-előfizetés azonosítója. Az értéknek UUID azonosítónak kell lennie.

api-version
query True

string

A művelethez használandó API-verzió.

Válaszok

Name Típus Description
200 OK

Cluster

OK

Other Status Codes

ErrorResponse

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation A felhasználói fiók megszemélyesítése.

Példák

Get the cluster

Mintakérelem

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

Mintaválasz

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

Definíciók

Name Description
AadEnabledEnum

Azt jelzi, hogy a fürt AAD-hitelesítéssel lett-e létrehozva.

ActiveDirectoryAuth
AuthConfig

Fürt hitelesítési konfigurációja.

Cluster

Egy fürtöt jelöl.

createdByType

Az erőforrást létrehozó identitás típusa.

DataEncryption

A fürt adattitkosítási tulajdonságai.

DataEncryptionType
ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

ErrorDetail

A hiba részletei.

ErrorResponse

Hibaválasz

IdentityProperties

A fürt identitását ismerteti.

IdentityType
MaintenanceWindow

Rendszeres fürtfrissítések ütemezési beállításai.

PasswordAuth
PasswordEnabledEnum

Azt jelzi, hogy a fürt jelszóval vagy AAD-hitelesítéssel lett-e létrehozva.

PrivateEndpointProperty

A privát végpont erőforrás-azonosítóját képviselő tulajdonság.

PrivateEndpointServiceConnectionStatus

A privát végpont kapcsolati állapota.

PrivateLinkServiceConnectionState

A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.

ServerNameItem

A kiszolgáló névobjektuma.

SimplePrivateEndpointConnection

Privát végponti kapcsolat.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

UserAssignedIdentity

Felhasználó által hozzárendelt identitás tulajdonságai

AadEnabledEnum

Azt jelzi, hogy a fürt AAD-hitelesítéssel lett-e létrehozva.

Name Típus Description
disabled

string

enabled

string

ActiveDirectoryAuth

Name Típus Description
disabled

string

enabled

string

AuthConfig

Fürt hitelesítési konfigurációja.

Name Típus Description
activeDirectoryAuth

ActiveDirectoryAuth

passwordAuth

PasswordAuth

Cluster

Egy fürtöt jelöl.

Name Típus Description
id

string

Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

IdentityProperties

A fürt identitását ismerteti.

location

string

A földrajzi hely, ahol az erőforrás él

name

string

Az erőforrás neve

properties.aadAuthEnabled

AadEnabledEnum

Azt jelzi, hogy a fürt AAD-hitelesítéssel lett-e létrehozva.

properties.administratorLogin

string

A fürt kiszolgálóinak rendszergazdai bejelentkezési neve.

properties.administratorLoginPassword

string

A rendszergazdai bejelentkezés jelszava. A létrehozáshoz szükséges.

properties.authConfig

AuthConfig

Fürt hitelesítési konfigurációja.

properties.citusVersion

string

A Citus-bővítmény verziója az összes fürtkiszolgálón.

properties.coordinatorEnablePublicIpAccess

boolean

Ha a koordinátoron engedélyezve van a nyilvános hozzáférés.

properties.coordinatorServerEdition

string

A koordinátor-kiszolgáló kiadása (alapértelmezett: GeneralPurpose). A létrehozáshoz szükséges.

properties.coordinatorStorageQuotaInMb

integer

A kiszolgáló tárolása MB-ban. A létrehozáshoz szükséges. További információ: https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.coordinatorVCores

integer

Egy kiszolgáló virtuális magjainak száma (max. 96). A létrehozáshoz szükséges. További információ: https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.dataEncryption

DataEncryption

A fürt adattitkosítási tulajdonságai.

properties.databaseName

string

A fürt adatbázisneve. Fürtönként csak egy adatbázis támogatott.

properties.earliestRestoreTime

string

A fürt legkorábbi visszaállítási időpontja (ISO8601 formátuma).

properties.enableGeoBackup

boolean

Ha a fürt biztonsági mentése egy másik Azure-régióban van tárolva a fürt régiójában tárolt biztonsági másolaton kívül. Csak a fürt létrehozásakor engedélyezett.

properties.enableHa

boolean

Ha a magas rendelkezésre állás (HA) engedélyezve van vagy nincs a fürtön.

properties.enableShardsOnCoordinator

boolean

Ha elosztott táblák vannak elhelyezve a koordinátoron, vagy sem. Egycsomópontos fürtökön "true" (igaz) értékre kell állítani. A szegmensek újraegyensúlyozását igényli az érték módosítása után.

properties.maintenanceWindow

MaintenanceWindow

Fürt karbantartási időszaka.

properties.nodeCount

integer

A fürt munkavégző csomópontjainak száma. Ha a csomópontok száma 0, egyetlen csomópont-konfigurációt jelöl, amely képes elosztott táblákat létrehozni az adott csomóponton. 2 vagy több munkavégző csomópont több csomópontos konfigurációt jelöl. A csomópontok száma nem lehet 1. A létrehozáshoz szükséges.

properties.nodeEnablePublicIpAccess

boolean

Ha a nyilvános hozzáférés engedélyezve van a munkavégző csomópontokon.

properties.nodeServerEdition

string

A csomópontkiszolgáló kiadása (alapértelmezett: MemoryOptimized).

properties.nodeStorageQuotaInMb

integer

A tárterület MB-ban az egyes munkavégző csomópontokon. További információ: https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.nodeVCores

integer

A számítás virtuális magokban az egyes munkavégző csomópontokon (max. 104). További információ: https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.passwordEnabled

PasswordEnabledEnum

Azt jelzi, hogy a fürt jelszóval vagy AAD-hitelesítéssel lett-e létrehozva.

properties.pointInTimeUTC

string

Dátum és idő (UTC) (ISO8601 formátumban) a fürt visszaállításához.

properties.postgresqlVersion

string

A Fő PostgreSQL-verzió az összes fürtkiszolgálón.

properties.preferredPrimaryZone

string

Elsődleges rendelkezésre állási zóna (AZ) az összes fürtkiszolgálóhoz.

properties.privateEndpointConnections

SimplePrivateEndpointConnection[]

A fürt privát végponti kapcsolatai.

properties.provisioningState

string

A fürt kiépítési állapota

properties.readReplicas

string[]

Az olvasási replikafürtök tömbje.

properties.serverNames

ServerNameItem[]

A fürtben lévő kiszolgálónevek listája

properties.sourceLocation

string

Az olvasási replikafürtök forrásfürtjének Azure-régiója.

properties.sourceResourceId

string

Az olvasási replikafürtök forrásfürtjének erőforrás-azonosítója.

properties.state

string

A felhasználó számára látható fürt/kiszolgáló állapota.

systemData

systemData

Az Azure Resource Manager createdBy és modifiedBy adatokat tartalmazó metaadatokat.

tags

object

Erőforráscímkék.

type

string

Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

createdByType

Az erőforrást létrehozó identitás típusa.

Name Típus Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataEncryption

A fürt adattitkosítási tulajdonságai.

Name Típus Description
primaryKeyUri

string

A keyvault kulcsának URI-ja az elsődleges kiszolgáló adattitkosításához.

primaryUserAssignedIdentityId

string

Az elsődleges kiszolgáló adattitkosításához használandó felhasználó által hozzárendelt identitás erőforrás-azonosítója.

type

DataEncryptionType

DataEncryptionType

Name Típus Description
AzureKeyVault

string

SystemAssigned

string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name Típus Description
info

object

A további információk.

type

string

A további adattípus.

ErrorDetail

A hiba részletei.

Name Típus Description
additionalInfo

ErrorAdditionalInfo[]

A hiba további információi.

code

string

A hibakód.

details

ErrorDetail[]

A hiba részletei.

message

string

A hibaüzenet.

target

string

A hiba célja.

ErrorResponse

Hibaválasz

Name Típus Description
error

ErrorDetail

A hibaobjektum.

IdentityProperties

A fürt identitását ismerteti.

Name Típus Description
type

IdentityType

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned-identitások
Az erőforráshoz társított felhasználó által hozzárendelt identitások halmaza. A userAssignedIdentities szótárkulcsok ARM-erőforrás-azonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. A szótárértékek üres objektumok ({}) lehetnek a kérésekben.

IdentityType

Name Típus Description
SystemAssigned

string

UserAssigned

string

MaintenanceWindow

Rendszeres fürtfrissítések ütemezési beállításai.

Name Típus Description
customWindow

string

Azt jelzi, hogy engedélyezve van-e az egyéni karbantartási időszak.

dayOfWeek

integer

A hét előnyben részesített napja a karbantartási időszakhoz.

startHour

integer

Kezdési óra a hét előnyben részesített napján belül karbantartási időszak esetén.

startMinute

integer

A karbantartási időszak kezdési perce a kezdési órán belül.

PasswordAuth

Name Típus Description
disabled

string

enabled

string

PasswordEnabledEnum

Azt jelzi, hogy a fürt jelszóval vagy AAD-hitelesítéssel lett-e létrehozva.

Name Típus Description
disabled

string

enabled

string

PrivateEndpointProperty

A privát végpont erőforrás-azonosítóját képviselő tulajdonság.

Name Típus Description
id

string

A privát végpont erőforrás-azonosítója.

PrivateEndpointServiceConnectionStatus

A privát végpont kapcsolati állapota.

Name Típus Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.

Name Típus Description
actionsRequired

string

Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.

description

string

A kapcsolat jóváhagyásának/elutasításának oka.

status

PrivateEndpointServiceConnectionStatus

Azt jelzi, hogy a szolgáltatás tulajdonosa jóváhagyta/elutasította/eltávolította-e a kapcsolatot.

ServerNameItem

A kiszolgáló névobjektuma.

Name Típus Description
fullyQualifiedDomainName

string

A kiszolgáló teljes tartományneve.

name

string

A kiszolgáló neve.

SimplePrivateEndpointConnection

Privát végponti kapcsolat.

Name Típus Description
id

string

Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Az erőforrás neve

properties.groupIds

string[]

A privát végponti kapcsolat csoportazonosítói.

properties.privateEndpoint

PrivateEndpointProperty

Privát végpont, amelyhez a kapcsolat tartozik.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.

systemData

systemData

Az Azure Resource Manager createdBy és modifiedBy adatokat tartalmazó metaadatokat.

type

string

Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name Típus Description
createdAt

string

Az erőforrás-létrehozás időbélyege (UTC).

createdBy

string

Az erőforrást létrehozó identitás.

createdByType

createdByType

Az erőforrást létrehozó identitás típusa.

lastModifiedAt

string

Az erőforrás utolsó módosításának időbélyege (UTC)

lastModifiedBy

string

Az erőforrást utoljára módosító identitás.

lastModifiedByType

createdByType

Az erőforrást legutóbb módosító identitás típusa.

UserAssignedIdentity

Felhasználó által hozzárendelt identitás tulajdonságai

Name Típus Description
clientId

string

A hozzárendelt identitás ügyfél-azonosítója.

principalId

string

A hozzárendelt identitás egyszerű azonosítója.