Replicas - List By Server

サービス:

PostgreSQL

API バージョン:

2024-11-01-preview

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/replicas?api-version=2024-11-01-preview

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソース グループの名前。 名前では大文字と小文字が区別されません。
serverName	path	True	string	サーバーの名前。 正規表現パターン: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*
subscriptionId	path	True	string uuid	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	ServerListResult	わかりました
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

ReplicasListByServer

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername/replicas?api-version=2024-11-01-preview

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# 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="testrg",
        server_name="sourcepgservername",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/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

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "sku": {
        "name": "Standard_D4s_v3",
        "tier": "GeneralPurpose"
      },
      "properties": {
        "fullyQualifiedDomainName": "pgtestsvc5rep.postgres.database.azure.com",
        "version": "12",
        "minorVersion": "6",
        "administratorLogin": "cloudsa",
        "state": "Ready",
        "availabilityZone": "2",
        "storage": {
          "storageSizeGB": 512,
          "autoGrow": "Disabled",
          "tier": "P20",
          "iops": 2300
        },
        "dataEncryption": {
          "type": "SystemManaged"
        },
        "authConfig": {
          "activeDirectoryAuth": "Disabled",
          "passwordAuth": "Enabled"
        },
        "backup": {
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled",
          "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00"
        },
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        },
        "maintenanceWindow": {
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "replicationRole": "AsyncReplica",
        "replicaCapacity": 0,
        "replica": {
          "role": "AsyncReplica",
          "capacity": 0,
          "replicationState": "Active"
        }
      },
      "location": "westus",
      "tags": {
        "ElasticServer": "1"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep",
      "name": "pgtestsvc5rep",
      "type": "Microsoft.DBforPostgreSQL/flexibleServers"
    }
  ]
}

定義

名前	説明
activeDirectoryAuthEnum	[有効] の場合、Azure Active Directory 認証が有効になります。
ArmServerKeyType	システムマネージドと Azure Key Vault のどちらであるか示すデータ暗号化の種類。
AuthConfig	サーバーの認証構成プロパティ
AzureManagedDiskPerformanceTiers	IOPS のストレージ層の名前。
Backup	サーバーのバックアップ プロパティ
Cluster	サーバーのクラスター プロパティ。
createdByType	リソースを作成した ID の種類。
CreateMode	新しい PostgreSQL サーバーを作成するモード。
DataEncryption	サーバーのデータ暗号化プロパティ
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GeoRedundantBackupEnum	Geo-Redundant バックアップがサーバーで有効になっているかどうかを示す値。
HighAvailability	サーバーの高可用性プロパティ
HighAvailabilityMode	サーバーの HA モード。
IdentityType	このリソースに関連付けられている ID の種類
keyStatusEnum	データ暗号化が有効なサーバーのプライマリ暗号化キーの状態。
MaintenanceWindow	サーバーのメンテナンス期間のプロパティ。
Network	サーバーのネットワーク プロパティ。
passwordAuthEnum	[有効] の場合、パスワード認証が有効になります。
PrivateEndpoint	プライベート エンドポイント リソース。
PrivateEndpointConnection	プライベート エンドポイント接続リソース。
PrivateEndpointConnectionProvisioningState	現在のプロビジョニング状態。
PrivateEndpointServiceConnectionStatus	プライベート エンドポイント接続の状態。
PrivateLinkServiceConnectionState	サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
ReadReplicaPromoteMode	レプリカ サーバーの昇格モードを設定します。 これは書き込み専用プロパティです。
Replica	サーバーのレプリカ プロパティ
ReplicationPromoteOption	レプリカ サーバーの昇格オプションを設定します。 これは書き込み専用プロパティです。
ReplicationRole	レプリケーション セット内のサーバーの役割を示すために使用されます。
ReplicationState	レプリカ サーバーのレプリケーション状態を取得します。 このプロパティは、レプリカ API 呼び出しの場合にのみ返されます。 サポートされている値は、アクティブ、キャッチアップ、プロビジョニング、更新、破損、再構成です
Server	サーバーを表します。
ServerHAState	ユーザーに表示される HA サーバーの状態。
ServerListResult	サーバーの一覧。
ServerPublicNetworkAccessState	パブリック ネットワーク アクセスが有効かどうか
ServerState	ユーザーに表示されるサーバーの状態。
ServerVersion	サーバーのバージョン。
Sku	サーバーの SKU 情報関連のプロパティ。
SkuTier	特定の SKU のレベル (バースト可能など)。
Storage	サーバーのストレージ プロパティ
StorageAutoGrow	フレキシブル サーバーのストレージ自動拡張を有効または無効にするフラグ。
StorageType	サーバーのストレージの種類。 使用できる値は、Premium_LRS、PremiumV2_LRS、およびUltraSSD_LRSです。 既定値はPremium_LRS (指定されていない場合)
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserAssignedIdentity	このアプリケーションに関連付けられている ID を記述する情報。
UserIdentity	アプリケーションに関連付けられている 1 つのユーザー割り当て ID について説明します。

