Servers - Get

Serviço:

PostgreSQL

Versão da API:

2017-12-01

Obtém informações sobre um servidor.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	Server	OK
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ServerGet

Pedido de amostra

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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
CloudError	Uma resposta de erro do serviço Batch.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorResponse	Resposta a Erros
GeoRedundantBackup	Ative Georredundante ou não para cópia de segurança do servidor.
IdentityType	O tipo de identidade. Defina esta opção como "SystemAssigned" para criar e atribuir automaticamente um principal do Azure Active Directory para o recurso.
InfrastructureEncryption	Adicione uma segunda camada de encriptação para os seus dados através de um novo algoritmo de encriptação que proporciona proteção de dados adicional. O valor é opcional, mas, se for transmitido, tem de ser "Desativado" ou "Ativado".
MinimalTlsVersionEnum	Impor uma versão mínima do TLS para o servidor.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Estado da ligação de ponto final privado.
PrivateLinkServiceConnectionStateActionsRequire	As ações necessárias para a ligação do serviço de ligação privada.
PrivateLinkServiceConnectionStateStatus	O estado da ligação do serviço de ligação privada.
PublicNetworkAccessEnum	Se o acesso à rede pública é ou não permitido para este servidor. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado"
ResourceIdentity	Configuração de identidade do Azure Active Directory para um recurso.
Server	Representa um servidor.
ServerPrivateEndpointConnection	Uma ligação de ponto final privado num servidor
ServerPrivateEndpointConnectionProperties	Propriedades de uma ligação de ponto final privado.
ServerPrivateLinkServiceConnectionStateProperty
ServerState	Um estado de um servidor que é visível para o utilizador.
ServerVersion	A versão de um servidor.
Sku	Propriedades relacionadas com informações de faturação de um servidor.
SkuTier	O escalão do SKU específico, por exemplo, Básico.
SslEnforcementEnum	Ative a imposição de ssl ou não quando ligar ao servidor.
StorageAutogrow	Ativar o Aumento Automático do Armazenamento.
StorageProfile	Propriedades do Perfil de Armazenamento de um servidor

CloudError

Uma resposta de erro do serviço Batch.

Name	Tipo	Description
error	ErrorResponse	Resposta a Erros Resposta de erro comum para todas as APIs do Azure Resource Manager para devolver detalhes do erro para operações com falhas. (Isto também segue o formato de resposta de erro OData.)

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorResponse

Resposta a Erros

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

GeoRedundantBackup

Ative Georredundante ou não para cópia de segurança do servidor.

Name	Tipo	Description
Disabled	string
Enabled	string

IdentityType

O tipo de identidade. Defina esta opção como "SystemAssigned" para criar e atribuir automaticamente um principal do Azure Active Directory para o recurso.

Name	Tipo	Description
SystemAssigned	string

InfrastructureEncryption

Adicione uma segunda camada de encriptação para os seus dados através de um novo algoritmo de encriptação que proporciona proteção de dados adicional. O valor é opcional, mas, se for transmitido, tem de ser "Desativado" ou "Ativado".

Name	Tipo	Description
Disabled	string	Camada adicional (2ª) de encriptação para dados inativos
Enabled	string	Valor predefinido para uma única camada de encriptação para dados inativos.

MinimalTlsVersionEnum

Impor uma versão mínima do TLS para o servidor.

Name	Tipo	Description
TLS1_0	string
TLS1_1	string
TLS1_2	string
TLSEnforcementDisabled	string

PrivateEndpointProperty

Name	Tipo	Description
id	string	ID do recurso do ponto final privado.

PrivateEndpointProvisioningState

Estado da ligação de ponto final privado.

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

PrivateLinkServiceConnectionStateActionsRequire

As ações necessárias para a ligação do serviço de ligação privada.

Name	Tipo	Description
None	string

PrivateLinkServiceConnectionStateStatus

O estado da ligação do serviço de ligação privada.

Name	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccessEnum

Se o acesso à rede pública é ou não permitido para este servidor. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado"

Name	Tipo	Description
Disabled	string
Enabled	string

ResourceIdentity

Configuração de identidade do Azure Active Directory para um recurso.

Name	Tipo	Description
principalId	string	O ID principal do Azure Active Directory.
tenantId	string	O ID de inquilino do Azure Active Directory.
type	IdentityType	O tipo de identidade. Defina esta opção como "SystemAssigned" para criar e atribuir automaticamente um principal do Azure Active Directory para o recurso.

