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 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
serverName	path	True	string	서버의 이름입니다.
subscriptionId	path	True	string	대상 구독의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	Server	정상
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
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

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

샘플 응답

상태 코드:

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

정의

Name	Description
CloudError	Batch 서비스의 오류 응답입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorResponse	오류 응답
GeoRedundantBackup	서버 백업에 지역 중복 여부를 사용하도록 설정합니다.
IdentityType	ID 형식입니다. 리소스에 대한 Azure Active Directory 보안 주체를 자동으로 만들고 할당하려면 이를 'SystemAssigned'로 설정합니다.
InfrastructureEncryption	추가 데이터 보호를 제공하는 새 암호화 알고리즘을 사용하여 데이터에 대한 두 번째 암호화 계층을 추가합니다. 값은 선택 사항이지만 전달된 경우 '사용 안 함' 또는 '사용'이어야 합니다.
MinimalTlsVersionEnum	서버에 최소 Tls 버전을 적용합니다.
PrivateEndpointProperty
PrivateEndpointProvisioningState	프라이빗 엔드포인트 연결의 상태입니다.
PrivateLinkServiceConnectionStateActionsRequire	프라이빗 링크 서비스 연결에 필요한 작업입니다.
PrivateLinkServiceConnectionStateStatus	프라이빗 링크 서비스 연결 상태.
PublicNetworkAccessEnum	이 서버에 대한 공용 네트워크 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달된 경우 '사용' 또는 '사용 안 함'이어야 합니다.
ResourceIdentity	리소스에 대한 Azure Active Directory ID 구성입니다.
Server	서버를 나타냅니다.
ServerPrivateEndpointConnection	서버 아래의 프라이빗 엔드포인트 연결
ServerPrivateEndpointConnectionProperties	프라이빗 엔드포인트 연결의 속성입니다.
ServerPrivateLinkServiceConnectionStateProperty
ServerState	사용자에게 표시되는 서버의 상태입니다.
ServerVersion	서버의 버전입니다.
Sku	서버의 청구 정보 관련 속성입니다.
SkuTier	특정 SKU의 계층(예: Basic)입니다.
SslEnforcementEnum	서버에 연결할 때 ssl 적용을 사용하도록 설정합니다.
StorageAutogrow	스토리지 자동 증가를 사용하도록 설정합니다.
StorageProfile	서버의 스토리지 프로필 속성

CloudError

Batch 서비스의 오류 응답입니다.

Name	형식	Description
error	ErrorResponse	오류 응답 실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. OData 오류 응답 형식도 따릅니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorResponse

