Replicas - List By Server

Service:

PostgreSQL

API Version:

2017-12-01

特定のサーバーのすべてのレプリカを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/replicas?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	ServerListResult	OK
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

ReplicasListByServer

Sample Request

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master/replicas?api-version=2017-12-01

Java

import com.azure.core.util.Context;

/** Samples for Replicas ListByServer. */
public final class Main {
    /*
     * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ReplicasListByServer.json
     */
    /**
     * Sample code: ReplicasListByServer.
     *
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void replicasListByServer(com.azure.resourcemanager.postgresql.PostgreSqlManager manager) {
        manager.replicas().listByServer("TestGroup_WestCentralUS", "testserver-master", 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 replicas_list_by_server.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.replicas.list_by_server(
        resource_group_name="TestGroup_WestCentralUS",
        server_name="testserver-master",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ReplicasListByServer.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/ReplicasListByServer.json
func ExampleReplicasClient_NewListByServerPager() {
	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)
	}
	pager := clientFactory.NewReplicasClient().NewListByServerPager("TestGroup_WestCentralUS", "testserver-master", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServerListResult = armpostgresql.ServerListResult{
		// 	Value: []*armpostgresql.Server{
		// 		{
		// 			Name: to.Ptr("testserver-replica1"),
		// 			Type: to.Ptr("Microsoft.DBforPostgreSQL/servers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica1"),
		// 			Location: to.Ptr("westcentralus"),
		// 			Properties: &armpostgresql.ServerProperties{
		// 				AdministratorLogin: to.Ptr("postgres"),
		// 				EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-12T00:05:03.269Z"); return t}()),
		// 				FullyQualifiedDomainName: to.Ptr("testserver-replica1.postgres.database.azure.com"),
		// 				MasterServerID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master"),
		// 				ReplicaCapacity: to.Ptr[int32](0),
		// 				ReplicationRole: to.Ptr("Replica"),
		// 				SSLEnforcement: to.Ptr(armpostgresql.SSLEnforcementEnumDisabled),
		// 				StorageProfile: &armpostgresql.StorageProfile{
		// 					BackupRetentionDays: to.Ptr[int32](7),
		// 					GeoRedundantBackup: to.Ptr(armpostgresql.GeoRedundantBackupDisabled),
		// 					StorageMB: to.Ptr[int32](2048000),
		// 				},
		// 				UserVisibleState: to.Ptr(armpostgresql.ServerStateReady),
		// 				Version: to.Ptr(armpostgresql.ServerVersionNine6),
		// 			},
		// 			SKU: &armpostgresql.SKU{
		// 				Name: to.Ptr("GP_Gen4_16"),
		// 				Capacity: to.Ptr[int32](16),
		// 				Family: to.Ptr("Gen4"),
		// 				Tier: to.Ptr(armpostgresql.SKUTierGeneralPurpose),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("testserver-replica2"),
		// 			Type: to.Ptr("Microsoft.DBforPostgreSQL/servers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica2"),
		// 			Location: to.Ptr("westcentralus"),
		// 			Properties: &armpostgresql.ServerProperties{
		// 				AdministratorLogin: to.Ptr("postgres"),
		// 				EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-12T00:05:03.269Z"); return t}()),
		// 				FullyQualifiedDomainName: to.Ptr("testserver-replica2.postgres.database.azure.com"),
		// 				MasterServerID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master"),
		// 				ReplicaCapacity: to.Ptr[int32](0),
		// 				ReplicationRole: to.Ptr("Replica"),
		// 				SSLEnforcement: to.Ptr(armpostgresql.SSLEnforcementEnumDisabled),
		// 				StorageProfile: &armpostgresql.StorageProfile{
		// 					BackupRetentionDays: to.Ptr[int32](7),
		// 					GeoRedundantBackup: to.Ptr(armpostgresql.GeoRedundantBackupDisabled),
		// 					StorageMB: to.Ptr[int32](2048000),
		// 				},
		// 				UserVisibleState: to.Ptr(armpostgresql.ServerStateReady),
		// 				Version: to.Ptr(armpostgresql.ServerVersionNine6),
		// 			},
		// 			SKU: &armpostgresql.SKU{
		// 				Name: to.Ptr("GP_Gen4_16"),
		// 				Capacity: to.Ptr[int32](16),
		// 				Family: to.Ptr("Gen4"),
		// 				Tier: to.Ptr(armpostgresql.SKUTierGeneralPurpose),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("testserver-replica3"),
		// 			Type: to.Ptr("Microsoft.DBforPostgreSQL/servers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica3"),
		// 			Location: to.Ptr("westcentralus"),
		// 			Properties: &armpostgresql.ServerProperties{
		// 				AdministratorLogin: to.Ptr("postgres"),
		// 				EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-12T00:05:03.269Z"); return t}()),
		// 				FullyQualifiedDomainName: to.Ptr("testserver-replica3.postgres.database.azure.com"),
		// 				MasterServerID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master"),
		// 				ReplicaCapacity: to.Ptr[int32](0),
		// 				ReplicationRole: to.Ptr("Replica"),
		// 				SSLEnforcement: to.Ptr(armpostgresql.SSLEnforcementEnumDisabled),
		// 				StorageProfile: &armpostgresql.StorageProfile{
		// 					BackupRetentionDays: to.Ptr[int32](7),
		// 					GeoRedundantBackup: to.Ptr(armpostgresql.GeoRedundantBackupDisabled),
		// 					StorageMB: to.Ptr[int32](2048000),
		// 				},
		// 				UserVisibleState: to.Ptr(armpostgresql.ServerStateReady),
		// 				Version: to.Ptr(armpostgresql.ServerVersionNine6),
		// 			},
		// 			SKU: &armpostgresql.SKU{
		// 				Name: to.Ptr("GP_Gen4_16"),
		// 				Capacity: to.Ptr[int32](16),
		// 				Family: to.Ptr("Gen4"),
		// 				Tier: to.Ptr(armpostgresql.SKUTierGeneralPurpose),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("testserver-replica4"),
		// 			Type: to.Ptr("Microsoft.DBforPostgreSQL/servers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica4"),
		// 			Location: to.Ptr("westcentralus"),
		// 			Properties: &armpostgresql.ServerProperties{
		// 				AdministratorLogin: to.Ptr("postgres"),
		// 				EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-12T00:05:03.269Z"); return t}()),
		// 				FullyQualifiedDomainName: to.Ptr("testserver-replica4.postgres.database.azure.com"),
		// 				MasterServerID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master"),
		// 				ReplicaCapacity: to.Ptr[int32](0),
		// 				ReplicationRole: to.Ptr("Replica"),
		// 				SSLEnforcement: to.Ptr(armpostgresql.SSLEnforcementEnumDisabled),
		// 				StorageProfile: &armpostgresql.StorageProfile{
		// 					BackupRetentionDays: to.Ptr[int32](7),
		// 					GeoRedundantBackup: to.Ptr(armpostgresql.GeoRedundantBackupDisabled),
		// 					StorageMB: to.Ptr[int32](2048000),
		// 				},
		// 				UserVisibleState: to.Ptr(armpostgresql.ServerStateReady),
		// 				Version: to.Ptr(armpostgresql.ServerVersionNine6),
		// 			},
		// 			SKU: &armpostgresql.SKU{
		// 				Name: to.Ptr("GP_Gen4_16"),
		// 				Capacity: to.Ptr[int32](16),
		// 				Family: to.Ptr("Gen4"),
		// 				Tier: to.Ptr(armpostgresql.SKUTierGeneralPurpose),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("testserver-replica5"),
		// 			Type: to.Ptr("Microsoft.DBforPostgreSQL/servers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica5"),
		// 			Location: to.Ptr("westcentralus"),
		// 			Properties: &armpostgresql.ServerProperties{
		// 				AdministratorLogin: to.Ptr("postgres"),
		// 				EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-12T00:05:03.269Z"); return t}()),
		// 				FullyQualifiedDomainName: to.Ptr("testserver-replica5.postgres.database.azure.com"),
		// 				MasterServerID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master"),
		// 				ReplicaCapacity: to.Ptr[int32](0),
		// 				ReplicationRole: to.Ptr("Replica"),
		// 				SSLEnforcement: to.Ptr(armpostgresql.SSLEnforcementEnumDisabled),
		// 				StorageProfile: &armpostgresql.StorageProfile{
		// 					BackupRetentionDays: to.Ptr[int32](7),
		// 					GeoRedundantBackup: to.Ptr(armpostgresql.GeoRedundantBackupDisabled),
		// 					StorageMB: to.Ptr[int32](2048000),
		// 				},
		// 				UserVisibleState: to.Ptr(armpostgresql.ServerStateReady),
		// 				Version: to.Ptr(armpostgresql.ServerVersionNine6),
		// 			},
		// 			SKU: &armpostgresql.SKU{
		// 				Name: to.Ptr("GP_Gen4_16"),
		// 				Capacity: to.Ptr[int32](16),
		// 				Family: to.Ptr("Gen4"),
		// 				Tier: to.Ptr(armpostgresql.SKUTierGeneralPurpose),
		// 			},
		// 	}},
		// }
	}
}

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 List all the replicas for a given server.
 *
 * @summary List all the replicas for a given server.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ReplicasListByServer.json
 */
async function replicasListByServer() {
  const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = "TestGroup_WestCentralUS";
  const serverName = "testserver-master";
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.replicas.listByServer(resourceGroupName, serverName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

replicasListByServer().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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.PostgreSql;
using Azure.ResourceManager.PostgreSql.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ReplicasListByServer.json
// this example is just showing the usage of "Replicas_ListByServer" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
string resourceGroupName = "TestGroup_WestCentralUS";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this PostgreSqlServerResource
PostgreSqlServerCollection collection = resourceGroupResource.GetPostgreSqlServers();

// invoke the operation and iterate over the result
string serverName = "testserver-master";
await foreach (PostgreSqlServerResource item in collection.GetReplicasAsync(serverName))
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "sku": {
        "name": "GP_Gen4_16",
        "tier": "GeneralPurpose",
        "family": "Gen4",
        "capacity": 16
      },
      "properties": {
        "administratorLogin": "postgres",
        "storageProfile": {
          "storageMB": 2048000,
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled"
        },
        "version": "9.6",
        "sslEnforcement": "Disabled",
        "userVisibleState": "Ready",
        "fullyQualifiedDomainName": "testserver-replica1.postgres.database.azure.com",
        "earliestRestoreDate": "2018-06-12T00:05:03.2695756+00:00",
        "replicationRole": "Replica",
        "masterServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master",
        "replicaCapacity": 0
      },
      "location": "westcentralus",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica1",
      "name": "testserver-replica1",
      "type": "Microsoft.DBforPostgreSQL/servers"
    },
    {
      "sku": {
        "name": "GP_Gen4_16",
        "tier": "GeneralPurpose",
        "family": "Gen4",
        "capacity": 16
      },
      "properties": {
        "administratorLogin": "postgres",
        "storageProfile": {
          "storageMB": 2048000,
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled"
        },
        "version": "9.6",
        "sslEnforcement": "Disabled",
        "userVisibleState": "Ready",
        "fullyQualifiedDomainName": "testserver-replica2.postgres.database.azure.com",
        "earliestRestoreDate": "2018-06-12T00:05:03.2695756+00:00",
        "replicationRole": "Replica",
        "masterServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master",
        "replicaCapacity": 0
      },
      "location": "westcentralus",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica2",
      "name": "testserver-replica2",
      "type": "Microsoft.DBforPostgreSQL/servers"
    },
    {
      "sku": {
        "name": "GP_Gen4_16",
        "tier": "GeneralPurpose",
        "family": "Gen4",
        "capacity": 16
      },
      "properties": {
        "administratorLogin": "postgres",
        "storageProfile": {
          "storageMB": 2048000,
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled"
        },
        "version": "9.6",
        "sslEnforcement": "Disabled",
        "userVisibleState": "Ready",
        "fullyQualifiedDomainName": "testserver-replica3.postgres.database.azure.com",
        "earliestRestoreDate": "2018-06-12T00:05:03.2695756+00:00",
        "replicationRole": "Replica",
        "masterServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master",
        "replicaCapacity": 0
      },
      "location": "westcentralus",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica3",
      "name": "testserver-replica3",
      "type": "Microsoft.DBforPostgreSQL/servers"
    },
    {
      "sku": {
        "name": "GP_Gen4_16",
        "tier": "GeneralPurpose",
        "family": "Gen4",
        "capacity": 16
      },
      "properties": {
        "administratorLogin": "postgres",
        "storageProfile": {
          "storageMB": 2048000,
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled"
        },
        "version": "9.6",
        "sslEnforcement": "Disabled",
        "userVisibleState": "Ready",
        "fullyQualifiedDomainName": "testserver-replica4.postgres.database.azure.com",
        "earliestRestoreDate": "2018-06-12T00:05:03.2695756+00:00",
        "replicationRole": "Replica",
        "masterServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master",
        "replicaCapacity": 0
      },
      "location": "westcentralus",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica4",
      "name": "testserver-replica4",
      "type": "Microsoft.DBforPostgreSQL/servers"
    },
    {
      "sku": {
        "name": "GP_Gen4_16",
        "tier": "GeneralPurpose",
        "family": "Gen4",
        "capacity": 16
      },
      "properties": {
        "administratorLogin": "postgres",
        "storageProfile": {
          "storageMB": 2048000,
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled"
        },
        "version": "9.6",
        "sslEnforcement": "Disabled",
        "userVisibleState": "Ready",
        "fullyQualifiedDomainName": "testserver-replica5.postgres.database.azure.com",
        "earliestRestoreDate": "2018-06-12T00:05:03.2695756+00:00",
        "replicationRole": "Replica",
        "masterServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master",
        "replicaCapacity": 0
      },
      "location": "westcentralus",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica5",
      "name": "testserver-replica5",
      "type": "Microsoft.DBforPostgreSQL/servers"
    }
  ]
}

