Servers - Get

Servicio:

PostgreSQL

Versión de la API:

2017-12-01

Obtiene información sobre un servidor.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	Server	Aceptar
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

ServerGet

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio Batch.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error
GeoRedundantBackup	Habilite la redundancia geográfica o no para la copia de seguridad del servidor.
IdentityType	Tipo de identidad. Establézcalo en "SystemAssigned" para crear y asignar automáticamente una entidad de seguridad de Azure Active Directory para el recurso.
InfrastructureEncryption	Agregue una segunda capa de cifrado para los datos mediante el nuevo algoritmo de cifrado que proporciona protección de datos adicional. El valor es opcional, pero si se pasa, debe ser "Disabled" o "Enabled".
MinimalTlsVersionEnum	Aplique una versión mínima de Tls para el servidor.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Estado de la conexión de punto de conexión privado.
PrivateLinkServiceConnectionStateActionsRequire	Las acciones necesarias para la conexión del servicio Private Link.
PrivateLinkServiceConnectionStateStatus	Estado de conexión del servicio Private Link.
PublicNetworkAccessEnum	Si se permite o no el acceso a la red pública para este servidor. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado".
ResourceIdentity	Configuración de identidad de Azure Active Directory para un recurso.
Server	Representa un servidor.
ServerPrivateEndpointConnection	Una conexión de punto de conexión privado en un servidor
ServerPrivateEndpointConnectionProperties	Propiedades de una conexión de punto de conexión privado.
ServerPrivateLinkServiceConnectionStateProperty
ServerState	Estado de un servidor que es visible para el usuario.
ServerVersion	Versión de un servidor.
Sku	Propiedades relacionadas con la información de facturación de un servidor.
SkuTier	El nivel de la SKU concreta, por ejemplo, Básico.
SslEnforcementEnum	Habilite la aplicación ssl o no cuando se conecte al servidor.
StorageAutogrow	Habilite el crecimiento automático del almacenamiento.
StorageProfile	Propiedades del perfil de almacenamiento de un servidor

CloudError

Respuesta de error del servicio Batch.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

GeoRedundantBackup

Habilite la redundancia geográfica o no para la copia de seguridad del servidor.

Nombre	Tipo	Description
Disabled	string
Enabled	string

IdentityType

Tipo de identidad. Establézcalo en "SystemAssigned" para crear y asignar automáticamente una entidad de seguridad de Azure Active Directory para el recurso.

Nombre	Tipo	Description
SystemAssigned	string

InfrastructureEncryption

Agregue una segunda capa de cifrado para los datos mediante el nuevo algoritmo de cifrado que proporciona protección de datos adicional. El valor es opcional, pero si se pasa, debe ser "Disabled" o "Enabled".

Nombre	Tipo	Description
Disabled	string	Capa adicional (2ª) de cifrado para los datos en reposo
Enabled	string	Valor predeterminado para una sola capa de cifrado para los datos en reposo.

MinimalTlsVersionEnum

Aplique una versión mínima de Tls para el servidor.

Nombre	Tipo	Description
TLS1_0	string
TLS1_1	string
TLS1_2	string
TLSEnforcementDisabled	string

PrivateEndpointProperty

Nombre	Tipo	Description
id	string	Identificador de recurso del punto de conexión privado.

PrivateEndpointProvisioningState

Estado de la conexión de punto de conexión privado.

Nombre	Tipo	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

Las acciones necesarias para la conexión del servicio Private Link.

Nombre	Tipo	Description
None	string

PrivateLinkServiceConnectionStateStatus

Estado de conexión del servicio Private Link.

Nombre	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccessEnum

Si se permite o no el acceso a la red pública para este servidor. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado".

Nombre	Tipo	Description
Disabled	string
Enabled	string

ResourceIdentity

Configuración de identidad de Azure Active Directory para un recurso.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de Azure Active Directory.
tenantId	string	Identificador de inquilino de Azure Active Directory.
type	IdentityType	Tipo de identidad. Establézcalo en "SystemAssigned" para crear y asignar automáticamente una entidad de seguridad de Azure Active Directory para el recurso.

Server

