Servers - List By Cluster

Referencia

Szolgáltatás:: Cosmos DB for PostgreSQL

API-verzió:: 2023-03-02-preview

Egy fürt kiszolgálóinak listája.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
clusterName	path	True	string minLength: 3 maxLength: 40 pattern: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?	A klaszter neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem 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-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	ClusterServerListResult	OKÉ
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

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	Megszemélyesítse a felhasználói fiókját.

Példák

List servers of the cluster

Mintakérelem

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


/**
 * Samples for Servers ListByCluster.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/
     * ServerListByCluster.json
     */
    /**
     * Sample code: List servers of the cluster.
     * 
     * @param manager Entry point to CosmosDBForPostgreSqlManager.
     */
    public static void
        listServersOfTheCluster(com.azure.resourcemanager.cosmosdbforpostgresql.CosmosDBForPostgreSqlManager manager) {
        manager.servers().listByCluster("TestGroup", "testcluster1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdbforpostgresql import CosmosdbForPostgresqlMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdbforpostgresql
# USAGE
    python server_list_by_cluster.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosdbForPostgresqlMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.list_by_cluster(
        resource_group_name="TestGroup",
        cluster_name="testcluster1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ServerListByCluster.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmosforpostgresql_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmosforpostgresql/armcosmosforpostgresql"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ServerListByCluster.json
func ExampleServersClient_NewListByClusterPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmosforpostgresql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewServersClient().NewListByClusterPager("TestGroup", "testcluster1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ClusterServerListResult = armcosmosforpostgresql.ClusterServerListResult{
		// 	Value: []*armcosmosforpostgresql.ClusterServer{
		// 		{
		// 			Name: to.Ptr("testcluster1-c"),
		// 			Type: to.Ptr("Microsoft.DBforPostgreSQL/serverGroupsv2/servers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1/servers/testcluster1-c"),
		// 			SystemData: &armcosmosforpostgresql.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
		// 				CreatedBy: to.Ptr("user1"),
		// 				CreatedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("user2"),
		// 				LastModifiedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
		// 			},
		// 			Properties: &armcosmosforpostgresql.ClusterServerProperties{
		// 				AdministratorLogin: to.Ptr("citus"),
		// 				EnableHa: to.Ptr(true),
		// 				EnablePublicIPAccess: to.Ptr(true),
		// 				IsReadOnly: to.Ptr(false),
		// 				ServerEdition: to.Ptr("MemoryOptimized"),
		// 				StorageQuotaInMb: to.Ptr[int32](10000),
		// 				VCores: to.Ptr[int32](4),
		// 				AvailabilityZone: to.Ptr("1"),
		// 				CitusVersion: to.Ptr("9.5"),
		// 				FullyQualifiedDomainName: to.Ptr("testcluster1-c.postgres.database.azure.com"),
		// 				HaState: to.Ptr("Healthy"),
		// 				PostgresqlVersion: to.Ptr("12"),
		// 				Role: to.Ptr(armcosmosforpostgresql.ServerRoleCoordinator),
		// 				State: to.Ptr("Ready"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("testcluster1-w0"),
		// 			Type: to.Ptr("Microsoft.DBforPostgreSQL/serverGroupsv2/servers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1/servers/testcluster1-w0"),
		// 			SystemData: &armcosmosforpostgresql.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
		// 				CreatedBy: to.Ptr("user1"),
		// 				CreatedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("user2"),
		// 				LastModifiedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
		// 			},
		// 			Properties: &armcosmosforpostgresql.ClusterServerProperties{
		// 				AdministratorLogin: to.Ptr("citus"),
		// 				EnableHa: to.Ptr(false),
		// 				EnablePublicIPAccess: to.Ptr(false),
		// 				IsReadOnly: to.Ptr(false),
		// 				ServerEdition: to.Ptr("MemoryOptimized"),
		// 				StorageQuotaInMb: to.Ptr[int32](10000),
		// 				VCores: to.Ptr[int32](4),
		// 				AvailabilityZone: to.Ptr("1"),
		// 				CitusVersion: to.Ptr("9.5"),
		// 				FullyQualifiedDomainName: to.Ptr("testcluster1-w0.postgres.database.azure.com"),
		// 				HaState: to.Ptr("NotEnabled"),
		// 				PostgresqlVersion: to.Ptr("12"),
		// 				Role: to.Ptr(armcosmosforpostgresql.ServerRoleWorker),
		// 				State: to.Ptr("Ready"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("testcluster1-w1"),
		// 			Type: to.Ptr("Microsoft.DBforPostgreSQL/serverGroupsv2/servers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1/servers/testcluster1-w1"),
		// 			SystemData: &armcosmosforpostgresql.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
		// 				CreatedBy: to.Ptr("user1"),
		// 				CreatedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("user2"),
		// 				LastModifiedByType: to.Ptr(armcosmosforpostgresql.CreatedByTypeUser),
		// 			},
		// 			Properties: &armcosmosforpostgresql.ClusterServerProperties{
		// 				AdministratorLogin: to.Ptr("citus"),
		// 				EnableHa: to.Ptr(false),
		// 				EnablePublicIPAccess: to.Ptr(false),
		// 				IsReadOnly: to.Ptr(false),
		// 				ServerEdition: to.Ptr("MemoryOptimized"),
		// 				StorageQuotaInMb: to.Ptr[int32](10000),
		// 				VCores: to.Ptr[int32](4),
		// 				AvailabilityZone: to.Ptr("1"),
		// 				CitusVersion: to.Ptr("9.5"),
		// 				FullyQualifiedDomainName: to.Ptr("testcluster1-w1.postgres.database.azure.com"),
		// 				HaState: to.Ptr("NotEnabled"),
		// 				PostgresqlVersion: to.Ptr("12"),
		// 				Role: to.Ptr(armcosmosforpostgresql.ServerRoleWorker),
		// 				State: to.Ptr("Ready"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBForPostgreSQL } = require("@azure/arm-cosmosdbforpostgresql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists servers of a cluster.
 *
 * @summary Lists servers of a cluster.
 * x-ms-original-file: specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ServerListByCluster.json
 */
async function listServersOfTheCluster() {
  const subscriptionId =
    process.env["COSMOSFORPOSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["COSMOSFORPOSTGRESQL_RESOURCE_GROUP"] || "TestGroup";
  const clusterName = "testcluster1";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBForPostgreSQL(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.servers.listByCluster(resourceGroupName, clusterName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1/servers/testcluster1-c",
      "name": "testcluster1-c",
      "type": "Microsoft.DBforPostgreSQL/serverGroupsv2/servers",
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "properties": {
        "fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com",
        "postgresqlVersion": "12",
        "citusVersion": "9.5",
        "availabilityZone": "1",
        "role": "Coordinator",
        "serverEdition": "MemoryOptimized",
        "storageQuotaInMb": 10000,
        "vCores": 4,
        "enableHa": true,
        "enablePublicIpAccess": true,
        "state": "Ready",
        "haState": "Healthy",
        "administratorLogin": "citus",
        "isReadOnly": false
      }
    },
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1/servers/testcluster1-w0",
      "name": "testcluster1-w0",
      "type": "Microsoft.DBforPostgreSQL/serverGroupsv2/servers",
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "properties": {
        "fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com",
        "postgresqlVersion": "12",
        "citusVersion": "9.5",
        "availabilityZone": "1",
        "role": "Worker",
        "serverEdition": "MemoryOptimized",
        "storageQuotaInMb": 10000,
        "vCores": 4,
        "enableHa": false,
        "enablePublicIpAccess": false,
        "state": "Ready",
        "haState": "NotEnabled",
        "administratorLogin": "citus",
        "isReadOnly": false
      }
    },
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1/servers/testcluster1-w1",
      "name": "testcluster1-w1",
      "type": "Microsoft.DBforPostgreSQL/serverGroupsv2/servers",
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "properties": {
        "fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com",
        "postgresqlVersion": "12",
        "citusVersion": "9.5",
        "availabilityZone": "1",
        "role": "Worker",
        "serverEdition": "MemoryOptimized",
        "storageQuotaInMb": 10000,
        "vCores": 4,
        "enableHa": false,
        "enablePublicIpAccess": false,
        "state": "Ready",
        "haState": "NotEnabled",
        "administratorLogin": "citus",
        "isReadOnly": false
      }
    }
  ]
}

Definíciók

Name	Description
ClusterServer	Fürtön lévő kiszolgálót jelöl.
ClusterServerListResult	Egy fürt kiszolgálóinak listája.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ServerRole	A kiszolgáló szerepe.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

ClusterServer

Objektum

Fürtön lévő kiszolgálót jelöl.

Name	Típus	Description
id	string (arm-id)	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.administratorLogin	string	A fürt kiszolgálóinak rendszergazdai bejelentkezési neve.
properties.availabilityZone	string	A kiszolgáló rendelkezésre állási zónájának adatai.
properties.citusVersion	string	A kiszolgáló Citus-bővítményének verziója.
properties.enableHa	boolean	Ha a magas rendelkezésre állás (HA) engedélyezve van, vagy nincs a kiszolgáló számára.
properties.enablePublicIpAccess	boolean	Ha a nyilvános hozzáférés engedélyezve van a kiszolgálón.
properties.fullyQualifiedDomainName	string	A kiszolgáló teljes tartományneve.
properties.haState	string	A fürt HA-szolgáltatásának állapota.
properties.isReadOnly	boolean	Ha a kiszolgáló adatbázisa a magas lemezterület-használattól függően csak olvashatóra van beállítva a rendszerkarbantartás szerint.
properties.postgresqlVersion	string	A kiszolgáló fő PostgreSQL-verziója.
properties.role	ServerRole	A kiszolgáló szerepe a fürtben.
properties.serverEdition	string	A kiszolgáló kiadása.
properties.state	string	A felhasználó számára látható fürt/kiszolgáló állapota.
properties.storageQuotaInMb	integer (int32)	Egy kiszolgáló tárolása MB-ban.
properties.vCores	integer (int32)	Egy kiszolgáló virtuális magjainak száma.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ClusterServerListResult

Objektum

Egy fürt kiszolgálóinak listája.

Name	Típus	Description
value	ClusterServer[]	A fürtön lévő kiszolgálók listája.

createdByType

Enumerálás

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

Érték	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objektum

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 információtípus.

ErrorDetail

Objektum

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 hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ServerRole

Enumerálás

A kiszolgáló szerepe.

Érték	Description
Coordinator
Worker

systemData

Objektum

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

Name	Típus	Description
createdAt	string (date-time)	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 (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

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

Servers - List By Cluster

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

List servers of the cluster

Mintakérelem

Mintaválasz

Definíciók

ClusterServer

ClusterServerListResult

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerRole

systemData