Servers - Get

Служба:

PostgreSQL

Версия API:

2017-12-01

Возвращает сведения о сервере.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
serverName	path	True	string	Имени сервера.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	Server	ХОРОШО
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ServerGet

Образец запроса

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
CloudError	Ответ на ошибку из пакетной службы.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorResponse	Ответ на ошибку
GeoRedundantBackup	Включите геоизбыточное или не для резервного копирования сервера.
IdentityType	Тип удостоверения. Установите для параметра SystemAssigned значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.
InfrastructureEncryption	Добавьте второй уровень шифрования данных с помощью нового алгоритма шифрования, который обеспечивает дополнительную защиту данных. Значение является необязательным, но при передаче должно быть "Отключено" или "Включено".
MinimalTlsVersionEnum	Примените минимальную версию TLS для сервера.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Состояние подключения частной конечной точки.
PrivateLinkServiceConnectionStateActionsRequire	Действия, необходимые для подключения службы приватного канала.
PrivateLinkServiceConnectionStateStatus	Состояние подключения службы приватного канала.
PublicNetworkAccessEnum	Разрешено ли для этого сервера доступ к общедоступной сети. Значение является необязательным, но при передаче в нее должно быть включено или отключено.
ResourceIdentity	Конфигурация удостоверений Azure Active Directory для ресурса.
Server	Представляет сервер.
ServerPrivateEndpointConnection	Подключение частной конечной точки под сервером
ServerPrivateEndpointConnectionProperties	Свойства подключения частной конечной точки.
ServerPrivateLinkServiceConnectionStateProperty
ServerState	Состояние сервера, видимого пользователю.
ServerVersion	Версия сервера.
Sku	Сведения о выставлении счетов, связанные с свойствами сервера.
SkuTier	Уровень конкретного номера SKU, например "Базовый".
SslEnforcementEnum	Включите принудительное применение SSL или нет при подключении к серверу.
StorageAutogrow	Включить автоматическое увеличение хранилища.
StorageProfile	Свойства профиля хранилища сервера

CloudError

Object

Ответ на ошибку из пакетной службы.