Server

Representa um servidor.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ResourceIdentity	A identidade do Azure Active Directory do servidor.
location	string	A localização geográfica onde reside o recurso
name	string	O nome do recurso
properties.administratorLogin	string	O nome de início de sessão do administrador de um servidor. Só pode ser especificado quando o servidor está a ser criado (e é necessário para a criação).
properties.byokEnforcement	string	Estado que mostra se a encriptação de dados do servidor está ativada com chaves geridas pelo cliente.
properties.earliestRestoreDate	string	Hora de criação do ponto de restauro mais antigo (formato ISO8601)
properties.fullyQualifiedDomainName	string	O nome de domínio completamente qualificado de um servidor.
properties.infrastructureEncryption	InfrastructureEncryption	Estado a mostrar se o servidor ativou a encriptação da infraestrutura.
properties.masterServerId	string	O ID do servidor mestre de um servidor de réplica.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Impor uma versão mínima do TLS para o servidor.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Lista de ligações de ponto final privado num servidor
properties.publicNetworkAccess	PublicNetworkAccessEnum	Se o acesso à rede pública é ou não permitido para este servidor. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado"
properties.replicaCapacity	integer	O número máximo de réplicas que um servidor mestre pode ter.
properties.replicationRole	string	A função de replicação do servidor.
properties.sslEnforcement	SslEnforcementEnum	Ative a imposição de ssl ou não quando ligar ao servidor.
properties.storageProfile	StorageProfile	Perfil de armazenamento de um servidor.
properties.userVisibleState	ServerState	Um estado de um servidor que é visível para o utilizador.
properties.version	ServerVersion	Versão do servidor.
sku	Sku	O SKU (escalão de preço) do servidor.
tags	object	Etiquetas de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ServerPrivateEndpointConnection

Uma ligação de ponto final privado num servidor

Name	Tipo	Description
id	string	ID do Recurso da Ligação de Ponto Final Privado.
properties	ServerPrivateEndpointConnectionProperties	Propriedades de ligação de ponto final privado

ServerPrivateEndpointConnectionProperties

Propriedades de uma ligação de ponto final privado.

Name	Tipo	Description
privateEndpoint	PrivateEndpointProperty	Ponto final privado ao qual pertence a ligação.
privateLinkServiceConnectionState	ServerPrivateLinkServiceConnectionStateProperty	Estado de ligação da ligação do ponto final privado.
provisioningState	PrivateEndpointProvisioningState	Estado da ligação de ponto final privado.

ServerPrivateLinkServiceConnectionStateProperty

Name	Tipo	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	As ações necessárias para a ligação do serviço de ligação privada.
description	string	A descrição da ligação do serviço de ligação privada.
status	PrivateLinkServiceConnectionStateStatus	O estado da ligação do serviço de ligação privada.

ServerState

Um estado de um servidor que é visível para o utilizador.

Name	Tipo	Description
Disabled	string
Dropping	string
Inaccessible	string
Ready	string

ServerVersion

A versão de um servidor.

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

Sku

Propriedades relacionadas com informações de faturação de um servidor.

Name	Tipo	Description
capacity	integer	A capacidade de aumento/aumento vertical, que representa as unidades de computação do servidor.
family	string	A família de hardware.
name	string	O nome do sku, normalmente, camada + família + núcleos, por exemplo, B_Gen4_1, GP_Gen5_8.
size	string	O código de tamanho, a ser interpretado pelo recurso conforme adequado.
tier	SkuTier	O escalão do SKU específico, por exemplo, Básico.

SkuTier

O escalão do SKU específico, por exemplo, Básico.

Name	Tipo	Description
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

Ative a imposição de ssl ou não quando ligar ao servidor.

Name	Tipo	Description
Disabled	string
Enabled	string

StorageAutogrow

Ativar o Aumento Automático do Armazenamento.

Name	Tipo	Description
Disabled	string
Enabled	string

StorageProfile

Propriedades do Perfil de Armazenamento de um servidor

Name	Tipo	Description
backupRetentionDays	integer	Dias de retenção da cópia de segurança para o servidor.
geoRedundantBackup	GeoRedundantBackup	Ative Georredundante ou não para cópia de segurança do servidor.
storageAutogrow	StorageAutogrow	Ativar o Aumento Automático do Armazenamento.
storageMB	integer	Armazenamento máximo permitido para um servidor.