activeDirectoryAuthEnum

列挙

[有効] の場合、Azure Active Directory 認証が有効になります。

値	説明
Disabled
Enabled

ArmServerKeyType

列挙

システムマネージドと Azure Key Vault のどちらであるか示すデータ暗号化の種類。

値	説明
AzureKeyVault
SystemManaged

AuthConfig

Object

サーバーの認証構成プロパティ

名前	型	規定値	説明
activeDirectoryAuth	activeDirectoryAuthEnum		[有効] の場合、Azure Active Directory 認証が有効になります。
passwordAuth	passwordAuthEnum	Enabled	[有効] の場合、パスワード認証が有効になります。
tenantId	string		サーバーのテナント ID。

AzureManagedDiskPerformanceTiers

列挙

IOPS のストレージ層の名前。

値	説明
P1
P10
P15
P2
P20
P3
P30
P4
P40
P50
P6
P60
P70
P80

Backup

Object

サーバーのバックアップ プロパティ

名前	型	規定値	説明
backupRetentionDays	integer	7	サーバーのバックアップ保有日数。
earliestRestoreDate	string		サーバーの最も古い復元ポイント時間 (ISO8601形式)。
geoRedundantBackup	GeoRedundantBackupEnum	Disabled	Geo-Redundant バックアップがサーバーで有効になっているかどうかを示す値。

Cluster

Object

サーバーのクラスター プロパティ。

名前	型	規定値	説明
clusterSize	integer	0	クラスターのノード数。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

CreateMode

列挙

新しい PostgreSQL サーバーを作成するモード。

値	説明
Create
Default
GeoRestore
PointInTimeRestore
Replica
ReviveDropped
Update

DataEncryption

Object

サーバーのデータ暗号化プロパティ

名前	型	説明
geoBackupEncryptionKeyStatus	keyStatusEnum	データ暗号化が有効なサーバーの geo バックアップ暗号化キーの状態。
geoBackupKeyURI	string	サーバーの geo バックアップ用のデータ暗号化の keyvault 内のキーの URI。
geoBackupUserAssignedIdentityId	string	サーバーの geo バックアップのデータ暗号化に使用するユーザー割り当て ID のリソース ID。
primaryEncryptionKeyStatus	keyStatusEnum	データ暗号化が有効なサーバーのプライマリ暗号化キーの状態。
primaryKeyURI	string	プライマリ サーバーのデータ暗号化のための keyvault 内のキーの URI。
primaryUserAssignedIdentityId	string	プライマリ サーバーのデータ暗号化に使用するユーザー割り当て ID のリソース ID。
type	ArmServerKeyType	システムマネージドと Azure Key Vault のどちらであるか示すデータ暗号化の種類。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

GeoRedundantBackupEnum

列挙

Geo-Redundant バックアップがサーバーで有効になっているかどうかを示す値。

値	説明
Disabled
Enabled

HighAvailability

Object

サーバーの高可用性プロパティ

名前	型	規定値	説明
mode	HighAvailabilityMode	Disabled	サーバーの HA モード。
standbyAvailabilityZone	string		スタンバイの可用性ゾーン情報。
state	ServerHAState		ユーザーに表示される HA サーバーの状態。

HighAvailabilityMode

列挙

サーバーの HA モード。

値	説明
Disabled
SameZone
ZoneRedundant

IdentityType

列挙

このリソースに関連付けられている ID の種類

値	説明
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

keyStatusEnum

列挙

データ暗号化が有効なサーバーのプライマリ暗号化キーの状態。

値	説明
Invalid
Valid

MaintenanceWindow

Object

サーバーのメンテナンス期間のプロパティ。

名前	型	規定値	説明
customWindow	string	Disabled	は、カスタム ウィンドウが有効か無効かを示します
dayOfWeek	integer	0	メンテナンス期間の曜日
startHour	integer	0	メンテナンス期間の開始時刻
startMinute	integer	0	メンテナンス期間の開始時間 (分)

Network

Object

サーバーのネットワーク プロパティ。

