Servers - Get

Služba:

PostgreSQL

Verze rozhraní API:

2017-12-01

Získá informace o serveru.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}?api-version=2017-12-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	Server	OK
Other Status Codes	CloudError	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ění uživatelského účtu

Příklady

ServerGet

Ukázkový požadavek

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/pgtestsvc1?api-version=2017-12-01

Java

/**
 * Samples for Servers GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerGet.json
     */
    /**
     * Sample code: ServerGet.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void serverGet(com.azure.resourcemanager.postgresql.PostgreSqlManager manager) {
        manager.servers().getByResourceGroupWithResponse("testrg", "pgtestsvc1", 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.rdbms.postgresql import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-rdbms
# 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 = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.get(
        resource_group_name="testrg",
        server_name="pgtestsvc1",
    )
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/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

Go

package armpostgresql_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresql/armpostgresql"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/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 := armpostgresql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewServersClient().Get(ctx, "testrg", "pgtestsvc1", 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.Server = armpostgresql.Server{
	// 	Name: to.Ptr("pgtestsvc1"),
	// 	Type: to.Ptr("Microsoft.DBforPostgreSQL/servers"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/pgtestsvc1"),
	// 	Location: to.Ptr("westus"),
	// 	Properties: &armpostgresql.ServerProperties{
	// 		AdministratorLogin: to.Ptr("testuser"),
	// 		EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-04T21:00:58.924Z"); return t}()),
	// 		FullyQualifiedDomainName: to.Ptr("pgtestsvc1.postgres.database.azure.com"),
	// 		MasterServerID: to.Ptr(""),
	// 		MinimalTLSVersion: to.Ptr(armpostgresql.MinimalTLSVersionEnumTLS12),
	// 		PrivateEndpointConnections: []*armpostgresql.ServerPrivateEndpointConnection{
	// 			{
	// 				ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/pgtestsvc1/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444"),
	// 				Properties: &armpostgresql.ServerPrivateEndpointConnectionProperties{
	// 					PrivateEndpoint: &armpostgresql.PrivateEndpointProperty{
	// 						ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"),
	// 					},
	// 					PrivateLinkServiceConnectionState: &armpostgresql.ServerPrivateLinkServiceConnectionStateProperty{
	// 						Description: to.Ptr("Auto-approved"),
	// 						ActionsRequired: to.Ptr(armpostgresql.PrivateLinkServiceConnectionStateActionsRequireNone),
	// 						Status: to.Ptr(armpostgresql.PrivateLinkServiceConnectionStateStatusApproved),
	// 					},
	// 					ProvisioningState: to.Ptr(armpostgresql.PrivateEndpointProvisioningState("Succeeded")),
	// 				},
	// 		}},
	// 		PublicNetworkAccess: to.Ptr(armpostgresql.PublicNetworkAccessEnumEnabled),
	// 		ReplicationRole: to.Ptr(""),
	// 		SSLEnforcement: to.Ptr(armpostgresql.SSLEnforcementEnumEnabled),
	// 		StorageProfile: &armpostgresql.StorageProfile{
	// 			BackupRetentionDays: to.Ptr[int32](10),
	// 			GeoRedundantBackup: to.Ptr(armpostgresql.GeoRedundantBackupDisabled),
	// 			StorageMB: to.Ptr[int32](5120),
	// 		},
	// 		UserVisibleState: to.Ptr(armpostgresql.ServerStateReady),
	// 		Version: to.Ptr(armpostgresql.ServerVersionNine5),
	// 	},
	// 	SKU: &armpostgresql.SKU{
	// 		Name: to.Ptr("B_Gen4_1"),
	// 		Capacity: to.Ptr[int32](1),
	// 		Family: to.Ptr("Gen4"),
	// 		Tier: to.Ptr(armpostgresql.SKUTierBasic),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Gets information about a server.
 *
 * @summary Gets information about a server.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerGet.json
 */
async function serverGet() {
  const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = "testrg";
  const serverName = "pgtestsvc1";
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementClient(credential, subscriptionId);
  const result = await client.servers.get(resourceGroupName, serverName);
  console.log(result);
}

serverGet().catch(console.error);

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.PostgreSql.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.PostgreSql;

// Generated from example definition: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerGet.json
// this example is just showing the usage of "Servers_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this PostgreSqlServerResource created on azure
// for more information of creating PostgreSqlServerResource, please refer to the document of PostgreSqlServerResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
string resourceGroupName = "testrg";
string serverName = "pgtestsvc1";
ResourceIdentifier postgreSqlServerResourceId = PostgreSqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
PostgreSqlServerResource postgreSqlServer = client.GetPostgreSqlServerResource(postgreSqlServerResourceId);

// invoke the operation
PostgreSqlServerResource result = await postgreSqlServer.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
PostgreSqlServerData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Ukázková odpověď

Stavový kód:

200

