Sdílet prostřednictvím


Clusters - Get

Získá informace o clusteru, jako je konfigurace výpočetních prostředků a úložiště a metadata životního cyklu clusteru, jako je datum a čas vytvoření clusteru.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
clusterName
path True

string

Název clusteru.

Vzor regulárního výrazu: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$

resourceGroupName
path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

subscriptionId
path True

string

uuid

ID cílového předplatného. Hodnota musí být UUID.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

Cluster

OK

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation Zosobněte svůj uživatelský účet.

Příklady

Get the cluster

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
AadEnabledEnum

Určuje, jestli se cluster vytvořil pomocí ověřování AAD.

ActiveDirectoryAuth
AuthConfig

Konfigurace ověřování clusteru.

Cluster

Představuje cluster.

createdByType

Typ identity, která prostředek vytvořila.

DataEncryption

Vlastnosti šifrování dat clusteru.

DataEncryptionType
ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě

ErrorResponse

Chybová odpověď

IdentityProperties

Popisuje identitu clusteru.

IdentityType
MaintenanceWindow

Nastavení plánu pro pravidelné aktualizace clusteru

PasswordAuth
PasswordEnabledEnum

Určuje, jestli se cluster vytvořil pomocí hesla nebo pomocí ověřování AAD.

PrivateEndpointProperty

Vlastnost představující ID prostředku privátního koncového bodu.

PrivateEndpointServiceConnectionStatus

Stav připojení privátního koncového bodu.

PrivateLinkServiceConnectionState

Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem.

ServerNameItem

Objekt názvu serveru.

SimplePrivateEndpointConnection

Připojení privátního koncového bodu.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

UserAssignedIdentity

Vlastnosti identity přiřazené uživatelem

AadEnabledEnum

Určuje, jestli se cluster vytvořil pomocí ověřování AAD.

Name Typ Description
disabled

string

enabled

string

ActiveDirectoryAuth

Name Typ Description
disabled

string

enabled

string

AuthConfig

Konfigurace ověřování clusteru.

Name Typ Description
activeDirectoryAuth

ActiveDirectoryAuth

passwordAuth

PasswordAuth

Cluster

Představuje cluster.

Name Typ Description
id

string

Plně kvalifikované ID prostředku Například /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{název_poskytovatele_prostředku}/{typ_prostředku}/{název_prostředku}.

identity

IdentityProperties

Popisuje identitu clusteru.

location

string

Geografické umístění, kde se prostředek nachází

name

string

Název prostředku

properties.aadAuthEnabled

AadEnabledEnum

Určuje, jestli se cluster vytvořil pomocí ověřování AAD.

properties.administratorLogin

string

Přihlašovací jméno správce serverů v clusteru.

properties.administratorLoginPassword

string

Heslo přihlášení správce. Vyžaduje se pro vytvoření.

properties.authConfig

AuthConfig

Konfigurace ověřování clusteru.

properties.citusVersion

string

Verze rozšíření Citus na všech serverech clusteru.

properties.coordinatorEnablePublicIpAccess

boolean

Pokud je v koordinátoru povolený veřejný přístup.

properties.coordinatorServerEdition

string

Edice koordinačního serveru (výchozí hodnota: GeneralPurpose). Vyžaduje se pro vytvoření.

properties.coordinatorStorageQuotaInMb

integer

Úložiště serveru v MB. Vyžaduje se pro vytvoření. Další informace naleznete v tématu https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.coordinatorVCores

integer

Počet virtuálních jader serveru (max. 96). Vyžaduje se pro vytvoření. Další informace naleznete v tématu https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.dataEncryption

DataEncryption

Vlastnosti šifrování dat clusteru.

properties.databaseName

string

Název databáze clusteru. Podporuje se pouze jedna databáze na cluster.

properties.earliestRestoreTime

string

Nejstarší čas bodu obnovení (ISO8601 formát) clusteru.

properties.enableGeoBackup

boolean

Pokud se záloha clusteru kromě kopie zálohy uložené v oblasti clusteru ukládá v jiné oblasti Azure. Povoleno pouze v době vytváření clusteru.

properties.enableHa

boolean

Jestli je pro cluster povolená vysoká dostupnost nebo ne.

properties.enableShardsOnCoordinator

boolean

Jestli jsou distribuované tabulky umístěné v koordinátoru, nebo ne. V clusterech s jedním uzlem by měla být nastavená hodnota true. Vyžaduje opětovné vyrovnání horizontálních oddílů po změně hodnoty.

properties.maintenanceWindow

MaintenanceWindow

Časové období údržby clusteru.

properties.nodeCount

integer

Počet pracovních uzlů clusteru. Pokud je počet uzlů 0, představuje konfiguraci s jedním uzlem s možností vytvářet distribuované tabulky na daném uzlu. 2 nebo více pracovních uzlů představují konfiguraci s více uzly. Hodnota počtu uzlů nemůže být 1. Vyžaduje se pro vytvoření.

properties.nodeEnablePublicIpAccess

boolean

Pokud je na pracovních uzlech povolený veřejný přístup.

properties.nodeServerEdition