名前	型	説明
delegatedSubnetResourceId	string	委任されたサブネット arm リソース ID。これは、サーバーを VNET に挿入する場合 (プライベート アクセス サーバーなど) の作成時に渡す必要があります。 更新中に、プライベート DNS ゾーンの値を更新する場合にのみ、これを渡します。
privateDnsZoneArmResourceId	string	プライベート DNS ゾーンの arm リソース ID。これは、サーバーを VNET に挿入する場合 (プライベート アクセス サーバーなど) の作成時に渡す必要があります。 更新中に、プライベート DNS ゾーンの値を更新する場合にのみ、これを渡します。
publicNetworkAccess	ServerPublicNetworkAccessState	パブリック ネットワーク アクセスが有効かどうか

passwordAuthEnum

列挙

[有効] の場合、パスワード認証が有効になります。

値	説明
Disabled
Enabled

PrivateEndpoint

Object

プライベート エンドポイント リソース。

名前	型	説明
id	string	プライベート エンドポイントの ARM 識別子。

PrivateEndpointConnection

Object

プライベート エンドポイント接続リソース。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.groupIds	string[]	プライベート エンドポイント リソースのグループ ID。
properties.privateEndpoint	PrivateEndpoint	プライベート エンドポイント リソース。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	プライベート エンドポイント接続リソースのプロビジョニング状態。
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

列挙

現在のプロビジョニング状態。

値	説明
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

列挙

プライベート エンドポイント接続の状態。

値	説明
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。

名前	型	説明
actionsRequired	string	サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。
description	string	接続の承認/拒否の理由。
status	PrivateEndpointServiceConnectionStatus	接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。

ReadReplicaPromoteMode

列挙

レプリカ サーバーの昇格モードを設定します。 これは書き込み専用プロパティです。

値	説明
standalone
switchover

Replica

Object

サーバーのレプリカ プロパティ

名前	型	説明
capacity	integer	サーバーに対して許可されるレプリカ。
promoteMode	ReadReplicaPromoteMode	レプリカ サーバーの昇格モードを設定します。 これは書き込み専用プロパティです。
promoteOption	ReplicationPromoteOption	レプリカ サーバーの昇格オプションを設定します。 これは書き込み専用プロパティです。
replicationState	ReplicationState	レプリカ サーバーのレプリケーション状態を取得します。 このプロパティは、レプリカ API 呼び出しの場合にのみ返されます。 サポートされている値は、アクティブ、キャッチアップ、プロビジョニング、更新、破損、再構成です
role	ReplicationRole	レプリケーション セット内のサーバーの役割を示すために使用されます。

ReplicationPromoteOption

列挙

レプリカ サーバーの昇格オプションを設定します。 これは書き込み専用プロパティです。

値	説明
forced
planned

ReplicationRole

列挙

レプリケーション セット内のサーバーの役割を示すために使用されます。

値	説明
AsyncReplica
GeoAsyncReplica
None
Primary

ReplicationState

列挙

レプリカ サーバーのレプリケーション状態を取得します。 このプロパティは、レプリカ API 呼び出しの場合にのみ返されます。 サポートされている値は、アクティブ、キャッチアップ、プロビジョニング、更新、破損、再構成です

値	説明
Active
Broken
Catchup
Provisioning
Reconfiguring
Updating

Server

Object

サーバーを表します。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	UserAssignedIdentity	アプリケーションの ID について説明します。
location	string	リソースが存在する地理的な場所
name	string	リソースの名前
properties.administratorLogin	string	サーバーの管理者のログイン名。 サーバーの作成時にのみ指定できます (作成に必要です)。
properties.administratorLoginPassword	string	管理者ログイン パスワード (サーバーの作成に必要)。
properties.authConfig	AuthConfig	サーバーの AuthConfig プロパティ。
properties.availabilityZone	string	サーバーの可用性ゾーン情報。
properties.backup	Backup	サーバーのバックアップ プロパティ。
properties.cluster	Cluster	サーバーのクラスター プロパティ。
properties.createMode	CreateMode	新しい PostgreSQL サーバーを作成するモード。
properties.dataEncryption	DataEncryption	サーバーのデータ暗号化プロパティ。
properties.fullyQualifiedDomainName	string	サーバーの完全修飾ドメイン名。
properties.highAvailability	HighAvailability	サーバーの高可用性プロパティ。
properties.maintenanceWindow	MaintenanceWindow	サーバーのメンテナンス期間のプロパティ。
properties.minorVersion	string	サーバーのマイナー バージョン。
properties.network	Network	サーバーのネットワーク プロパティ。 このネットワーク プロパティは、サーバーをプライベート アクセス サーバーにする場合にのみ渡す必要があります。
properties.pointInTimeUTC	string	復元ポイントの作成時刻 (ISO8601形式)。復元元の時刻を指定します。 'createMode' が 'PointInTimeRestore' または 'GeoRestore' または 'ReviveDropped' の場合は必須です。
properties.privateEndpointConnections	PrivateEndpointConnection[]	指定したリソースに関連付けられているプライベート エンドポイント接続の一覧。
properties.replica	Replica	サーバーのレプリカ プロパティ。 これらのレプリカプロパティは、サーバーを昇格させる場合にのみ渡す必要があります。
properties.replicaCapacity	integer	サーバーに対して許可されるレプリカ。
properties.replicationRole	ReplicationRole	サーバーのレプリケーション ロール
properties.sourceServerResourceId	string	復元元のソース サーバー リソース ID。 'createMode' が 'PointInTimeRestore' または 'GeoRestore' または 'Replica' または 'ReviveDropped' の場合は必須です。 このプロパティは、レプリカ サーバーに対してのみ返されます
properties.state	ServerState	ユーザーに表示されるサーバーの状態。
properties.storage	Storage	サーバーのストレージ プロパティ。
properties.version	ServerVersion	PostgreSQL サーバーのバージョン。
sku	Sku	サーバーの SKU (価格レベル)。
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソース タグ。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ServerHAState