{
  "sku": {
    "name": "B_Gen4_1",
    "tier": "Basic",
    "family": "Gen4",
    "capacity": 1
  },
  "properties": {
    "administratorLogin": "testuser",
    "storageProfile": {
      "storageMB": 5120,
      "backupRetentionDays": 10,
      "geoRedundantBackup": "Disabled"
    },
    "version": "9.5",
    "sslEnforcement": "Enabled",
    "minimalTlsVersion": "TLS1_2",
    "userVisibleState": "Ready",
    "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com",
    "earliestRestoreDate": "2018-03-04T21:00:58.9243541+00:00",
    "replicationRole": "",
    "masterServerId": "",
    "publicNetworkAccess": "Enabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/pgtestsvc1/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
        "properties": {
          "provisioningState": "Ready",
          "privateEndpoint": {
            "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-approved",
            "actionsRequired": "None"
          }
        }
      }
    ]
  },
  "location": "westus",
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/pgtestsvc1",
  "name": "pgtestsvc1",
  "type": "Microsoft.DBforPostgreSQL/servers"
}

Definice

Name	Description
CloudError	Chybová odpověď ze služby Batch.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorResponse	Odpověď na chybu
GeoRedundantBackup	Povolte geograficky redundantní zálohování serveru nebo ne.
IdentityType	Typ identity. Tuto možnost nastavte na SystemAssigned, aby se pro prostředek automaticky vytvořil a přiřadil objekt zabezpečení Služby Azure Active Directory.
InfrastructureEncryption	Přidejte druhou vrstvu šifrování dat pomocí nového šifrovacího algoritmu, který poskytuje další ochranu dat. Hodnota je volitelná, ale pokud je předána, musí být Zakázaná nebo Povolená.
MinimalTlsVersionEnum	Vynucujte minimální verzi protokolu TLS pro server.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Stav připojení privátního koncového bodu
PrivateLinkServiceConnectionStateActionsRequire	Akce vyžadované pro připojení služby Private Link.
PrivateLinkServiceConnectionStateStatus	Stav připojení služby Private Link.
PublicNetworkAccessEnum	Určuje, jestli je pro tento server povolený veřejný síťový přístup. Hodnota je nepovinná, ale pokud je předána, musí být Povolená nebo Zakázaná.
ResourceIdentity	Konfigurace identity Azure Active Directory pro prostředek
Server	Představuje server.
ServerPrivateEndpointConnection	Připojení privátního koncového bodu pod serverem
ServerPrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu.
ServerPrivateLinkServiceConnectionStateProperty
ServerState	Stav serveru, který je viditelný pro uživatele.
ServerVersion	Verze serveru.
Sku	Vlastnosti serveru související s fakturačními údaji.
SkuTier	Úroveň konkrétní skladové položky, například Basic.
SslEnforcementEnum	Povolte vynucování ssl nebo ne, když se připojujete k serveru.
StorageAutogrow	Povolte automatické zvětšování úložiště.
StorageProfile	Vlastnosti profilu úložiště serveru

CloudError

Chybová odpověď ze služby Batch.

Name	Typ	Description
error	ErrorResponse	Odpověď na chybu Běžná chybová odpověď pro všechna rozhraní API azure Resource Manager, která vrací podrobnosti o chybě pro neúspěšné operace. (Tento formát také odpovídá formátu odpovědi na chybu OData.)