Representa un servidor.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ResourceIdentity	Identidad de Azure Active Directory del servidor.
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso.
properties.administratorLogin	string	Nombre de inicio de sesión del administrador de un servidor. Solo se puede especificar cuando se crea el servidor (y es necesario para la creación).
properties.byokEnforcement	string	Estado que muestra si el cifrado de datos del servidor está habilitado con claves administradas por el cliente.
properties.earliestRestoreDate	string	Hora de creación del punto de restauración más temprana (ISO8601 formato)
properties.fullyQualifiedDomainName	string	Nombre de dominio completo de un servidor.
properties.infrastructureEncryption	InfrastructureEncryption	Estado que muestra si el cifrado de infraestructura habilitado para el servidor.
properties.masterServerId	string	Identificador del servidor maestro de un servidor de réplica.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Aplique una versión mínima de Tls para el servidor.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Lista de conexiones de punto de conexión privado en un servidor
properties.publicNetworkAccess	PublicNetworkAccessEnum	Si se permite o no el acceso a la red pública para este servidor. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado".
properties.replicaCapacity	integer	Número máximo de réplicas que puede tener un servidor maestro.
properties.replicationRole	string	Rol de replicación del servidor.
properties.sslEnforcement	SslEnforcementEnum	Habilite la aplicación ssl o no cuando se conecte al servidor.
properties.storageProfile	StorageProfile	Perfil de almacenamiento de un servidor.
properties.userVisibleState	ServerState	Estado de un servidor que es visible para el usuario.
properties.version	ServerVersion	Versión del servidor.
sku	Sku	SKU (plan de tarifa) del servidor.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ServerPrivateEndpointConnection

Una conexión de punto de conexión privado en un servidor

Nombre	Tipo	Description
id	string	Identificador de recurso de la conexión de punto de conexión privado.
properties	ServerPrivateEndpointConnectionProperties	Propiedades de conexión de punto de conexión privado

ServerPrivateEndpointConnectionProperties

Propiedades de una conexión de punto de conexión privado.

Nombre	Tipo	Description
privateEndpoint	PrivateEndpointProperty	Punto de conexión privado al que pertenece la conexión.
privateLinkServiceConnectionState	ServerPrivateLinkServiceConnectionStateProperty	Estado de conexión de la conexión del punto de conexión privado.
provisioningState	PrivateEndpointProvisioningState	Estado de la conexión de punto de conexión privado.

ServerPrivateLinkServiceConnectionStateProperty

Nombre	Tipo	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Las acciones necesarias para la conexión del servicio Private Link.
description	string	Descripción de la conexión del servicio private link.
status	PrivateLinkServiceConnectionStateStatus	Estado de conexión del servicio Private Link.

ServerState

Estado de un servidor que es visible para el usuario.

Nombre	Tipo	Description
Disabled	string
Dropping	string
Inaccessible	string
Ready	string

ServerVersion

Versión de un servidor.

Nombre	Tipo	Description
10	string
10.0	string
10.2	string
11	string
9.5	string
9.6	string

Sku

Propiedades relacionadas con la información de facturación de un servidor.

Nombre	Tipo	Description
capacity	integer	Capacidad de escalado vertical y horizontal, que representa las unidades de proceso del servidor.
family	string	Familia de hardware.
name	string	Nombre de la SKU, normalmente, nivel + familia + núcleos, por ejemplo, B_Gen4_1, GP_Gen5_8.
size	string	El código de tamaño, que se interpretará mediante el recurso según corresponda.
tier	SkuTier	El nivel de la SKU concreta, por ejemplo, Básico.

SkuTier

El nivel de la SKU concreta, por ejemplo, Básico.

Nombre	Tipo	Description
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

Habilite la aplicación ssl o no cuando se conecte al servidor.

Nombre	Tipo	Description
Disabled	string
Enabled	string

StorageAutogrow

Habilite el crecimiento automático del almacenamiento.

Nombre	Tipo	Description
Disabled	string
Enabled	string

StorageProfile

Propiedades del perfil de almacenamiento de un servidor

Nombre	Tipo	Description
backupRetentionDays	integer	Días de retención de copia de seguridad para el servidor.
geoRedundantBackup	GeoRedundantBackup	Habilite la redundancia geográfica o no para la copia de seguridad del servidor.
storageAutogrow	StorageAutogrow	Habilite el crecimiento automático del almacenamiento.
storageMB	integer	Almacenamiento máximo permitido para un servidor.