Servers - Update
既存のサーバーを更新します。 要求本文には、通常のサーバー定義に存在する 1 つまたは複数のプロパティを含めることができます。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}?api-version=2025-08-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
リソース グループの名前。 名前は大文字と小文字が区別されます。 |
|
server
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)* |
サーバーの名前。 |
|
subscription
|
path | True |
string (uuid) |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| identity |
アプリケーションの ID について説明します。 |
|
| properties.administratorLoginPassword |
string (password) |
管理者ログインに割り当てられたパスワード。 パスワード認証が有効になっている限り、このパスワードはいつでも変更できます。 |
| properties.authConfig |
サーバーの認証構成プロパティ。 |
|
| properties.availabilityZone |
string |
サーバーの可用性ゾーン。 |
| properties.backup |
サーバーのバックアップ プロパティ。 |
|
| properties.cluster |
サーバーのクラスター プロパティ。 |
|
| properties.createMode |
既存のサーバーの更新モード。 |
|
| properties.dataEncryption |
サーバーのデータ暗号化プロパティ。 |
|
| properties.highAvailability |
サーバーの高可用性プロパティ。 |
|
| properties.maintenanceWindow |
サーバーのメンテナンス期間のプロパティ。 |
|
| properties.network |
サーバーのネットワーク プロパティ。 お客様が提供する仮想ネットワークにサーバーを統合する場合にのみ必要です。 |
|
| properties.replica |
サーバーのリードレプリカプロパティ。 サーバーを昇格する場合にのみ必要です。 |
|
| properties.replicationRole |
レプリケーション・セット内のサーバーの役割。 |
|
| properties.storage |
サーバーのストレージ プロパティ。 |
|
| properties.version |
PostgreSQL データベースエンジンのメジャーバージョン。 |
|
| sku |
サーバーのコンピューティング層とサイズ。 |
|
| tags |
object |
キーと値のペアの形式による、アプリケーション固有のメタデータ。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 202 Accepted |
リソース操作が受け入れられます。 ヘッダー
|
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザーアカウントになりすます |
例
Promote a read replica to a standalone server with forced data synchronization. Meaning that it doesn't wait for data in the read replica to be synchronized with its source server before it initiates the promotion to a standalone server.
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01
{
"properties": {
"replica": {
"promoteMode": "Standalone",
"promoteOption": "Forced"
}
}
}
応答のサンプル
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview
Promote a read replica to a standalone server with planned data synchronization. Meaning that it waits for data in the read replica to be fully synchronized with its source server before it initiates the promotion to a standalone server.
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01
{
"properties": {
"replica": {
"promoteMode": "Standalone",
"promoteOption": "Planned"
}
}
}
応答のサンプル
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview
Switch over a read replica to primary server with forced data synchronization. Meaning that it doesn't wait for data in the read replica to be synchronized with its source server before it initiates the switching of roles between the read replica and the primary server.
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01
{
"properties": {
"replica": {
"promoteMode": "Switchover",
"promoteOption": "Forced"
}
}
}
応答のサンプル
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview
Switch over a read replica to primary server with planned data synchronization. Meaning that it waits for data in the read replica to be fully synchronized with its source server before it initiates the switching of roles between the read replica and the primary server.
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01
{
"properties": {
"replica": {
"promoteMode": "Switchover",
"promoteOption": "Planned"
}
}
}
応答のサンプル
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview
Update an existing server to upgrade the major version of PostgreSQL database engine.
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01
{
"properties": {
"createMode": "Update",
"version": "17"
}
}
応答のサンプル
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview
Update an existing server with custom maintenance window.
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01
{
"properties": {
"createMode": "Update",
"maintenanceWindow": {
"customWindow": "Enabled",
"dayOfWeek": 0,
"startHour": 8,
"startMinute": 0
}
}
}
応答のサンプル
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview
Update an existing server with data encryption based on customer managed key with automatic key version update.
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01
{
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplegeoredundantidentity": {},
"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleprimaryidentity": {}
}
},
"properties": {
"administratorLoginPassword": "examplenewpassword",
"backup": {
"backupRetentionDays": 20
},
"createMode": "Update",
"dataEncryption": {
"type": "AzureKeyVault",
"geoBackupKeyURI": "https://examplegeoredundantkeyvault.vault.azure.net/keys/examplekey",
"geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplegeoredundantidentity",
"primaryKeyURI": "https://exampleprimarykeyvault.vault.azure.net/keys/examplekey",
"primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleprimaryidentity"
}
},
"sku": {
"name": "Standard_D8s_v3",
"tier": "GeneralPurpose"
}
}
応答のサンプル
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview
Update an existing server with data encryption based on customer managed key.
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01
{
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplegeoredundantidentity": {},
"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleprimaryidentity": {}
}
},
"properties": {
"administratorLoginPassword": "examplenewpassword",
"backup": {
"backupRetentionDays": 20
},
"createMode": "Update",
"dataEncryption": {
"type": "AzureKeyVault",
"geoBackupKeyURI": "https://examplegeoredundantkeyvault.vault.azure.net/keys/examplekey/yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",
"geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplegeoredundantidentity",
"primaryKeyURI": "https://exampleprimarykeyvault.vault.azure.net/keys/examplekey/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleprimaryidentity"
}
},
"sku": {
"name": "Standard_D8s_v3",
"tier": "GeneralPurpose"
}
}
応答のサンプル
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview
Update an existing server with Microsoft Entra authentication enabled.
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01
{
"properties": {
"administratorLoginPassword": "examplenewpassword",
"authConfig": {
"activeDirectoryAuth": "Enabled",
"passwordAuth": "Enabled",
"tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt"
},
"backup": {
"backupRetentionDays": 20
},
"createMode": "Update",
"storage": {
"autoGrow": "Disabled",
"storageSizeGB": 1024,
"tier": "P30"
}
},
"sku": {
"name": "Standard_D8s_v3",
"tier": "GeneralPurpose"
}
}
応答のサンプル
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview
Update an existing server.
要求のサンプル
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01
{
"properties": {
"administratorLoginPassword": "examplenewpassword",
"backup": {
"backupRetentionDays": 20
},
"createMode": "Update",
"storage": {
"autoGrow": "Enabled",
"storageSizeGB": 1024,
"tier": "P30"
}
},
"sku": {
"name": "Standard_D8s_v3",
"tier": "GeneralPurpose"
}
}
応答のサンプル
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview
定義
| 名前 | 説明 |
|---|---|
|
Auth |
サーバーの認証構成プロパティ。 |
|
Azure |
サーバーのストレージ層。 |
|
Backup |
サーバーのバックアップ プロパティ。 |
| Cluster |
サーバーのクラスター プロパティ。 |
|
Create |
既存のサーバーの更新モード。 |
|
Data |
サーバーのデータ暗号化プロパティ。 |
|
Data |
サーバーで使用されるデータ暗号化タイプ。 |
|
Encryption |
サーバーに関連付けられているプライマリ ストレージを暗号化するために、カスタマー マネージド キーに基づくデータ暗号化で構成されたサーバーで使用されるキーの状態。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
|
Geographically |
サーバーが地理的に冗長なバックアップを作成するように構成されているかどうかを示します。 |
|
High |
サーバーの高可用性プロパティ。 |
|
High |
高可用性が SameZone または ZoneRedundant に設定されている場合に作成されるスタンバイ サーバーの状態。 |
|
Identity |
サーバーに関連付けられている ID のタイプ。 |
|
Maintenance |
サーバーのメンテナンス期間のプロパティ。 |
|
Microsoft |
サーバーが Microsoft Entra 認証をサポートしているかどうかを示します。 |
| Network |
サーバーのネットワーク プロパティ。 |
|
Password |
サーバーがパスワードベースの認証をサポートしているかどうかを示します。 |
|
Postgres |
PostgreSQL データベースエンジンのメジャーバージョン。 |
|
Postgre |
このコンピューティングでサポートされている高可用性のモード。 |
|
Read |
リードレプリカに適用する操作のタイプ。 このプロパティは書き込み専用です。 スタンドアロンとは、リードレプリカがスタンドアロンサーバーに昇格され、レプリケーションセットから完全に独立したエンティティになることを意味します。 スイッチオーバーとは、リードレプリカがプライマリサーバーとロールすることを意味します。 |
|
Read |
promoteMode プロパティで指定された操作を処理するときに使用するデータ同期オプション。 このプロパティは書き込み専用です。 |
| Replica |
サーバーのレプリカ プロパティ。 |
|
Replication |
レプリケーション・セット内のサーバーの役割。 |
|
Replication |
リードレプリカのレプリケーション状態を示します。 このプロパティは、ターゲット サーバーがリード レプリカである場合にのみ返されます。 可能な値は、Active、Broken、Catchup、Provisioning、Reconfiguring、および Updating です |
|
Server |
更新するサーバーを表します。 |
|
Server |
パブリックネットワークアクセスが有効になっているかどうかを示します。 |
|
Sku |
サーバーのコンピューティング情報。 |
|
Sku |
サーバーに割り当てられたコンピューティングの層。 |
| Storage |
サーバーのストレージ プロパティ。 |
|
Storage |
使用可能なスペースがゼロに近づき、ストレージサイズを自動的に増加させる条件がある場合に、サーバーのストレージサイズの自動増加を有効または無効にするフラグ。 |
|
Storage |
サーバーに割り当てられたストレージのタイプ。 使用できる値は、Premium_LRS、PremiumV2_LRS、または UltraSSD_LRS です。 指定しない場合、デフォルトは Premium_LRS です。 |
|
User |
サーバーに関連付けられた ID。 |
|
User |
サーバーに関連付けられているユーザー割り当てマネージド ID。 |
AuthConfigForPatch
サーバーの認証構成プロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| activeDirectoryAuth |
サーバーが Microsoft Entra 認証をサポートしているかどうかを示します。 |
|
| passwordAuth |
サーバーがパスワードベースの認証をサポートしているかどうかを示します。 |
|
| tenantId |
string |
委任されたリソースのテナントの識別子。 |
AzureManagedDiskPerformanceTier
サーバーのストレージ層。
| 値 | 説明 |
|---|---|
| P1 | |
| P2 | |
| P3 | |
| P4 | |
| P6 | |
| P10 | |
| P15 | |
| P20 | |
| P30 | |
| P40 | |
| P50 | |
| P60 | |
| P70 | |
| P80 |
BackupForPatch
サーバーのバックアップ プロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| backupRetentionDays |
integer (int32) |
サーバーのバックアップ保有日数。 |
| earliestRestoreDate |
string (date-time) |
サーバーの最も早い復元ポイント時刻 (ISO8601形式)。 |
| geoRedundantBackup |
サーバーが地理的に冗長なバックアップを作成するように構成されているかどうかを示します。 |
Cluster
サーバーのクラスター プロパティ。
| 名前 | 型 | 規定値 | 説明 |
|---|---|---|---|
| clusterSize |
integer (int32) |
0 |
エラスティッククラスターに割り当てられたノードの数。 |
| defaultDatabaseName |
string |
エラスティック クラスターの既定のデータベース名。 |
CreateModeForPatch
既存のサーバーの更新モード。
| 値 | 説明 |
|---|---|
| Default | |
| Update |
DataEncryption
サーバーのデータ暗号化プロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| geoBackupEncryptionKeyStatus |
地理的に冗長なバックアップをサポートするように構成されている場合に、サーバーに関連付けられている地理的に冗長なストレージを暗号化するために、カスタマー マネージド キーに基づくデータ暗号化で構成されたサーバーによって使用されるキーの状態。 |
|
| geoBackupKeyURI |
string |
地理的に冗長なバックアップをサポートするように構成されているサーバーに関連付けられている地理的に冗長なストレージのデータ暗号化のために、Azure Key Vault のキーにアクセスするために使用されるユーザー割り当てマネージド ID の識別子。 |
| geoBackupUserAssignedIdentityId |
string |
地理的に冗長なバックアップをサポートするように構成されているサーバーに関連付けられている地理的に冗長なストレージのデータ暗号化のために、Azure Key Vault のキーにアクセスするために使用されるユーザー割り当てマネージド ID の識別子。 |
| primaryEncryptionKeyStatus |
サーバーに関連付けられているプライマリ ストレージを暗号化するために、カスタマー マネージド キーに基づくデータ暗号化で構成されたサーバーで使用されるキーの状態。 |
|
| primaryKeyURI |
string |
サーバーに関連付けられているプライマリ ストレージのデータ暗号化に使用される Azure Key Vault のキーの URI。 |
| primaryUserAssignedIdentityId |
string |
サーバーに関連付けられているプライマリ ストレージのデータ暗号化のために Azure Key Vault のキーにアクセスするために使用される、ユーザー割り当てマネージド ID の識別子。 |
| type |
サーバーで使用されるデータ暗号化タイプ。 |
DataEncryptionType
サーバーで使用されるデータ暗号化タイプ。
| 値 | 説明 |
|---|---|
| SystemManaged | |
| AzureKeyVault |
EncryptionKeyStatus
サーバーに関連付けられているプライマリ ストレージを暗号化するために、カスタマー マネージド キーに基づくデータ暗号化で構成されたサーバーで使用されるキーの状態。
| 値 | 説明 |
|---|---|
| Valid | |
| Invalid |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細です。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
GeographicallyRedundantBackup
サーバーが地理的に冗長なバックアップを作成するように構成されているかどうかを示します。
| 値 | 説明 |
|---|---|
| Enabled | |
| Disabled |
HighAvailabilityForPatch
サーバーの高可用性プロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| mode |
サーバーの高可用性モード。 |
|
| standbyAvailabilityZone |
string |
高可用性が SameZone または ZoneRedundant に設定されている場合に作成されるスタンバイ サーバーに関連付けられた可用性ゾーン。 |
| state |
高可用性が SameZone または ZoneRedundant に設定されている場合に作成されるスタンバイ サーバーの状態。 |
HighAvailabilityState
高可用性が SameZone または ZoneRedundant に設定されている場合に作成されるスタンバイ サーバーの状態。
| 値 | 説明 |
|---|---|
| NotEnabled | |
| CreatingStandby | |
| ReplicatingData | |
| FailingOver | |
| Healthy | |
| RemovingStandby |
IdentityType
サーバーに関連付けられている ID のタイプ。
| 値 | 説明 |
|---|---|
| None | |
| UserAssigned | |
| SystemAssigned | |
| SystemAssigned,UserAssigned |
MaintenanceWindowForPatch
サーバーのメンテナンス期間のプロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| customWindow |
string |
カスタムウィンドウが有効か無効かを示します。 |
| dayOfWeek |
integer (int32) |
メンテナンスウィンドウに使用する曜日。 |
| startHour |
integer (int32) |
メンテナンスウィンドウに使用する開始時間。 |
| startMinute |
integer (int32) |
メンテナンスウィンドウに使用する開始分。 |
MicrosoftEntraAuth
サーバーが Microsoft Entra 認証をサポートしているかどうかを示します。
| 値 | 説明 |
|---|---|
| Enabled | |
| Disabled |
Network
サーバーのネットワーク プロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| delegatedSubnetResourceId |
string (arm-id) |
委任されたサブネットのリソース識別子。 新しいサーバーの作成時に必要になります (サーバーを独自の仮想ネットワークに統合する場合)。 更新操作では、プライベート DNS ゾーンに割り当てられた値を変更する場合にのみ、このプロパティを指定する必要があります。 |
| privateDnsZoneArmResourceId |
string (arm-id) |
プライベート DNS ゾーンの識別子。 新しいサーバーの作成時に必要になります (サーバーを独自の仮想ネットワークに統合する場合)。 更新操作では、プライベート DNS ゾーンに割り当てられた値を変更する場合にのみ、このプロパティを指定する必要があります。 |
| publicNetworkAccess |
パブリックネットワークアクセスが有効になっているかどうかを示します。 これは、サーバーの展開時に顧客が所有および提供する仮想ネットワークに統合されていないサーバーでのみサポートされます。 |
PasswordBasedAuth
サーバーがパスワードベースの認証をサポートしているかどうかを示します。
| 値 | 説明 |
|---|---|
| Enabled | |
| Disabled |
PostgresMajorVersion
PostgreSQL データベースエンジンのメジャーバージョン。
| 値 | 説明 |
|---|---|
| 18 | |
| 17 | |
| 16 | |
| 15 | |
| 14 | |
| 13 | |
| 12 | |
| 11 |
PostgreSqlFlexibleServerHighAvailabilityMode
このコンピューティングでサポートされている高可用性のモード。
| 値 | 説明 |
|---|---|
| Disabled | |
| ZoneRedundant | |
| SameZone |
ReadReplicaPromoteMode
リードレプリカに適用する操作のタイプ。 このプロパティは書き込み専用です。 スタンドアロンとは、リードレプリカがスタンドアロンサーバーに昇格され、レプリケーションセットから完全に独立したエンティティになることを意味します。 スイッチオーバーとは、リードレプリカがプライマリサーバーとロールすることを意味します。
| 値 | 説明 |
|---|---|
| Standalone |
リードレプリカは独立したサーバーになります。 |
| Switchover |
リードレプリカは、プライマリサーバーとロールを交換します。 |
ReadReplicaPromoteOption
promoteMode プロパティで指定された操作を処理するときに使用するデータ同期オプション。 このプロパティは書き込み専用です。
| 値 | 説明 |
|---|---|
| Planned |
この操作は、リードレプリカ内のデータがソースサーバーと完全に同期されるまで待ってから、操作を開始します。 |
| Forced |
この操作は、読み取りレプリカ内のデータがソースサーバーと同期されるのを待ってから、操作を開始します。 |
Replica
サーバーのレプリカ プロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| capacity |
integer (int32) |
サーバーに許可されるリードレプリカの最大数。 |
| promoteMode |
リードレプリカに適用する操作のタイプ。 このプロパティは書き込み専用です。 スタンドアロンとは、リードレプリカがスタンドアロンサーバーに昇格され、レプリケーションセットから完全に独立したエンティティになることを意味します。 スイッチオーバーとは、リードレプリカがプライマリサーバーとロールすることを意味します。 |
|
| promoteOption |
promoteMode プロパティで指定された操作を処理するときに使用するデータ同期オプション。 このプロパティは書き込み専用です。 |
|
| replicationState |
リードレプリカのレプリケーション状態を示します。 このプロパティは、ターゲット サーバーがリード レプリカである場合にのみ返されます。 可能な値は、Active、Broken、Catchup、Provisioning、Reconfiguring、および Updating です |
|
| role |
レプリケーション・セット内のサーバーの役割。 |
ReplicationRole
レプリケーション・セット内のサーバーの役割。
| 値 | 説明 |
|---|---|
| None | |
| Primary | |
| AsyncReplica | |
| GeoAsyncReplica |
ReplicationState
リードレプリカのレプリケーション状態を示します。 このプロパティは、ターゲット サーバーがリード レプリカである場合にのみ返されます。 可能な値は、Active、Broken、Catchup、Provisioning、Reconfiguring、および Updating です
| 値 | 説明 |
|---|---|
| Active |
リードレプリカサーバーは完全に同期されており、プライマリサーバーからデータを積極的に複製しています。 |
| Catchup |
リードレプリカサーバーはプライマリサーバーの後ろにあり、現在保留中の変更に対応しています。 |
| Provisioning |
リードレプリカサーバーは作成中で、初期化の過程にあります。 |
| Updating |
リードレプリカサーバーはいくつかの変更が行われており、プライマリサーバーに昇格するための計算量も変わる可能性があります。 |
| Broken |
レプリケーションが失敗したか、中断されました。 |
| Reconfiguring |
リードレプリカサーバーは、ソースや設定の変更が原因で再構成されています。 |
ServerForPatch
更新するサーバーを表します。
| 名前 | 型 | 説明 |
|---|---|---|
| identity |
アプリケーションの ID について説明します。 |
|
| properties.administratorLogin |
string |
PostgreSQLのインスタンスに割り当てられた最初のパスワードベースの管理者として指定されたログインの名前。 サーバー上でパスワードベースの認証を初めて有効にするときに指定する必要があります。 特定の値に一度設定すると、サーバーの存続期間中は変更できません。 パスワードベースの認証が有効になっているサーバーでパスワードベースの認証を無効にしても、このパスワードベースのロールは削除されません。 |
| properties.administratorLoginPassword |
string (password) |
管理者ログインに割り当てられたパスワード。 パスワード認証が有効になっている限り、このパスワードはいつでも変更できます。 |
| properties.authConfig |
サーバーの認証構成プロパティ。 |
|
| properties.availabilityZone |
string |
サーバーの可用性ゾーン。 |
| properties.backup |
サーバーのバックアップ プロパティ。 |
|
| properties.cluster |
サーバーのクラスター プロパティ。 |
|
| properties.createMode |
既存のサーバーの更新モード。 |
|
| properties.dataEncryption |
サーバーのデータ暗号化プロパティ。 |
|
| properties.highAvailability |
サーバーの高可用性プロパティ。 |
|
| properties.maintenanceWindow |
サーバーのメンテナンス期間のプロパティ。 |
|
| properties.network |
サーバーのネットワーク プロパティ。 お客様が提供する仮想ネットワークにサーバーを統合する場合にのみ必要です。 |
|
| properties.replica |
サーバーのリードレプリカプロパティ。 サーバーを昇格する場合にのみ必要です。 |
|
| properties.replicationRole |
レプリケーション・セット内のサーバーの役割。 |
|
| properties.storage |
サーバーのストレージ プロパティ。 |
|
| properties.version |
PostgreSQL データベースエンジンのメジャーバージョン。 |
|
| sku |
サーバーのコンピューティング層とサイズ。 |
|
| tags |
object |
キーと値のペアの形式による、アプリケーション固有のメタデータ。 |
ServerPublicNetworkAccessState
パブリックネットワークアクセスが有効になっているかどうかを示します。
| 値 | 説明 |
|---|---|
| Enabled | |
| Disabled |
SkuForPatch
サーバーのコンピューティング情報。
| 名前 | 型 | 説明 |
|---|---|---|
| name |
string |
サーバーに割り当てられた特定のコンピューティング サイズがわかる名前。 |
| tier |
サーバーに割り当てられたコンピューティングの層。 |
SkuTier
サーバーに割り当てられたコンピューティングの層。
| 値 | 説明 |
|---|---|
| Burstable | |
| GeneralPurpose | |
| MemoryOptimized |
Storage
サーバーのストレージ プロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| autoGrow |
使用可能なスペースがゼロに近づき、ストレージサイズを自動的に増加させる条件がある場合に、サーバーのストレージサイズの自動増加を有効または無効にするフラグ。 |
|
| iops |
integer (int32) |
ストレージでサポートされる最大 IOPS 。 ストレージのタイプがPremiumV2_LRSまたはUltraSSD_LRSの場合に必要です。 |
| storageSizeGB |
integer (int32) |
サーバーに割り当てられたストレージのサイズ。 |
| throughput |
integer (int32) |
ストレージでサポートされる最大スループット。 ストレージのタイプがPremiumV2_LRSまたはUltraSSD_LRSの場合に必要です。 |
| tier |
サーバーのストレージ層。 |
|
| type |
サーバーに割り当てられたストレージのタイプ。 使用できる値は、Premium_LRS、PremiumV2_LRS、または UltraSSD_LRS です。 指定しない場合、デフォルトは Premium_LRS です。 |
StorageAutoGrow
使用可能なスペースがゼロに近づき、ストレージサイズを自動的に増加させる条件がある場合に、サーバーのストレージサイズの自動増加を有効または無効にするフラグ。
| 値 | 説明 |
|---|---|
| Enabled | |
| Disabled |
StorageType
サーバーに割り当てられたストレージのタイプ。 使用できる値は、Premium_LRS、PremiumV2_LRS、または UltraSSD_LRS です。 指定しない場合、デフォルトは Premium_LRS です。
| 値 | 説明 |
|---|---|
| Premium_LRS | |
| PremiumV2_LRS | |
| UltraSSD_LRS |
UserAssignedIdentity
サーバーに関連付けられた ID。
| 名前 | 型 | 説明 |
|---|---|---|
| principalId |
string |
ユーザー割り当てマネージド ID に関連付けられているサービス プリンシパルのオブジェクトの識別子。 |
| tenantId |
string |
サーバーのテナントの識別子。 |
| type |
サーバーに関連付けられている ID のタイプ。 |
|
| userAssignedIdentities |
<string,
User |
ユーザー割り当てマネージド ID のマップ。 |
UserIdentity
サーバーに関連付けられているユーザー割り当てマネージド ID。
| 名前 | 型 | 説明 |
|---|---|---|
| clientId |
string |
ユーザー割り当てマネージド ID に関連付けられているサービス プリンシパルのクライアントの識別子。 |
| principalId |
string |
ユーザー割り当てマネージド ID に関連付けられているサービス プリンシパルのオブジェクトの識別子。 |