오류 응답

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorResponse[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

GeoRedundantBackup

서버 백업에 지역 중복 여부를 사용하도록 설정합니다.

Name	형식	Description
Disabled	string
Enabled	string

IdentityType

ID 형식입니다. 리소스에 대한 Azure Active Directory 보안 주체를 자동으로 만들고 할당하려면 이를 'SystemAssigned'로 설정합니다.

Name	형식	Description
SystemAssigned	string

InfrastructureEncryption

추가 데이터 보호를 제공하는 새 암호화 알고리즘을 사용하여 데이터에 대한 두 번째 암호화 계층을 추가합니다. 값은 선택 사항이지만 전달된 경우 '사용 안 함' 또는 '사용'이어야 합니다.

Name	형식	Description
Disabled	string	미사용 데이터에 대한 추가(2차) 암호화 계층
Enabled	string	미사용 데이터에 대한 단일 암호화 계층의 기본값입니다.

MinimalTlsVersionEnum

서버에 최소 Tls 버전을 적용합니다.

Name	형식	Description
TLS1_0	string
TLS1_1	string
TLS1_2	string
TLSEnforcementDisabled	string

PrivateEndpointProperty

Name	형식	Description
id	string	프라이빗 엔드포인트의 리소스 ID입니다.

PrivateEndpointProvisioningState

프라이빗 엔드포인트 연결의 상태입니다.

Name	형식	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

프라이빗 링크 서비스 연결에 필요한 작업입니다.

Name	형식	Description
None	string

PrivateLinkServiceConnectionStateStatus

프라이빗 링크 서비스 연결 상태.

Name	형식	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccessEnum

이 서버에 대한 공용 네트워크 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달된 경우 '사용' 또는 '사용 안 함'이어야 합니다.

Name	형식	Description
Disabled	string
Enabled	string

ResourceIdentity

리소스에 대한 Azure Active Directory ID 구성입니다.

Name	형식	Description
principalId	string	Azure Active Directory 보안 주체 ID입니다.
tenantId	string	Azure Active Directory 테넌트 ID입니다.
type	IdentityType	ID 형식입니다. 리소스에 대한 Azure Active Directory 보안 주체를 자동으로 만들고 할당하려면 이를 'SystemAssigned'로 설정합니다.

Server

서버를 나타냅니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ResourceIdentity	서버의 Azure Active Directory ID입니다.
location	string	리소스가 있는 지리적 위치
name	string	리소스의 이름입니다.
properties.administratorLogin	string	서버의 관리자 로그인 이름입니다. 서버를 만들 때만 지정할 수 있습니다(만들기에 필요).
properties.byokEnforcement	string	고객 관리형 키를 사용하여 서버 데이터 암호화를 사용할 수 있는지 여부를 보여 주는 상태입니다.
properties.earliestRestoreDate	string	가장 빠른 복원 지점 생성 시간(ISO8601 형식)
properties.fullyQualifiedDomainName	string	서버의 정규화된 도메인 이름입니다.
properties.infrastructureEncryption	InfrastructureEncryption	서버에서 인프라 암호화를 사용하도록 설정했는지 여부를 보여 주는 상태입니다.
properties.masterServerId	string	복제본(replica) 서버의 master 서버 ID입니다.
properties.minimalTlsVersion	MinimalTlsVersionEnum	서버에 최소 Tls 버전을 적용합니다.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	서버의 프라이빗 엔드포인트 연결 목록
properties.publicNetworkAccess	PublicNetworkAccessEnum	이 서버에 대한 공용 네트워크 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달된 경우 '사용' 또는 '사용 안 함'이어야 합니다.
properties.replicaCapacity	integer	master 서버에 있을 수 있는 최대 복제본 수입니다.
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

서버 아래의 프라이빗 엔드포인트 연결

Name	형식	Description
id	string	프라이빗 엔드포인트 연결의 리소스 ID입니다.
properties	ServerPrivateEndpointConnectionProperties	프라이빗 엔드포인트 연결 속성

ServerPrivateEndpointConnectionProperties

프라이빗 엔드포인트 연결의 속성입니다.

Name	형식	Description
privateEndpoint	PrivateEndpointProperty	연결이 속한 프라이빗 엔드포인트입니다.
privateLinkServiceConnectionState	ServerPrivateLinkServiceConnectionStateProperty	프라이빗 엔드포인트 연결의 연결 상태입니다.
provisioningState	PrivateEndpointProvisioningState	프라이빗 엔드포인트 연결의 상태입니다.

ServerPrivateLinkServiceConnectionStateProperty

Name	형식	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	프라이빗 링크 서비스 연결에 필요한 작업입니다.
description	string	프라이빗 링크 서비스 연결 설명입니다.
status	PrivateLinkServiceConnectionStateStatus	프라이빗 링크 서비스 연결 상태.

ServerState

사용자에게 표시되는 서버의 상태입니다.

Name	형식	Description
Disabled	string
Dropping	string
Inaccessible	string
Ready	string

ServerVersion

서버의 버전입니다.

Name	형식	Description
10	string
10.0	string
10.2	string
11	string
9.5	string
9.6	string

Sku

서버의 청구 정보 관련 속성입니다.

Name	형식	Description
capacity	integer	서버의 컴퓨팅 단위를 나타내는 스케일 업/아웃 용량입니다.
family	string	하드웨어 제품군입니다.
name	string	sku의 이름(일반적으로 계층 + 제품군 + 코어)(예: B_Gen4_1, GP_Gen5_8)입니다.
size	string	리소스에서 적절하게 해석할 크기 코드입니다.
tier	SkuTier	특정 SKU의 계층(예: Basic)입니다.

SkuTier

특정 SKU의 계층(예: Basic)입니다.

Name	형식	Description
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

서버에 연결할 때 ssl 적용을 사용하도록 설정합니다.

Name	형식	Description
Disabled	string
Enabled	string

StorageAutogrow

스토리지 자동 증가를 사용하도록 설정합니다.

Name	형식	Description
Disabled	string
Enabled	string

StorageProfile

서버의 스토리지 프로필 속성

Name	형식	Description
backupRetentionDays	integer	서버의 백업 보존 기간(일)입니다.
geoRedundantBackup	GeoRedundantBackup	서버 백업에 지역 중복 여부를 사용하도록 설정합니다.
storageAutogrow	StorageAutogrow	스토리지 자동 증가를 사용하도록 설정합니다.
storageMB	integer	서버에 허용되는 최대 스토리지입니다.