列挙

ユーザーに表示される HA サーバーの状態。

値	説明
CreatingStandby
FailingOver
Healthy
NotEnabled
RemovingStandby
ReplicatingData

ServerListResult

Object

サーバーの一覧。

名前	型	説明
nextLink	string	操作の次のページを取得するために使用されるリンク。
value	Server[]	フレキシブル サーバーの一覧

ServerPublicNetworkAccessState

列挙

パブリック ネットワーク アクセスが有効かどうか

値	説明
Disabled
Enabled

ServerState

列挙

ユーザーに表示されるサーバーの状態。

値	説明
Disabled
Dropping
Ready
Starting
Stopped
Stopping
Updating

ServerVersion

列挙

サーバーのバージョン。

値	説明
11
12
13
14
15
16
17

Sku

Object

サーバーの SKU 情報関連のプロパティ。

名前	型	説明
name	string	sku の名前 。通常は、階層 + ファミリ + コア (例: Standard_D4s_v3)。
tier	SkuTier	特定の SKU のレベル (バースト可能など)。

SkuTier

列挙

特定の SKU のレベル (バースト可能など)。

値	説明
Burstable
GeneralPurpose
MemoryOptimized

Storage

Object

サーバーのストレージ プロパティ

名前	型	説明
autoGrow	StorageAutoGrow	フレキシブル サーバーのストレージ自動拡張を有効または無効にするフラグ。
iops	integer	ストレージ層の IOPS 量。 このプロパティは、ストレージの種類のPremiumV2_LRSとUltraSSD_LRSに設定する必要があります。
storageSizeGB	integer	サーバーに対して許可される最大ストレージ数。
throughput	integer	サーバーのストレージ スループット。 これは、ストレージの種類のPremiumV2_LRSとUltraSSD_LRSに設定する必要があります。
tier	AzureManagedDiskPerformanceTiers	IOPS のストレージ層の名前。
type	StorageType	サーバーのストレージの種類。 使用できる値は、Premium_LRS、PremiumV2_LRS、およびUltraSSD_LRSです。 既定値はPremium_LRS (指定されていない場合)

StorageAutoGrow

列挙

フレキシブル サーバーのストレージ自動拡張を有効または無効にするフラグ。

値	説明
Disabled
Enabled

StorageType

列挙

サーバーのストレージの種類。 使用できる値は、Premium_LRS、PremiumV2_LRS、およびUltraSSD_LRSです。 既定値はPremium_LRS (指定されていない場合)

値	説明
PremiumV2_LRS
Premium_LRS
UltraSSD_LRS

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UserAssignedIdentity

Object

このアプリケーションに関連付けられている ID を記述する情報。

名前	型	説明
principalId	string	サーバーの ID プリンシパル ID。
tenantId	string	サーバーのテナント ID。
type	IdentityType	このリソースに関連付けられている ID の種類
userAssignedIdentities	<string,  UserIdentity>	は、ユーザー割り当て ID マップを表します。

UserIdentity

Object

アプリケーションに関連付けられている 1 つのユーザー割り当て ID について説明します。

名前	型	説明
clientId	string	この ID が表すサービス プリンシパルのクライアント識別子。
principalId	string	この ID が表すサービス プリンシパルのオブジェクト識別子。