定義

名前	説明
CloudError	Batch サービスからのエラー応答。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
GeoRedundantBackup	サーバー バックアップで geo 冗長を有効にするか、有効にしないか。
IdentityType	ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。
InfrastructureEncryption	データ保護を強化する新しい暗号化アルゴリズムを使用して、データの 2 番目の暗号化レイヤーを追加します。 値は省略可能ですが、渡される場合は 、'Disabled' または 'Enabled' である必要があります。
MinimalTlsVersionEnum	サーバーに最小限の Tls バージョンを適用します。
PrivateEndpointProperty
PrivateEndpointProvisioningState	プライベート エンドポイント接続の状態。
PrivateLinkServiceConnectionStateActionsRequire	プライベート リンク サービス接続に必要なアクション。
PrivateLinkServiceConnectionStateStatus	プライベート リンク サービスの接続状態。
PublicNetworkAccessEnum	このサーバーに対してパブリック ネットワーク アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 、'Enabled' または 'Disabled' である必要があります
ResourceIdentity	リソースの Azure Active Directory ID 構成。
Server	サーバーを表します。
ServerListResult	サーバーの一覧。
ServerPrivateEndpointConnection	サーバー下のプライベート エンドポイント接続
ServerPrivateEndpointConnectionProperties	プライベート エンドポイント接続のプロパティ。
ServerPrivateLinkServiceConnectionStateProperty
ServerState	ユーザーに表示されるサーバーの状態。
ServerVersion	サーバーのバージョン。
Sku	サーバーの課金情報関連のプロパティ。
SkuTier	特定の SKU のレベル (Basic など)。
SslEnforcementEnum	サーバーに接続するときに ssl 強制を有効にするか、有効にしないか。
StorageAutogrow	ストレージの自動拡張を有効にします。
StorageProfile	サーバーのストレージ プロファイルプロパティ

