你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	资源组的名称。 此名称不区分大小写。
serverName	path	True	string	服务器的名称。
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	Server	确定
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: 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

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

定义

名称	说明
CloudError	Batch 服务的错误响应。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorResponse	错误响应
GeoRedundantBackup	为服务器备份启用异地冗余或不启用。
IdentityType	标识类型。 将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。
InfrastructureEncryption	使用提供额外数据保护的新加密算法为数据添加第二层加密。 值是可选的，但如果传入，则必须为“Disabled”或“Enabled”。
MinimalTlsVersionEnum	为服务器强制实施最低 Tls 版本。
PrivateEndpointProperty
PrivateEndpointProvisioningState	专用终结点连接的状态。
PrivateLinkServiceConnectionStateActionsRequire	专用链接服务连接所需的操作。
PrivateLinkServiceConnectionStateStatus	专用链接服务连接状态。
PublicNetworkAccessEnum	是否允许此服务器访问公用网络。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled”
ResourceIdentity	资源的 Azure Active Directory 标识配置。
Server	表示服务器。
ServerPrivateEndpointConnection	服务器下的专用终结点连接
ServerPrivateEndpointConnectionProperties	专用终结点连接的属性。
ServerPrivateLinkServiceConnectionStateProperty
ServerState	用户可见的服务器的状态。
ServerVersion	服务器的版本。
Sku	服务器的计费信息相关属性。
SkuTier	特定 SKU 的层，例如基本。
SslEnforcementEnum	在连接到服务器时是否启用 ssl 强制实施。
StorageAutogrow	启用存储自动增长。
StorageProfile	服务器的存储配置文件属性

CloudError

Batch 服务的错误响应。

名称	类型	说明
error	ErrorResponse	错误响应 对所有 Azure 资源管理器 API 的常见错误响应，可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式。)

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorResponse

错误响应

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorResponse[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

GeoRedundantBackup

为服务器备份启用异地冗余或不启用。

名称	类型	说明
Disabled	string
Enabled	string

IdentityType

标识类型。 将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。

名称	类型	说明
SystemAssigned	string

InfrastructureEncryption

使用提供额外数据保护的新加密算法为数据添加第二层加密。 值是可选的，但如果传入，则必须为“Disabled”或“Enabled”。

名称	类型	说明
Disabled	string	为静态数据附加 (第二个) 加密层
Enabled	string	静态数据单层加密的默认值。

MinimalTlsVersionEnum

为服务器强制实施最低 Tls 版本。

名称	类型	说明
TLS1_0	string
TLS1_1	string
TLS1_2	string
TLSEnforcementDisabled	string

PrivateEndpointProperty

名称	类型	说明
id	string	专用终结点的资源 ID。

PrivateEndpointProvisioningState

专用终结点连接的状态。

名称	类型	说明
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

专用链接服务连接所需的操作。

名称	类型	说明
None	string

PrivateLinkServiceConnectionStateStatus

专用链接服务连接状态。

名称	类型	说明
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccessEnum

是否允许此服务器访问公用网络。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled”

名称	类型	说明
Disabled	string
Enabled	string

ResourceIdentity

资源的 Azure Active Directory 标识配置。

名称	类型	说明
principalId	string	Azure Active Directory 主体 ID。
tenantId	string	Azure Active Directory 租户 ID。
type	IdentityType	标识类型。 将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。

Server

表示服务器。

名称	类型	说明
id	string	资源的完全限定的资源 ID。 例如 - /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	最早的还原点创建时间 (ISO8601 格式)
properties.fullyQualifiedDomainName	string	服务器的完全限定域名。
properties.infrastructureEncryption	InfrastructureEncryption	显示服务器是否已启用基础结构加密的状态。
properties.masterServerId	string	副本 (replica) 服务器的主服务器 ID。
properties.minimalTlsVersion	MinimalTlsVersionEnum	为服务器强制实施最低 Tls 版本。
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	服务器上的专用终结点连接列表
properties.publicNetworkAccess	PublicNetworkAccessEnum	是否允许此服务器访问公用网络。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled”
properties.replicaCapacity	integer	主服务器可以具有的最大副本数。
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

服务器下的专用终结点连接

名称	类型	说明
id	string	专用终结点连接的资源 ID。
properties	ServerPrivateEndpointConnectionProperties	专用终结点连接属性

ServerPrivateEndpointConnectionProperties

专用终结点连接的属性。

名称	类型	说明
privateEndpoint	PrivateEndpointProperty	连接所属的专用终结点。
privateLinkServiceConnectionState	ServerPrivateLinkServiceConnectionStateProperty	专用终结点连接的连接状态。
provisioningState	PrivateEndpointProvisioningState	专用终结点连接的状态。

ServerPrivateLinkServiceConnectionStateProperty

名称	类型	说明
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	专用链接服务连接所需的操作。
description	string	专用链接服务连接说明。
status	PrivateLinkServiceConnectionStateStatus	专用链接服务连接状态。

ServerState

用户可见的服务器的状态。

名称	类型	说明
Disabled	string
Dropping	string
Inaccessible	string
Ready	string

ServerVersion

服务器的版本。

名称	类型	说明
10	string
10.0	string
10.2	string
11	string
9.5	string
9.6	string

Sku

服务器的计费信息相关属性。

名称	类型	说明
capacity	integer	扩展/横向扩展容量，表示服务器的计算单位。
family	string	硬件系列。
name	string	sku 的名称，通常为层 + 系列 + 核心，例如B_Gen4_1、GP_Gen5_8。
size	string	大小代码，由资源根据需要解释。
tier	SkuTier	特定 SKU 的层，例如基本。

SkuTier

特定 SKU 的层，例如基本。

名称	类型	说明
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

在连接到服务器时是否启用 ssl 强制实施。

名称	类型	说明
Disabled	string
Enabled	string

StorageAutogrow

启用存储自动增长。

名称	类型	说明
Disabled	string
Enabled	string

StorageProfile

服务器的存储配置文件属性

名称	类型	说明
backupRetentionDays	integer	服务器的备份保留天数。
geoRedundantBackup	GeoRedundantBackup	为服务器备份启用异地冗余或不启用。
storageAutogrow	StorageAutogrow	启用存储自动增长。
storageMB	integer	服务器允许的最大存储。