ErrorAdditionalInfo

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

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorResponse[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

GeoRedundantBackup

Povolte geograficky redundantní zálohování serveru nebo ne.

Name	Typ	Description
Disabled	string
Enabled	string

IdentityType

Typ identity. Tuto možnost nastavte na SystemAssigned, aby se pro prostředek automaticky vytvořil a přiřadil objekt zabezpečení Služby Azure Active Directory.

Name	Typ	Description
SystemAssigned	string

InfrastructureEncryption

Přidejte druhou vrstvu šifrování dat pomocí nového šifrovacího algoritmu, který poskytuje další ochranu dat. Hodnota je volitelná, ale pokud je předána, musí být Zakázaná nebo Povolená.

Name	Typ	Description
Disabled	string	Další (2.) vrstva šifrování neaktivních uložených dat
Enabled	string	Výchozí hodnota pro jednu vrstvu šifrování neaktivních uložených dat.

MinimalTlsVersionEnum

Vynucujte minimální verzi protokolu TLS pro server.

Name	Typ	Description
TLS1_0	string
TLS1_1	string
TLS1_2	string
TLSEnforcementDisabled	string

PrivateEndpointProperty

Name	Typ	Description
id	string	ID prostředku privátního koncového bodu

PrivateEndpointProvisioningState

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

Name	Typ	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

Akce vyžadované pro připojení služby Private Link.

Name	Typ	Description
None	string

PrivateLinkServiceConnectionStateStatus

Stav připojení služby Private Link.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccessEnum

Určuje, jestli je pro tento server povolený veřejný síťový přístup. Hodnota je nepovinná, ale pokud je předána, musí být Povolená nebo Zakázaná.

Name	Typ	Description
Disabled	string
Enabled	string

ResourceIdentity

Konfigurace identity Azure Active Directory pro prostředek

Name	Typ	Description
principalId	string	ID objektu zabezpečení Azure Active Directory.
tenantId	string	ID tenanta Azure Active Directory.
type	IdentityType	Typ identity. Tuto možnost nastavte na SystemAssigned, aby se pro prostředek automaticky vytvořil a přiřadil objekt zabezpečení Služby Azure Active Directory.

Server

Představuje server.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
identity	ResourceIdentity	Identita serveru v Azure Active Directory.
location	string	Geografické umístění, kde se prostředek nachází
name	string	Název prostředku
properties.administratorLogin	string	Přihlašovací jméno správce serveru. Lze zadat pouze při vytváření serveru (a vyžaduje se k vytvoření).
properties.byokEnforcement	string	Stav ukazující, jestli je šifrování dat serveru povolené pomocí klíčů spravovaných zákazníkem.
properties.earliestRestoreDate	string	Nejstarší čas vytvoření bodu obnovení (formát ISO8601)
properties.fullyQualifiedDomainName	string	Plně kvalifikovaný název domény serveru.
properties.infrastructureEncryption	InfrastructureEncryption	Stav ukazující, jestli server povolil šifrování infrastruktury.
properties.masterServerId	string	ID hlavního serveru serveru repliky.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Vynucujte minimální verzi protokolu TLS pro server.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Seznam připojení privátních koncových bodů na serveru
properties.publicNetworkAccess	PublicNetworkAccessEnum	Určuje, jestli je pro tento server povolený veřejný síťový přístup. Hodnota je nepovinná, ale pokud je předána, musí být Povolená nebo Zakázaná.
properties.replicaCapacity	integer	Maximální počet replik, které může mít hlavní server.
properties.replicationRole	string	Role replikace serveru.
properties.sslEnforcement	SslEnforcementEnum	Povolte vynucování ssl nebo ne, když se připojujete k serveru.
properties.storageProfile	StorageProfile	Profil úložiště serveru.
properties.userVisibleState	ServerState	Stav serveru, který je viditelný pro uživatele.
properties.version	ServerVersion	Verze serveru.
sku	Sku	Skladová položka (cenová úroveň) serveru.
tags	object	Značky prostředků.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ServerPrivateEndpointConnection

Připojení privátního koncového bodu pod serverem

Name	Typ	Description
id	string	ID prostředku připojení privátního koncového bodu.
properties	ServerPrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu

ServerPrivateEndpointConnectionProperties

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

Name	Typ	Description
privateEndpoint	PrivateEndpointProperty	Privátní koncový bod, ke kterému připojení patří.
privateLinkServiceConnectionState	ServerPrivateLinkServiceConnectionStateProperty	Stav připojení privátního koncového bodu.
provisioningState	PrivateEndpointProvisioningState	Stav připojení privátního koncového bodu

ServerPrivateLinkServiceConnectionStateProperty

Name	Typ	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Akce vyžadované pro připojení služby Private Link.
description	string	Popis připojení služby Private Link.
status	PrivateLinkServiceConnectionStateStatus	Stav připojení služby Private Link.

ServerState

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

Name	Typ	Description
Disabled	string
Dropping	string
Inaccessible	string
Ready	string

ServerVersion

Verze serveru.

Name	Typ	Description
10	string
10.0	string
10.2	string
11	string
9.5	string
9.6	string

Sku

Vlastnosti serveru související s fakturačními údaji.

Name	Typ	Description
capacity	integer	Kapacita vertikálního navýšení/snížení kapacity představující výpočetní jednotky serveru.
family	string	Rodina hardwaru.
name	string	Název skladové položky, obvykle vrstva + rodina + jádra, například B_Gen4_1, GP_Gen5_8.
size	string	Kód velikosti, který bude odpovídajícím způsobem interpretován prostředkem.
tier	SkuTier	Úroveň konkrétní skladové položky, například Basic.

SkuTier

Úroveň konkrétní skladové položky, například Basic.

Name	Typ	Description
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

Povolte vynucování ssl nebo ne, když se připojujete k serveru.

Name	Typ	Description
Disabled	string
Enabled	string

StorageAutogrow

Povolte automatické zvětšování úložiště.

Name	Typ	Description
Disabled	string
Enabled	string

StorageProfile

Vlastnosti profilu úložiště serveru

Name	Typ	Description
backupRetentionDays	integer	Dny uchovávání záloh pro server.
geoRedundantBackup	GeoRedundantBackup	Povolte geograficky redundantní zálohování serveru nebo ne.
storageAutogrow	StorageAutogrow	Povolte automatické zvětšování úložiště.
storageMB	integer	Maximální povolené úložiště pro server