Имя	Тип	Описание
error	ErrorResponse	Ответ на ошибку Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа на ошибку OData.)

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorResponse[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

GeoRedundantBackup

Перечисление

Включите геоизбыточное или не для резервного копирования сервера.

Значение	Описание
Disabled
Enabled

IdentityType

Перечисление

Тип удостоверения. Установите для параметра SystemAssigned значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.

Значение	Описание
SystemAssigned

InfrastructureEncryption

Перечисление

Добавьте второй уровень шифрования данных с помощью нового алгоритма шифрования, который обеспечивает дополнительную защиту данных. Значение является необязательным, но при передаче должно быть "Отключено" или "Включено".

Значение	Описание
Disabled	Дополнительный (2-й) уровень шифрования для неактивных данных
Enabled	Значение по умолчанию для одного уровня шифрования для неактивных данных.

MinimalTlsVersionEnum

Перечисление

Примените минимальную версию TLS для сервера.

Значение	Описание
TLS1_0
TLS1_1
TLS1_2
TLSEnforcementDisabled

PrivateEndpointProperty

Object

Имя	Тип	Описание
id	string	Идентификатор ресурса частной конечной точки.

PrivateEndpointProvisioningState

Перечисление

Состояние подключения частной конечной точки.

Значение	Описание
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Перечисление

Действия, необходимые для подключения службы приватного канала.

Значение	Описание
None

PrivateLinkServiceConnectionStateStatus

Перечисление

Состояние подключения службы приватного канала.

Значение	Описание
Approved
Disconnected
Pending
Rejected

PublicNetworkAccessEnum

Перечисление

Разрешено ли для этого сервера доступ к общедоступной сети. Значение является необязательным, но при передаче в нее должно быть включено или отключено.

Значение	Описание
Disabled
Enabled

ResourceIdentity

Object

Конфигурация удостоверений Azure Active Directory для ресурса.

Имя	Тип	Описание
principalId	string (uuid)	Идентификатор субъекта Azure Active Directory.
tenantId	string (uuid)	Идентификатор клиента Azure Active Directory.
type	IdentityType	Тип удостоверения. Установите для параметра SystemAssigned значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.

Server

Object

Представляет сервер.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ResourceIdentity	Удостоверение Azure Active Directory сервера.
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.administratorLogin	string	Имя входа администратора сервера. Можно указать только при создании сервера (и требуется для создания).
properties.byokEnforcement	string	Состояние, показывающее, включена ли шифрование данных сервера с помощью ключей, управляемых клиентом.
properties.earliestRestoreDate	string (date-time)	Самое раннее время создания точки восстановления (ISO8601 формат)
properties.fullyQualifiedDomainName	string	Полное доменное имя сервера.
properties.infrastructureEncryption	InfrastructureEncryption	Состояние, показывающее, включена ли шифрование инфраструктуры с поддержкой сервера.
properties.masterServerId	string	Идентификатор главного сервера реплики.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Примените минимальную версию TLS для сервера.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Список подключений к частной конечной точке на сервере
properties.publicNetworkAccess	PublicNetworkAccessEnum	Разрешено ли для этого сервера доступ к общедоступной сети. Значение является необязательным, но при передаче в нее должно быть включено или отключено.
properties.replicaCapacity	integer (int32) minimum: 0	Максимальное количество реплик, которые может иметь главный сервер.
properties.replicationRole	string	Роль репликации сервера.
properties.sslEnforcement	SslEnforcementEnum	Включите принудительное применение SSL или нет при подключении к серверу.
properties.storageProfile	StorageProfile	Профиль хранения сервера.
properties.userVisibleState	ServerState	Состояние сервера, видимого пользователю.
properties.version	ServerVersion	Версия сервера.
sku	Sku	Номер SKU (ценовая категория) сервера.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ServerPrivateEndpointConnection

Object

Подключение частной конечной точки под сервером

Имя	Тип	Описание
id	string	Идентификатор ресурса подключения к частной конечной точке.
properties	ServerPrivateEndpointConnectionProperties	Свойства подключения к частной конечной точке

ServerPrivateEndpointConnectionProperties

Object

Свойства подключения частной конечной точки.

Имя	Тип	Описание
privateEndpoint	PrivateEndpointProperty	Частная конечная точка, к которой принадлежит подключение.
privateLinkServiceConnectionState	ServerPrivateLinkServiceConnectionStateProperty	Состояние подключения частной конечной точки.
provisioningState	PrivateEndpointProvisioningState	Состояние подключения частной конечной точки.

ServerPrivateLinkServiceConnectionStateProperty

Object

Имя	Тип	Описание
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Действия, необходимые для подключения службы приватного канала.
description	string	Описание подключения службы приватного канала.
status	PrivateLinkServiceConnectionStateStatus	Состояние подключения службы приватного канала.

ServerState

Перечисление

Состояние сервера, видимого пользователю.

Значение	Описание
Disabled
Dropping
Inaccessible
Ready

ServerVersion

Перечисление

Версия сервера.

Значение	Описание
10
10.0
10.2
11
9.5
9.6

Sku

Object

Сведения о выставлении счетов, связанные с свойствами сервера.

Имя	Тип	Описание
capacity	integer (int32) minimum: 0	Емкость увеличения и увеличения масштаба, представляющая вычислительные единицы сервера.
family	string	Семейство оборудования.
name	string	Имя SKU, как правило, уровня + семейства и ядер, например B_Gen4_1, GP_Gen5_8.
size	string	Код размера, интерпретируемый ресурсом соответствующим образом.
tier	SkuTier	Уровень конкретного номера SKU, например "Базовый".

SkuTier

Перечисление

Уровень конкретного номера SKU, например "Базовый".

Значение	Описание
Basic
GeneralPurpose
MemoryOptimized

SslEnforcementEnum

Перечисление

Включите принудительное применение SSL или нет при подключении к серверу.

Значение	Описание
Disabled
Enabled

StorageAutogrow

Перечисление

Включить автоматическое увеличение хранилища.

Значение	Описание
Disabled
Enabled

StorageProfile

Object

Свойства профиля хранилища сервера

Имя	Тип	Описание
backupRetentionDays	integer (int32)	Дни хранения резервных копий для сервера.
geoRedundantBackup	GeoRedundantBackup	Включите геоизбыточное или не для резервного копирования сервера.
storageAutogrow	StorageAutogrow	Включить автоматическое увеличение хранилища.
storageMB	integer (int32)	Максимально допустимое хранилище для сервера.