Replicas - List By Server
特定のサーバーのすべてのレプリカを一覧表示します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/replicas?api-version=2024-11-01-preview
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string |
リソース グループの名前。 名前では大文字と小文字が区別されません。 |
server
|
path | True |
string |
サーバーの名前。 正規表現パターン: |
subscription
|
path | True |
string uuid |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
わかりました |
|
Other Status Codes |
操作が失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントを偽装する |
例
ReplicasListByServer
要求のサンプル
応答のサンプル
{
"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"
}
]
}
定義
名前 | 説明 |
---|---|
active |
[有効] の場合、Azure Active Directory 認証が有効になります。 |
Arm |
システムマネージドと Azure Key Vault のどちらであるか示すデータ暗号化の種類。 |
Auth |
サーバーの認証構成プロパティ |
Azure |
IOPS のストレージ層の名前。 |
Backup |
サーバーのバックアップ プロパティ |
Cluster |
サーバーのクラスター プロパティ。 |
created |
リソースを作成した ID の種類。 |
Create |
新しい PostgreSQL サーバーを作成するモード。 |
Data |
サーバーのデータ暗号化プロパティ |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Geo |
Geo-Redundant バックアップがサーバーで有効になっているかどうかを示す値。 |
High |
サーバーの高可用性プロパティ |
High |
サーバーの HA モード。 |
Identity |
このリソースに関連付けられている ID の種類 |
key |
データ暗号化が有効なサーバーのプライマリ暗号化キーの状態。 |
Maintenance |
サーバーのメンテナンス期間のプロパティ。 |
Network |
サーバーのネットワーク プロパティ。 |
password |
[有効] の場合、パスワード認証が有効になります。 |
Private |
プライベート エンドポイント リソース。 |
Private |
プライベート エンドポイント接続リソース。 |
Private |
現在のプロビジョニング状態。 |
Private |
プライベート エンドポイント接続の状態。 |
Private |
サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 |
Read |
レプリカ サーバーの昇格モードを設定します。 これは書き込み専用プロパティです。 |
Replica |
サーバーのレプリカ プロパティ |
Replication |
レプリカ サーバーの昇格オプションを設定します。 これは書き込み専用プロパティです。 |
Replication |
レプリケーション セット内のサーバーの役割を示すために使用されます。 |
Replication |
レプリカ サーバーのレプリケーション状態を取得します。 このプロパティは、レプリカ API 呼び出しの場合にのみ返されます。 サポートされている値は、アクティブ、キャッチアップ、プロビジョニング、更新、破損、再構成です |
Server |
サーバーを表します。 |
Server |
ユーザーに表示される HA サーバーの状態。 |
Server |
サーバーの一覧。 |
Server |
パブリック ネットワーク アクセスが有効かどうか |
Server |
ユーザーに表示されるサーバーの状態。 |
Server |
サーバーのバージョン。 |
Sku |
サーバーの SKU 情報関連のプロパティ。 |
Sku |
特定の SKU のレベル (バースト可能など)。 |
Storage |
サーバーのストレージ プロパティ |
Storage |
フレキシブル サーバーのストレージ自動拡張を有効または無効にするフラグ。 |
Storage |
サーバーのストレージの種類。 使用できる値は、Premium_LRS、PremiumV2_LRS、およびUltraSSD_LRSです。 既定値はPremium_LRS (指定されていない場合) |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
User |
このアプリケーションに関連付けられている ID を記述する情報。 |
User |
アプリケーションに関連付けられている 1 つのユーザー割り当て ID について説明します。 |
activeDirectoryAuthEnum
[有効] の場合、Azure Active Directory 認証が有効になります。
値 | 説明 |
---|---|
Disabled | |
Enabled |
ArmServerKeyType
システムマネージドと Azure Key Vault のどちらであるか示すデータ暗号化の種類。
値 | 説明 |
---|---|
AzureKeyVault | |
SystemManaged |
AuthConfig
サーバーの認証構成プロパティ
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
activeDirectoryAuth |
[有効] の場合、Azure Active Directory 認証が有効になります。 |
||
passwordAuth | Enabled |
[有効] の場合、パスワード認証が有効になります。 |
|
tenantId |
string |
サーバーのテナント ID。 |
AzureManagedDiskPerformanceTiers
IOPS のストレージ層の名前。
値 | 説明 |
---|---|
P1 | |
P10 | |
P15 | |
P2 | |
P20 | |
P3 | |
P30 | |
P4 | |
P40 | |
P50 | |
P6 | |
P60 | |
P70 | |
P80 |
Backup
サーバーのバックアップ プロパティ
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
backupRetentionDays |
integer |
7 |
サーバーのバックアップ保有日数。 |
earliestRestoreDate |
string |
サーバーの最も古い復元ポイント時間 (ISO8601形式)。 |
|
geoRedundantBackup | Disabled |
Geo-Redundant バックアップがサーバーで有効になっているかどうかを示す値。 |
Cluster
サーバーのクラスター プロパティ。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
clusterSize |
integer |
0 |
クラスターのノード数。 |
createdByType
リソースを作成した ID の種類。
値 | 説明 |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
CreateMode
新しい PostgreSQL サーバーを作成するモード。
値 | 説明 |
---|---|
Create | |
Default | |
GeoRestore | |
PointInTimeRestore | |
Replica | |
ReviveDropped | |
Update |
DataEncryption
サーバーのデータ暗号化プロパティ
名前 | 型 | 説明 |
---|---|---|
geoBackupEncryptionKeyStatus |
データ暗号化が有効なサーバーの geo バックアップ暗号化キーの状態。 |
|
geoBackupKeyURI |
string |
サーバーの geo バックアップ用のデータ暗号化の keyvault 内のキーの URI。 |
geoBackupUserAssignedIdentityId |
string |
サーバーの geo バックアップのデータ暗号化に使用するユーザー割り当て ID のリソース ID。 |
primaryEncryptionKeyStatus |
データ暗号化が有効なサーバーのプライマリ暗号化キーの状態。 |
|
primaryKeyURI |
string |
プライマリ サーバーのデータ暗号化のための keyvault 内のキーの URI。 |
primaryUserAssignedIdentityId |
string |
プライマリ サーバーのデータ暗号化に使用するユーザー割り当て ID のリソース ID。 |
type |
システムマネージドと Azure Key Vault のどちらであるか示すデータ暗号化の種類。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |
GeoRedundantBackupEnum
Geo-Redundant バックアップがサーバーで有効になっているかどうかを示す値。
値 | 説明 |
---|---|
Disabled | |
Enabled |
HighAvailability
サーバーの高可用性プロパティ
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
mode | Disabled |
サーバーの HA モード。 |
|
standbyAvailabilityZone |
string |
スタンバイの可用性ゾーン情報。 |
|
state |
ユーザーに表示される HA サーバーの状態。 |
HighAvailabilityMode
サーバーの HA モード。
値 | 説明 |
---|---|
Disabled | |
SameZone | |
ZoneRedundant |
IdentityType
このリソースに関連付けられている ID の種類
値 | 説明 |
---|---|
None | |
SystemAssigned | |
SystemAssigned,UserAssigned | |
UserAssigned |
keyStatusEnum
データ暗号化が有効なサーバーのプライマリ暗号化キーの状態。
値 | 説明 |
---|---|
Invalid | |
Valid |
MaintenanceWindow
サーバーのメンテナンス期間のプロパティ。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
customWindow |
string |
Disabled |
は、カスタム ウィンドウが有効か無効かを示します |
dayOfWeek |
integer |
0 |
メンテナンス期間の曜日 |
startHour |
integer |
0 |
メンテナンス期間の開始時刻 |
startMinute |
integer |
0 |
メンテナンス期間の開始時間 (分) |
Network
サーバーのネットワーク プロパティ。
名前 | 型 | 説明 |
---|---|---|
delegatedSubnetResourceId |
string |
委任されたサブネット arm リソース ID。これは、サーバーを VNET に挿入する場合 (プライベート アクセス サーバーなど) の作成時に渡す必要があります。 更新中に、プライベート DNS ゾーンの値を更新する場合にのみ、これを渡します。 |
privateDnsZoneArmResourceId |
string |
プライベート DNS ゾーンの arm リソース ID。これは、サーバーを VNET に挿入する場合 (プライベート アクセス サーバーなど) の作成時に渡す必要があります。 更新中に、プライベート DNS ゾーンの値を更新する場合にのみ、これを渡します。 |
publicNetworkAccess |
パブリック ネットワーク アクセスが有効かどうか |
passwordAuthEnum
[有効] の場合、パスワード認証が有効になります。
値 | 説明 |
---|---|
Disabled | |
Enabled |
PrivateEndpoint
プライベート エンドポイント リソース。
名前 | 型 | 説明 |
---|---|---|
id |
string |
プライベート エンドポイントの ARM 識別子。 |
PrivateEndpointConnection
プライベート エンドポイント接続リソース。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
リソースの名前 |
properties.groupIds |
string[] |
プライベート エンドポイント リソースのグループ ID。 |
properties.privateEndpoint |
プライベート エンドポイント リソース。 |
|
properties.privateLinkServiceConnectionState |
サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 |
|
properties.provisioningState |
プライベート エンドポイント接続リソースのプロビジョニング状態。 |
|
systemData |
createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
|
type |
string |
リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProvisioningState
現在のプロビジョニング状態。
値 | 説明 |
---|---|
Creating | |
Deleting | |
Failed | |
Succeeded |
PrivateEndpointServiceConnectionStatus
プライベート エンドポイント接続の状態。
値 | 説明 |
---|---|
Approved | |
Pending | |
Rejected |
PrivateLinkServiceConnectionState
サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
名前 | 型 | 説明 |
---|---|---|
actionsRequired |
string |
サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。 |
description |
string |
接続の承認/拒否の理由。 |
status |
接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。 |
ReadReplicaPromoteMode
レプリカ サーバーの昇格モードを設定します。 これは書き込み専用プロパティです。
値 | 説明 |
---|---|
standalone | |
switchover |
Replica
サーバーのレプリカ プロパティ
名前 | 型 | 説明 |
---|---|---|
capacity |
integer |
サーバーに対して許可されるレプリカ。 |
promoteMode |
レプリカ サーバーの昇格モードを設定します。 これは書き込み専用プロパティです。 |
|
promoteOption |
レプリカ サーバーの昇格オプションを設定します。 これは書き込み専用プロパティです。 |
|
replicationState |
レプリカ サーバーのレプリケーション状態を取得します。 このプロパティは、レプリカ API 呼び出しの場合にのみ返されます。 サポートされている値は、アクティブ、キャッチアップ、プロビジョニング、更新、破損、再構成です |
|
role |
レプリケーション セット内のサーバーの役割を示すために使用されます。 |
ReplicationPromoteOption
レプリカ サーバーの昇格オプションを設定します。 これは書き込み専用プロパティです。
値 | 説明 |
---|---|
forced | |
planned |
ReplicationRole
レプリケーション セット内のサーバーの役割を示すために使用されます。
値 | 説明 |
---|---|
AsyncReplica | |
GeoAsyncReplica | |
None | |
Primary |
ReplicationState
レプリカ サーバーのレプリケーション状態を取得します。 このプロパティは、レプリカ API 呼び出しの場合にのみ返されます。 サポートされている値は、アクティブ、キャッチアップ、プロビジョニング、更新、破損、再構成です
値 | 説明 |
---|---|
Active | |
Broken | |
Catchup | |
Provisioning | |
Reconfiguring | |
Updating |
Server
サーバーを表します。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
identity |
アプリケーションの ID について説明します。 |
|
location |
string |
リソースが存在する地理的な場所 |
name |
string |
リソースの名前 |
properties.administratorLogin |
string |
サーバーの管理者のログイン名。 サーバーの作成時にのみ指定できます (作成に必要です)。 |
properties.administratorLoginPassword |
string |
管理者ログイン パスワード (サーバーの作成に必要)。 |
properties.authConfig |
サーバーの AuthConfig プロパティ。 |
|
properties.availabilityZone |
string |
サーバーの可用性ゾーン情報。 |
properties.backup |
サーバーのバックアップ プロパティ。 |
|
properties.cluster |
サーバーのクラスター プロパティ。 |
|
properties.createMode |
新しい PostgreSQL サーバーを作成するモード。 |
|
properties.dataEncryption |
サーバーのデータ暗号化プロパティ。 |
|
properties.fullyQualifiedDomainName |
string |
サーバーの完全修飾ドメイン名。 |
properties.highAvailability |
サーバーの高可用性プロパティ。 |
|
properties.maintenanceWindow |
サーバーのメンテナンス期間のプロパティ。 |
|
properties.minorVersion |
string |
サーバーのマイナー バージョン。 |
properties.network |
サーバーのネットワーク プロパティ。 このネットワーク プロパティは、サーバーをプライベート アクセス サーバーにする場合にのみ渡す必要があります。 |
|
properties.pointInTimeUTC |
string |
復元ポイントの作成時刻 (ISO8601形式)。復元元の時刻を指定します。 'createMode' が 'PointInTimeRestore' または 'GeoRestore' または 'ReviveDropped' の場合は必須です。 |
properties.privateEndpointConnections |
指定したリソースに関連付けられているプライベート エンドポイント接続の一覧。 |
|
properties.replica |
サーバーのレプリカ プロパティ。 これらのレプリカプロパティは、サーバーを昇格させる場合にのみ渡す必要があります。 |
|
properties.replicaCapacity |
integer |
サーバーに対して許可されるレプリカ。 |
properties.replicationRole |
サーバーのレプリケーション ロール |
|
properties.sourceServerResourceId |
string |
復元元のソース サーバー リソース ID。 'createMode' が 'PointInTimeRestore' または 'GeoRestore' または 'Replica' または 'ReviveDropped' の場合は必須です。 このプロパティは、レプリカ サーバーに対してのみ返されます |
properties.state |
ユーザーに表示されるサーバーの状態。 |
|
properties.storage |
サーバーのストレージ プロパティ。 |
|
properties.version |
PostgreSQL サーバーのバージョン。 |
|
sku |
サーバーの SKU (価格レベル)。 |
|
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
サーバーの一覧。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string |
操作の次のページを取得するために使用されるリンク。 |
value |
Server[] |
フレキシブル サーバーの一覧 |
ServerPublicNetworkAccessState
パブリック ネットワーク アクセスが有効かどうか
値 | 説明 |
---|---|
Disabled | |
Enabled |
ServerState
ユーザーに表示されるサーバーの状態。
値 | 説明 |
---|---|
Disabled | |
Dropping | |
Ready | |
Starting | |
Stopped | |
Stopping | |
Updating |
ServerVersion
サーバーのバージョン。
値 | 説明 |
---|---|
11 | |
12 | |
13 | |
14 | |
15 | |
16 | |
17 |
Sku
サーバーの SKU 情報関連のプロパティ。
名前 | 型 | 説明 |
---|---|---|
name |
string |
sku の名前 。通常は、階層 + ファミリ + コア (例: Standard_D4s_v3)。 |
tier |
特定の SKU のレベル (バースト可能など)。 |
SkuTier
特定の SKU のレベル (バースト可能など)。
値 | 説明 |
---|---|
Burstable | |
GeneralPurpose | |
MemoryOptimized |
Storage
サーバーのストレージ プロパティ
名前 | 型 | 説明 |
---|---|---|
autoGrow |
フレキシブル サーバーのストレージ自動拡張を有効または無効にするフラグ。 |
|
iops |
integer |
ストレージ層の IOPS 量。 このプロパティは、ストレージの種類のPremiumV2_LRSとUltraSSD_LRSに設定する必要があります。 |
storageSizeGB |
integer |
サーバーに対して許可される最大ストレージ数。 |
throughput |
integer |
サーバーのストレージ スループット。 これは、ストレージの種類のPremiumV2_LRSとUltraSSD_LRSに設定する必要があります。 |
tier |
IOPS のストレージ層の名前。 |
|
type |
サーバーのストレージの種類。 使用できる値は、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
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |
UserAssignedIdentity
このアプリケーションに関連付けられている ID を記述する情報。
名前 | 型 | 説明 |
---|---|---|
principalId |
string |
サーバーの ID プリンシパル ID。 |
tenantId |
string |
サーバーのテナント ID。 |
type |
このリソースに関連付けられている ID の種類 |
|
userAssignedIdentities |
<string,
User |
は、ユーザー割り当て ID マップを表します。 |
UserIdentity
アプリケーションに関連付けられている 1 つのユーザー割り当て ID について説明します。
名前 | 型 | 説明 |
---|---|---|
clientId |
string |
この ID が表すサービス プリンシパルのクライアント識別子。 |
principalId |
string |
この ID が表すサービス プリンシパルのオブジェクト識別子。 |