Servers - Get

Referenz

Dienst:: Cosmos DB for PostgreSQL

API-Version:: 2023-03-02-preview

Ruft Informationen zu einem Server im Cluster ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
clusterName	path	True	string	Der Name des Clusters. RegEx-Muster: `^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
serverName	path	True	string	Name des Servers RegEx-Muster: `^[-\w\._]+$`
subscriptionId	path	True	string uuid	Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ClusterServer	OK
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Annehmen der Identität Ihres Benutzerkontos

Beispiele

Get the server of cluster

Beispielanforderung

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


/**
 * Samples for Servers Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/
     * ServerGet.json
     */
    /**
     * Sample code: Get the server of cluster.
     * 
     * @param manager Entry point to CosmosDBForPostgreSqlManager.
     */
    public static void
        getTheServerOfCluster(com.azure.resourcemanager.cosmosdbforpostgresql.CosmosDBForPostgreSqlManager manager) {
        manager.servers().getWithResponse("TestGroup", "testcluster1", "testcluster1-c",
            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_get.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.get(
        resource_group_name="TestGroup",
        cluster_name="testcluster1",
        server_name="testcluster1-c",
    )
    print(response)


# x-ms-original-file: specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ServerGet.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/ServerGet.json
func ExampleServersClient_Get() {
	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)
	}
	res, err := clientFactory.NewServersClient().Get(ctx, "TestGroup", "testcluster1", "testcluster1-c", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ClusterServer = 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"),
	// 	},
	// }
}

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 Gets information about a server in cluster.
 *
 * @summary Gets information about a server in cluster.
 * x-ms-original-file: specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/ServerGet.json
 */
async function getTheServerOfCluster() {
  const subscriptionId =
    process.env["COSMOSFORPOSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["COSMOSFORPOSTGRESQL_RESOURCE_GROUP"] || "TestGroup";
  const clusterName = "testcluster1";
  const serverName = "testcluster1-c";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBForPostgreSQL(credential, subscriptionId);
  const result = await client.servers.get(resourceGroupName, clusterName, serverName);
  console.log(result);
}

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "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
  }
}

Definitionen

Name	Beschreibung
ClusterServer	Stellt einen Server in einem Cluster dar.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
ServerRole	Die Rolle eines Servers.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

ClusterServer

Stellt einen Server in einem Cluster dar.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.administratorLogin	string	Der Anmeldename des Administrators der Server im Cluster.
properties.availabilityZone	string	Verfügbarkeitszoneninformationen des Servers.
properties.citusVersion	string	Die Citus-Erweiterungsversion des Servers.
properties.enableHa	boolean	Wenn Hochverfügbarkeit (HA) für den Server aktiviert ist oder nicht.
properties.enablePublicIpAccess	boolean	Wenn der öffentliche Zugriff auf dem Server aktiviert ist.
properties.fullyQualifiedDomainName	string	Der vollqualifizierte Domänenname eines Servers.
properties.haState	string	Ein Hochverfügbarkeitsstatusfeature für den Cluster.
properties.isReadOnly	boolean	Wenn die Serverdatenbank von der Systemwartung abhängig von der hohen Speicherplatzauslastung auf schreibgeschützt festgelegt ist.
properties.postgresqlVersion	string	Die Hauptversion von PostgreSQL des Servers.
properties.role	ServerRole	Die Rolle des Servers im Cluster.
properties.serverEdition	string	Die Edition eines Servers.
properties.state	string	Ein Status eines Clusters/Servers, der für den Benutzer sichtbar ist.
properties.storageQuotaInMb	integer	Der Speicher eines Servers in MB.
properties.vCores	integer	Die Anzahl der virtuellen Kerne eines Servers.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ServerRole

Die Rolle eines Servers.

Name	Typ	Beschreibung
Coordinator	string
Worker	string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Servers - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Get the server of cluster

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ClusterServer

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerRole

systemData

Zusätzliche Ressourcen