string

Edice serveru uzlu (výchozí: MemoryOptimized).

properties.nodeStorageQuotaInMb

integer

Úložiště v MB na každém pracovním uzlu. Další informace naleznete v tématu https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.nodeVCores

integer

Výpočetní prostředky v počtu virtuálních jader na každém pracovním uzlu (max. 104). Další informace naleznete v tématu https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.passwordEnabled

PasswordEnabledEnum

Určuje, jestli se cluster vytvořil pomocí hesla nebo pomocí ověřování AAD.

properties.pointInTimeUTC

string

Datum a čas obnovení clusteru ve formátu UTC (ISO8601).

properties.postgresqlVersion

string

Hlavní verze PostgreSQL na všech serverech clusteru.

properties.preferredPrimaryZone

string

Upřednostňovaná primární zóna dostupnosti (AZ) pro všechny servery clusteru

properties.privateEndpointConnections

SimplePrivateEndpointConnection[]

Připojení privátních koncových bodů pro cluster.

properties.provisioningState

string

Stav zřizování clusteru

properties.readReplicas

string[]

Pole clusterů replik pro čtení.

properties.serverNames

ServerNameItem[]

Seznam názvů serverů v clusteru

properties.sourceLocation

string

Oblast Azure zdrojového clusteru pro clustery replik pro čtení.

properties.sourceResourceId

string

ID prostředku zdrojového clusteru pro clustery replik pro čtení.

properties.state

string

Stav clusteru nebo serveru, který je viditelný pro uživatele.

systemData

systemData

Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.

tags

object

Značky prostředků.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

createdByType

Typ identity, která prostředek vytvořila.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataEncryption

Vlastnosti šifrování dat clusteru.

Name Typ Description
primaryKeyUri

string

Identifikátor URI klíče v trezoru klíčů pro šifrování dat primárního serveru

primaryUserAssignedIdentityId

string

ID prostředku pro identitu přiřazenou uživatelem, která se má použít k šifrování dat primárního serveru.

type

DataEncryptionType

DataEncryptionType

Name Typ Description
AzureKeyVault

string

SystemAssigned

string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.

code

string

Kód chyby

details

ErrorDetail[]

Podrobnosti o chybě.

message

string

Chybová zpráva

target

string

Cíl chyby.

ErrorResponse

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.

IdentityProperties

Popisuje identitu clusteru.

Name Typ Description
type

IdentityType

userAssignedIdentities

<string,  UserAssignedIdentity>

identity User-Assigned
Sada identit přiřazených uživatelem přidružených k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formátu /subscriptions/{subscriptionId}/resourceGroups/{název_skupiny_prostředků}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích.

IdentityType

Name Typ Description
SystemAssigned

string

UserAssigned

string

MaintenanceWindow

Nastavení plánu pro pravidelné aktualizace clusteru

Name Typ Description
customWindow

string

Určuje, jestli je povolené vlastní časové období údržby.

dayOfWeek

integer

Upřednostňovaný den v týdnu pro časové období údržby.

startHour

integer

Počáteční hodina v upřednostňovaném dni v týdnu pro časové období údržby.

startMinute

integer

Počáteční minuta v počáteční hodině pro časové období údržby.

PasswordAuth

Name Typ Description
disabled

string

enabled

string

PasswordEnabledEnum

Určuje, jestli se cluster vytvořil pomocí hesla nebo pomocí ověřování AAD.

Name Typ Description
disabled

string

enabled

string

PrivateEndpointProperty

Vlastnost představující ID prostředku privátního koncového bodu.

Name Typ Description
id

string

ID prostředku privátního koncového bodu

PrivateEndpointServiceConnectionStatus

Stav připojení privátního koncového bodu.

Name Typ Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem.

Name Typ Description
actionsRequired

string

Zpráva s informacemi o tom, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.

description

string

Důvod schválení nebo zamítnutí připojení.

status

PrivateEndpointServiceConnectionStatus

Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.

ServerNameItem

Objekt názvu serveru.

Name Typ Description
fullyQualifiedDomainName

string

Plně kvalifikovaný název domény serveru.

name

string

Název serveru.

SimplePrivateEndpointConnection

Připojení privátního koncového bodu.

Name Typ Description
id

string

Plně kvalifikované ID prostředku Například /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{název_poskytovatele_prostředku}/{typ_prostředku}/{název_prostředku}.

name

string

Název prostředku

properties.groupIds

string[]

ID skupin připojení privátního koncového bodu

properties.privateEndpoint

PrivateEndpointProperty

Privátní koncový bod, ke kterému připojení patří.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem.

systemData

systemData

Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string

Časové razítko vytvoření prostředku (UTC)

createdBy

string

Identita, která vytvořila prostředek.

createdByType

createdByType

Typ identity, která prostředek vytvořila.

lastModifiedAt

string

Časové razítko poslední změny prostředku (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.

UserAssignedIdentity

Vlastnosti identity přiřazené uživatelem

Name Typ Description
clientId

string

ID klienta přiřazené identity.

principalId

string

ID objektu zabezpečení přiřazené identity.