CloudError

Batch サービスからのエラー応答。

名前	型	説明
error	ErrorResponse	エラー応答 失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答 (これは、OData エラー応答形式にも従います)。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorResponse

エラー応答

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorResponse[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

GeoRedundantBackup

サーバー バックアップで geo 冗長を有効にするか、有効にしないか。

名前	型	説明
Disabled	string
Enabled	string

IdentityType

ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。

名前	型	説明
SystemAssigned	string

InfrastructureEncryption

データ保護を強化する新しい暗号化アルゴリズムを使用して、データの 2 番目の暗号化レイヤーを追加します。 値は省略可能ですが、渡される場合は 、'Disabled' または 'Enabled' である必要があります。

名前	型	説明
Disabled	string	保存データの追加 (第 2) 層の暗号化
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 ID 構成。

名前	型	説明
principalId	string	Azure Active Directory プリンシパル ID。
tenantId	string	Azure Active Directory テナント ID。
type	IdentityType	ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。

Server

サーバーを表します。

名前	型	説明
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	レプリカ サーバーのマスター サーバー 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"

ServerListResult

サーバーの一覧。

名前	型	説明
value	Server[]	サーバーの一覧

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 のレベル (Basic など)。

SkuTier

特定の SKU のレベル (Basic など)。

名前	型	説明
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

サーバーに接続するときに ssl 強制を有効にするか、有効にしないか。

名前	型	説明
Disabled	string
Enabled	string

StorageAutogrow

ストレージの自動拡張を有効にします。

名前	型	説明
Disabled	string
Enabled	string

StorageProfile

サーバーのストレージ プロファイルプロパティ

名前	型	説明
backupRetentionDays	integer	サーバーのバックアップ保有日数。
geoRedundantBackup	GeoRedundantBackup	サーバー バックアップで geo 冗長を有効にするか、有効にしないか。
storageAutogrow	StorageAutogrow	ストレージの自動拡張を有効にします。
storageMB	integer	サーバーに対して許可される最大ストレージ数。