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 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。 名稱不區分大小寫。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

回應

名稱	類型	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

範圍

名稱	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

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

定義

名稱	Description
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 服務的錯誤回應。

名稱	類型	Description
error	ErrorResponse	錯誤回應 所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 (這也會遵循 OData 錯誤回應格式。)

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorResponse

錯誤回應

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorResponse[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

GeoRedundantBackup

針對伺服器備份啟用異地備援或不啟用。

名稱	類型	Description
Disabled	string
Enabled	string

IdentityType

識別類型。 將此設定為 『SystemAssigned』，以便自動建立並指派資源的 Azure Active Directory 主體。

名稱	類型	Description
SystemAssigned	string

InfrastructureEncryption

使用新的加密演算法為您的資料新增第二層加密，以提供額外的數據保護。 值是選擇性的，但如果傳入，則必須是 『Disabled』 或 'Enabled'。

名稱	類型	Description
Disabled	string	待用數據的額外 (第 2 層) 加密
Enabled	string	待用數據的單一加密層預設值。

MinimalTlsVersionEnum

為伺服器強制執行最低 Tls 版本。

名稱	類型	Description
TLS1_0	string
TLS1_1	string
TLS1_2	string
TLSEnforcementDisabled	string

PrivateEndpointProperty

名稱	類型	Description
id	string	私人端點的資源標識碼。

PrivateEndpointProvisioningState

私人端點連線的狀態。

名稱	類型	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

私人鏈接服務連線所需的動作。

名稱	類型	Description
None	string

PrivateLinkServiceConnectionStateStatus

私人鏈接服務連線狀態。

名稱	類型	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccessEnum

此伺服器是否允許公用網路存取。 值是選擇性的，但如果傳入，則必須是 'Enabled' 或 'Disabled'

名稱	類型	Description
Disabled	string
Enabled	string

ResourceIdentity

資源的 Azure Active Directory 身分識別組態。

名稱	類型	Description
principalId	string	Azure Active Directory 主體標識符。
tenantId	string	Azure Active Directory 租用戶標識符。
type	IdentityType	識別類型。 將此設定為 『SystemAssigned』，以便自動建立並指派資源的 Azure Active Directory 主體。

Server

表示伺服器。

名稱	類型	Description
id	string	資源的完整資源識別碼。 例如 - /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	復本伺服器的主伺服器識別碼。
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

伺服器下的私人端點連線

名稱	類型	Description
id	string	私人端點聯機的資源標識碼。
properties	ServerPrivateEndpointConnectionProperties	私人端點連線屬性

ServerPrivateEndpointConnectionProperties

私人端點連線的屬性。

名稱	類型	Description
privateEndpoint	PrivateEndpointProperty	線上所屬的私人端點。
privateLinkServiceConnectionState	ServerPrivateLinkServiceConnectionStateProperty	私人端點連線的連接狀態。
provisioningState	PrivateEndpointProvisioningState	私人端點連線的狀態。

ServerPrivateLinkServiceConnectionStateProperty

名稱	類型	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	私人鏈接服務連線所需的動作。
description	string	私人鏈接服務連線描述。
status	PrivateLinkServiceConnectionStateStatus	私人鏈接服務連線狀態。

ServerState

使用者看得見的伺服器狀態。

名稱	類型	Description
Disabled	string
Dropping	string
Inaccessible	string
Ready	string

ServerVersion

伺服器的版本。

名稱	類型	Description
10	string
10.0	string
10.2	string
11	string
9.5	string
9.6	string

Sku

伺服器的計費資訊相關屬性。

名稱	類型	Description
capacity	integer	相應增加/放大容量，代表伺服器的計算單位。
family	string	硬體系列。
name	string	sku 的名稱，通常是階層 + 系列 + 核心，例如B_Gen4_1，GP_Gen5_8。
size	string	要適當地由資源解譯的大小程序代碼。
tier	SkuTier	特定 SKU 的層級，例如基本層。

SkuTier

特定 SKU 的層級，例如基本層。

名稱	類型	Description
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

在連線到伺服器時啟用 SSL 強制執行。

名稱	類型	Description
Disabled	string
Enabled	string

StorageAutogrow

啟用記憶體自動成長。

名稱	類型	Description
Disabled	string
Enabled	string

StorageProfile

伺服器的記憶體配置檔屬性

名稱	類型	Description
backupRetentionDays	integer	伺服器的備份保留天數。
geoRedundantBackup	GeoRedundantBackup	針對伺服器備份啟用異地備援或不啟用。
storageAutogrow	StorageAutogrow	啟用記憶體自動成長。
storageMB	integer	伺服器允許的最大記憶體。