Servers - Get

Service:

PostgreSQL

Version d'API:

2017-12-01

Obtient des informations sur un serveur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	Server	Ok
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

ServerGet

Exemple de requête

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

import com.azure.core.util.Context;

/** 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", 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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
CloudError	Réponse d’erreur du service Batch.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorResponse	Réponse d’erreur
GeoRedundantBackup	Activez géoredondant ou non pour la sauvegarde du serveur.
IdentityType	Type d’identité. Définissez cette valeur sur « SystemAssigned » afin de créer et d’affecter automatiquement un principal Azure Active Directory pour la ressource.
InfrastructureEncryption	Ajoutez une deuxième couche de chiffrement pour vos données à l’aide d’un nouvel algorithme de chiffrement qui offre une protection supplémentaire des données. La valeur est facultative, mais si elle est transmise, doit être « Désactivé » ou « Activé ».
MinimalTlsVersionEnum	Appliquez une version tls minimale pour le serveur.
PrivateEndpointProperty
PrivateEndpointProvisioningState	État de la connexion de point de terminaison privé.
PrivateLinkServiceConnectionStateActionsRequire	Actions requises pour la connexion au service private link.
PrivateLinkServiceConnectionStateStatus	La connexion au service de liaison privée status.
PublicNetworkAccessEnum	Indique si l’accès au réseau public est autorisé ou non pour ce serveur. La valeur est facultative, mais si elle est transmise, doit être « Enabled » ou « Disabled »
ResourceIdentity	Configuration d’identité Azure Active Directory pour une ressource.
Server	Représente un serveur.
ServerPrivateEndpointConnection	Connexion de point de terminaison privé sous un serveur
ServerPrivateEndpointConnectionProperties	Propriétés d’une connexion de point de terminaison privé.
ServerPrivateLinkServiceConnectionStateProperty
ServerState	État d’un serveur visible par l’utilisateur.
ServerVersion	Version d’un serveur.
Sku	Propriétés liées aux informations de facturation d’un serveur.
SkuTier	Niveau de la référence SKU particulière, par exemple De base.
SslEnforcementEnum	Activez l’application ssl ou non lors de la connexion au serveur.
StorageAutogrow	Activez la croissance automatique du stockage.
StorageProfile	Propriétés du profil de stockage d’un serveur

CloudError

Réponse d’erreur du service Batch.

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.)

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

GeoRedundantBackup

Activez géoredondant ou non pour la sauvegarde du serveur.

Nom	Type	Description
Disabled	string
Enabled	string

IdentityType

Type d’identité. Définissez cette valeur sur « SystemAssigned » afin de créer et d’affecter automatiquement un principal Azure Active Directory pour la ressource.

Nom	Type	Description
SystemAssigned	string

InfrastructureEncryption

Ajoutez une deuxième couche de chiffrement pour vos données à l’aide d’un nouvel algorithme de chiffrement qui offre une protection supplémentaire des données. La valeur est facultative, mais si elle est transmise, doit être « Désactivé » ou « Activé ».

Nom	Type	Description
Disabled	string	Couche supplémentaire (2e) de chiffrement pour les données au repos
Enabled	string	Valeur par défaut pour une seule couche de chiffrement pour les données au repos.

MinimalTlsVersionEnum

Appliquez une version tls minimale pour le serveur.

Nom	Type	Description
TLS1_0	string
TLS1_1	string
TLS1_2	string
TLSEnforcementDisabled	string

PrivateEndpointProperty

Nom	Type	Description
id	string	ID de ressource du point de terminaison privé.

PrivateEndpointProvisioningState

État de la connexion de point de terminaison privé.

Nom	Type	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

Actions requises pour la connexion au service private link.

Nom	Type	Description
None	string

PrivateLinkServiceConnectionStateStatus

La connexion au service de liaison privée status.

Nom	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccessEnum

Indique si l’accès au réseau public est autorisé ou non pour ce serveur. La valeur est facultative, mais si elle est transmise, doit être « Enabled » ou « Disabled »

Nom	Type	Description
Disabled	string
Enabled	string

ResourceIdentity

Configuration d’identité Azure Active Directory pour une ressource.

Nom	Type	Description
principalId	string	ID du principal Azure Active Directory.
tenantId	string	ID de locataire Azure Active Directory.
type	IdentityType	Type d’identité. Définissez cette valeur sur « SystemAssigned » afin de créer et d’affecter automatiquement un principal Azure Active Directory pour la ressource.

Server

Représente un serveur.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ResourceIdentity	Identité Azure Active Directory du serveur.
location	string	Emplacement géographique où réside la ressource
name	string	nom de la ressource.
properties.administratorLogin	string	Nom de connexion de l’administrateur d’un serveur. Peut être spécifié uniquement lors de la création du serveur (et est requis pour la création).
properties.byokEnforcement	string	État indiquant si le chiffrement des données du serveur est activé avec des clés gérées par le client.
properties.earliestRestoreDate	string	Heure de création du point de restauration la plus ancienne (format ISO8601)
properties.fullyQualifiedDomainName	string	Nom de domaine complet d’un serveur.
properties.infrastructureEncryption	InfrastructureEncryption	État indiquant si le serveur a activé le chiffrement de l’infrastructure.
properties.masterServerId	string	ID de serveur master d’un serveur réplica.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Appliquez une version tls minimale pour le serveur.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Liste des connexions de point de terminaison privé sur un serveur
properties.publicNetworkAccess	PublicNetworkAccessEnum	Indique si l’accès au réseau public est autorisé ou non pour ce serveur. La valeur est facultative, mais si elle est transmise, doit être « Enabled » ou « Disabled »
properties.replicaCapacity	integer	Nombre maximal de réplicas qu’un serveur master peut avoir.
properties.replicationRole	string	Rôle de réplication du serveur.
properties.sslEnforcement	SslEnforcementEnum	Activez l’application ssl ou non lors de la connexion au serveur.
properties.storageProfile	StorageProfile	Profil de stockage d’un serveur.
properties.userVisibleState	ServerState	État d’un serveur visible par l’utilisateur.
properties.version	ServerVersion	Version du serveur.
sku	Sku	Référence SKU (niveau tarifaire) du serveur.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ServerPrivateEndpointConnection

Connexion de point de terminaison privé sous un serveur

Nom	Type	Description
id	string	ID de ressource de la connexion de point de terminaison privé.
properties	ServerPrivateEndpointConnectionProperties	Propriétés de connexion de point de terminaison privé

ServerPrivateEndpointConnectionProperties

Propriétés d’une connexion de point de terminaison privé.

Nom	Type	Description
privateEndpoint	PrivateEndpointProperty	Point de terminaison privé auquel appartient la connexion.
privateLinkServiceConnectionState	ServerPrivateLinkServiceConnectionStateProperty	État de la connexion de la connexion de point de terminaison privé.
provisioningState	PrivateEndpointProvisioningState	État de la connexion de point de terminaison privé.

ServerPrivateLinkServiceConnectionStateProperty

Nom	Type	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Actions requises pour la connexion au service private link.
description	string	Description de la connexion au service private link.
status	PrivateLinkServiceConnectionStateStatus	La connexion au service de liaison privée status.

ServerState

État d’un serveur visible par l’utilisateur.

Nom	Type	Description
Disabled	string
Dropping	string
Inaccessible	string
Ready	string

ServerVersion

Version d’un serveur.

Nom	Type	Description
10	string
10.0	string
10.2	string
11	string
9.5	string
9.6	string

Sku

Propriétés liées aux informations de facturation d’un serveur.

Nom	Type	Description
capacity	integer	Capacité de scale-up/out, représentant les unités de calcul du serveur.
family	string	Famille de matériel.
name	string	Nom de la référence SKU, généralement, niveau + famille + cœurs, par exemple B_Gen4_1, GP_Gen5_8.
size	string	Code de taille, à interpréter par la ressource comme il convient.
tier	SkuTier	Niveau de la référence SKU particulière, par exemple De base.

SkuTier

Niveau de la référence SKU particulière, par exemple De base.

Nom	Type	Description
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

Activez l’application ssl ou non lors de la connexion au serveur.

Nom	Type	Description
Disabled	string
Enabled	string

StorageAutogrow

Activez la croissance automatique du stockage.

Nom	Type	Description
Disabled	string
Enabled	string

StorageProfile

Propriétés du profil de stockage d’un serveur

Nom	Type	Description
backupRetentionDays	integer	Jours de rétention des sauvegardes pour le serveur.
geoRedundantBackup	GeoRedundantBackup	Activez géoredondant ou non pour la sauvegarde du serveur.
storageAutogrow	StorageAutogrow	Activez la croissance automatique du stockage.
storageMB	integer	Stockage maximal autorisé pour un serveur.