更新現有的 HorizonDB 池,包括其節點配置、所選計算模型屬性、計算模型類型、高可用性配置或相關參數群組。 省略的 nodeCount 與 highAvailability.mode 值會保留其現有值;服務在原子驗證有效元組前,遞迴合併 PATCH。 nodeCount 在提供時必須是 1 到 16。 Disabled 僅在有效 nodeCount 為 1 時有效。 AnyZone 和 ZoneRedundant 僅在有效節點計數為 2 到 16 時有效。 因此,跨越這些節點計數範圍需要同時更改 nodeCount 與 highAvailability.mode。 AnyZone 允許同區或跨區放置。 從 AnyZone 改為 ZoneRedundant 可能會在另一個可用區域分配替代節點,並替換只讀節點,導致與該替代節點的連線斷開。 若無法配置所有請求節點或所需的區域拓撲,則長期執行操作失敗,先前的資源狀態會被保留。 若要在不更改已設定的 nodeCount 的情況下釋放執行時運算,請使用 Pool 停止動作。 當提供 parameterGroup 時,則需要 parameterGroupResourceId 和 applyMethod。 池可在對應的預設參數群組與客戶建立的參數群組之間切換關聯。 applyMethod 控制動態參數變更生效的時間。 靜態參數變更總是需要客戶主動啟動重新啟動;停止後接啟動,排程維護不會套用待處理的變更。 針對子型別的計算約束,會根據遞迴合併的配置進行驗證。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HorizonDb/clusters/{clusterName}/pools/{poolName}?api-version=2026-10-01-preview
URI 參數
| 名稱 |
位於 |
必要 |
類型 |
Description |
|
clusterName
|
path |
True
|
string
minLength: 1 maxLength: 63 pattern: ^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$
|
HorizonDB 叢集的名稱。
|
|
poolName
|
path |
True
|
string
minLength: 1 maxLength: 63 pattern: ^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$
|
HorizonDB 池的名稱。
|
|
resourceGroupName
|
path |
True
|
string
minLength: 1 maxLength: 90
|
資源群組的名稱。 名稱不區分大小寫。
|
|
subscriptionId
|
path |
True
|
string
(uuid)
|
目標訂用帳戶的標識碼。 此值必須是 UUID。
|
|
api-version
|
query |
True
|
string
minLength: 1
|
用於此作業的 API 版本。
|
要求本文
回覆
| 名稱 |
類型 |
Description |
|
200 OK
|
Pool
|
Azure 運作順利完成。
|
|
202 Accepted
|
|
已接受資源更新要求。
標題
- Azure-AsyncOperation: string
- Location: string
- Retry-After: integer
|
|
Other Status Codes
|
ErrorResponse
|
未預期的錯誤回應。
|
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
| 名稱 |
Description |
|
user_impersonation
|
冒用您的使用者帳戶
|
範例
範例要求
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01?api-version=2026-10-01-preview
{
"properties": {
"parameterGroup": {
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/production-parameters",
"applyMethod": "Immediate"
}
}
}
import com.azure.resourcemanager.horizondb.models.ParameterApplyMethod;
import com.azure.resourcemanager.horizondb.models.Pool;
import com.azure.resourcemanager.horizondb.models.PoolParameterGroupReferenceForPatchUpdate;
import com.azure.resourcemanager.horizondb.models.PoolPropertiesForPatchUpdate;
/**
* Samples for Pools Update.
*/
public final class Main {
/*
* x-ms-original-file: 2026-10-01-preview/Pools_UpdateParameterGroupImmediate.json
*/
/**
* Sample code: Associate a HorizonDB pool with a parameter group immediately.
*
* @param manager Entry point to HorizonDbManager.
*/
public static void associateAHorizonDBPoolWithAParameterGroupImmediately(
com.azure.resourcemanager.horizondb.HorizonDbManager manager) {
Pool resource = manager.pools().getWithResponse("example-resource-group", "example-cluster", "example-pool-01",
com.azure.core.util.Context.NONE).getValue();
resource.update().withProperties(new PoolPropertiesForPatchUpdate()
.withParameterGroup(new PoolParameterGroupReferenceForPatchUpdate().withParameterGroupResourceId(
"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/production-parameters")
.withApplyMethod(ParameterApplyMethod.IMMEDIATE)))
.apply();
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.horizondb import HorizonDBMgmtClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-horizondb
# USAGE
python pools_update_parameter_group_immediate.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 = HorizonDBMgmtClient(
credential=DefaultAzureCredential(),
subscription_id="SUBSCRIPTION_ID",
)
response = client.pools.begin_update(
resource_group_name="example-resource-group",
cluster_name="example-cluster",
pool_name="example-pool-01",
properties={
"properties": {
"parameterGroup": {
"applyMethod": "Immediate",
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/production-parameters",
}
}
},
).result()
print(response)
# x-ms-original-file: 2026-10-01-preview/Pools_UpdateParameterGroupImmediate.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
package armhorizondb_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/horizondb/armhorizondb"
)
// Generated from example definition: 2026-10-01-preview/Pools_UpdateParameterGroupImmediate.json
func ExamplePoolsClient_BeginUpdate_associateAHorizonDbPoolWithAParameterGroupImmediately() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhorizondb.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPoolsClient().BeginUpdate(ctx, "example-resource-group", "example-cluster", "example-pool-01", armhorizondb.PoolForPatchUpdate{
Properties: &armhorizondb.PoolPropertiesForPatchUpdate{
ParameterGroup: &armhorizondb.PoolParameterGroupReferenceForPatchUpdate{
ParameterGroupResourceID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/production-parameters"),
ApplyMethod: to.Ptr(armhorizondb.ParameterApplyMethodImmediate),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %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 = armhorizondb.PoolsClientUpdateResponse{
// Pool: armhorizondb.Pool{
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01"),
// Name: to.Ptr("example-pool-01"),
// Type: to.Ptr("Microsoft.HorizonDb/clusters/pools"),
// Properties: &armhorizondb.PoolProperties{
// State: to.Ptr(armhorizondb.PoolStateReady),
// ComputeModel: &armhorizondb.PoolComputeModel{
// Type: to.Ptr(armhorizondb.PoolComputeModelTypeProvisioned),
// ComputeProcessor: to.Ptr(armhorizondb.ComputeProcessorTypeAMD),
// ComputeGeneration: to.Ptr[int32](3),
// VCores: to.Ptr[int32](8),
// },
// NodeCount: to.Ptr[int32](3),
// HighAvailability: &armhorizondb.PoolHighAvailability{
// Mode: to.Ptr(armhorizondb.PoolHighAvailabilityModeAnyZone),
// },
// ParameterGroup: &armhorizondb.PoolParameterGroupReference{
// ParameterGroupResourceID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/production-parameters"),
// ApplyMethod: to.Ptr(armhorizondb.ParameterApplyMethodImmediate),
// SyncStatus: to.Ptr(armhorizondb.ParameterGroupSyncStatusApplying),
// },
// ProvisioningState: to.Ptr(armhorizondb.ProvisioningStateSucceeded),
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { HorizonDbClient } = require("@azure/arm-horizondb");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to updates an existing HorizonDB pool, including its node allocation, selected compute model properties, compute model type, high-availability configuration, or associated parameter group. Omitted nodeCount and highAvailability.mode values preserve their existing values; the service recursively merges the PATCH before atomically validating the effective tuple. nodeCount, when supplied, must be 1 through 16. Disabled is valid only when the effective nodeCount is 1. AnyZone and ZoneRedundant are valid only when the effective nodeCount is 2 through 16. Therefore, crossing between those node-count ranges requires nodeCount and highAvailability.mode to be changed together. AnyZone permits same-zone or cross-zone placement. Changing from AnyZone to ZoneRedundant may allocate a replacement node in another availability zone and replace a read-only node, disconnecting connections to the replaced node. If all requested nodes or the required zonal topology cannot be provisioned, the long-running operation fails and the previous resource state is preserved. To deallocate runtime compute without changing the configured nodeCount, use the Pool stop action. When parameterGroup is supplied, both parameterGroupResourceId and applyMethod are required. The pool can switch its association in either direction between the corresponding default parameter group and a customer-created parameter group. applyMethod controls when dynamic parameter changes become effective. Static parameter changes always require a customer-initiated Restart; Stop followed by Start and scheduled maintenance do not apply pending changes. Subtype-specific compute constraints are validated against the recursively merged configuration.
*
* @summary updates an existing HorizonDB pool, including its node allocation, selected compute model properties, compute model type, high-availability configuration, or associated parameter group. Omitted nodeCount and highAvailability.mode values preserve their existing values; the service recursively merges the PATCH before atomically validating the effective tuple. nodeCount, when supplied, must be 1 through 16. Disabled is valid only when the effective nodeCount is 1. AnyZone and ZoneRedundant are valid only when the effective nodeCount is 2 through 16. Therefore, crossing between those node-count ranges requires nodeCount and highAvailability.mode to be changed together. AnyZone permits same-zone or cross-zone placement. Changing from AnyZone to ZoneRedundant may allocate a replacement node in another availability zone and replace a read-only node, disconnecting connections to the replaced node. If all requested nodes or the required zonal topology cannot be provisioned, the long-running operation fails and the previous resource state is preserved. To deallocate runtime compute without changing the configured nodeCount, use the Pool stop action. When parameterGroup is supplied, both parameterGroupResourceId and applyMethod are required. The pool can switch its association in either direction between the corresponding default parameter group and a customer-created parameter group. applyMethod controls when dynamic parameter changes become effective. Static parameter changes always require a customer-initiated Restart; Stop followed by Start and scheduled maintenance do not apply pending changes. Subtype-specific compute constraints are validated against the recursively merged configuration.
* x-ms-original-file: 2026-10-01-preview/Pools_UpdateParameterGroupImmediate.json
*/
async function associateAHorizonDBPoolWithAParameterGroupImmediately() {
const credential = new DefaultAzureCredential();
const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
const client = new HorizonDbClient(credential, subscriptionId);
const result = await client.pools.update(
"example-resource-group",
"example-cluster",
"example-pool-01",
{
properties: {
parameterGroup: {
parameterGroupResourceId:
"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/production-parameters",
applyMethod: "Immediate",
},
},
},
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
範例回覆
{
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01",
"name": "example-pool-01",
"type": "Microsoft.HorizonDb/clusters/pools",
"properties": {
"state": "Ready",
"computeModel": {
"type": "Provisioned",
"computeProcessor": "AMD",
"computeGeneration": 3,
"vCores": 8
},
"nodeCount": 3,
"highAvailability": {
"mode": "AnyZone"
},
"parameterGroup": {
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/production-parameters",
"applyMethod": "Immediate",
"syncStatus": "Applying"
},
"provisioningState": "Succeeded"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationStatuses/34343434-3434-3434-3434-343434343434?api-version=2026-10-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationResults/34343434-3434-3434-3434-343434343434?api-version=2026-10-01-preview
Retry-After: 30
Associate a HorizonDB pool with a parameter group pending reboot
範例要求
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01?api-version=2026-10-01-preview
{
"properties": {
"parameterGroup": {
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/maintenance-window-parameters",
"applyMethod": "PendingReboot"
}
}
}
import com.azure.resourcemanager.horizondb.models.ParameterApplyMethod;
import com.azure.resourcemanager.horizondb.models.Pool;
import com.azure.resourcemanager.horizondb.models.PoolParameterGroupReferenceForPatchUpdate;
import com.azure.resourcemanager.horizondb.models.PoolPropertiesForPatchUpdate;
/**
* Samples for Pools Update.
*/
public final class Main {
/*
* x-ms-original-file: 2026-10-01-preview/Pools_UpdateParameterGroupPendingReboot.json
*/
/**
* Sample code: Associate a HorizonDB pool with a parameter group pending reboot.
*
* @param manager Entry point to HorizonDbManager.
*/
public static void associateAHorizonDBPoolWithAParameterGroupPendingReboot(
com.azure.resourcemanager.horizondb.HorizonDbManager manager) {
Pool resource = manager.pools().getWithResponse("example-resource-group", "example-cluster", "example-pool-01",
com.azure.core.util.Context.NONE).getValue();
resource.update().withProperties(new PoolPropertiesForPatchUpdate()
.withParameterGroup(new PoolParameterGroupReferenceForPatchUpdate().withParameterGroupResourceId(
"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/maintenance-window-parameters")
.withApplyMethod(ParameterApplyMethod.PENDING_REBOOT)))
.apply();
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.horizondb import HorizonDBMgmtClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-horizondb
# USAGE
python pools_update_parameter_group_pending_reboot.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 = HorizonDBMgmtClient(
credential=DefaultAzureCredential(),
subscription_id="SUBSCRIPTION_ID",
)
response = client.pools.begin_update(
resource_group_name="example-resource-group",
cluster_name="example-cluster",
pool_name="example-pool-01",
properties={
"properties": {
"parameterGroup": {
"applyMethod": "PendingReboot",
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/maintenance-window-parameters",
}
}
},
).result()
print(response)
# x-ms-original-file: 2026-10-01-preview/Pools_UpdateParameterGroupPendingReboot.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
package armhorizondb_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/horizondb/armhorizondb"
)
// Generated from example definition: 2026-10-01-preview/Pools_UpdateParameterGroupPendingReboot.json
func ExamplePoolsClient_BeginUpdate_associateAHorizonDbPoolWithAParameterGroupPendingReboot() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhorizondb.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPoolsClient().BeginUpdate(ctx, "example-resource-group", "example-cluster", "example-pool-01", armhorizondb.PoolForPatchUpdate{
Properties: &armhorizondb.PoolPropertiesForPatchUpdate{
ParameterGroup: &armhorizondb.PoolParameterGroupReferenceForPatchUpdate{
ParameterGroupResourceID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/maintenance-window-parameters"),
ApplyMethod: to.Ptr(armhorizondb.ParameterApplyMethodPendingReboot),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %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 = armhorizondb.PoolsClientUpdateResponse{
// Pool: armhorizondb.Pool{
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01"),
// Name: to.Ptr("example-pool-01"),
// Type: to.Ptr("Microsoft.HorizonDb/clusters/pools"),
// Properties: &armhorizondb.PoolProperties{
// State: to.Ptr(armhorizondb.PoolStateReady),
// ComputeModel: &armhorizondb.PoolComputeModel{
// Type: to.Ptr(armhorizondb.PoolComputeModelTypeProvisioned),
// ComputeProcessor: to.Ptr(armhorizondb.ComputeProcessorTypeAMD),
// ComputeGeneration: to.Ptr[int32](3),
// VCores: to.Ptr[int32](8),
// },
// NodeCount: to.Ptr[int32](3),
// HighAvailability: &armhorizondb.PoolHighAvailability{
// Mode: to.Ptr(armhorizondb.PoolHighAvailabilityModeAnyZone),
// },
// ParameterGroup: &armhorizondb.PoolParameterGroupReference{
// ParameterGroupResourceID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/maintenance-window-parameters"),
// ApplyMethod: to.Ptr(armhorizondb.ParameterApplyMethodPendingReboot),
// SyncStatus: to.Ptr(armhorizondb.ParameterGroupSyncStatusPendingReboot),
// },
// ProvisioningState: to.Ptr(armhorizondb.ProvisioningStateSucceeded),
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { HorizonDbClient } = require("@azure/arm-horizondb");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to updates an existing HorizonDB pool, including its node allocation, selected compute model properties, compute model type, high-availability configuration, or associated parameter group. Omitted nodeCount and highAvailability.mode values preserve their existing values; the service recursively merges the PATCH before atomically validating the effective tuple. nodeCount, when supplied, must be 1 through 16. Disabled is valid only when the effective nodeCount is 1. AnyZone and ZoneRedundant are valid only when the effective nodeCount is 2 through 16. Therefore, crossing between those node-count ranges requires nodeCount and highAvailability.mode to be changed together. AnyZone permits same-zone or cross-zone placement. Changing from AnyZone to ZoneRedundant may allocate a replacement node in another availability zone and replace a read-only node, disconnecting connections to the replaced node. If all requested nodes or the required zonal topology cannot be provisioned, the long-running operation fails and the previous resource state is preserved. To deallocate runtime compute without changing the configured nodeCount, use the Pool stop action. When parameterGroup is supplied, both parameterGroupResourceId and applyMethod are required. The pool can switch its association in either direction between the corresponding default parameter group and a customer-created parameter group. applyMethod controls when dynamic parameter changes become effective. Static parameter changes always require a customer-initiated Restart; Stop followed by Start and scheduled maintenance do not apply pending changes. Subtype-specific compute constraints are validated against the recursively merged configuration.
*
* @summary updates an existing HorizonDB pool, including its node allocation, selected compute model properties, compute model type, high-availability configuration, or associated parameter group. Omitted nodeCount and highAvailability.mode values preserve their existing values; the service recursively merges the PATCH before atomically validating the effective tuple. nodeCount, when supplied, must be 1 through 16. Disabled is valid only when the effective nodeCount is 1. AnyZone and ZoneRedundant are valid only when the effective nodeCount is 2 through 16. Therefore, crossing between those node-count ranges requires nodeCount and highAvailability.mode to be changed together. AnyZone permits same-zone or cross-zone placement. Changing from AnyZone to ZoneRedundant may allocate a replacement node in another availability zone and replace a read-only node, disconnecting connections to the replaced node. If all requested nodes or the required zonal topology cannot be provisioned, the long-running operation fails and the previous resource state is preserved. To deallocate runtime compute without changing the configured nodeCount, use the Pool stop action. When parameterGroup is supplied, both parameterGroupResourceId and applyMethod are required. The pool can switch its association in either direction between the corresponding default parameter group and a customer-created parameter group. applyMethod controls when dynamic parameter changes become effective. Static parameter changes always require a customer-initiated Restart; Stop followed by Start and scheduled maintenance do not apply pending changes. Subtype-specific compute constraints are validated against the recursively merged configuration.
* x-ms-original-file: 2026-10-01-preview/Pools_UpdateParameterGroupPendingReboot.json
*/
async function associateAHorizonDBPoolWithAParameterGroupPendingReboot() {
const credential = new DefaultAzureCredential();
const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
const client = new HorizonDbClient(credential, subscriptionId);
const result = await client.pools.update(
"example-resource-group",
"example-cluster",
"example-pool-01",
{
properties: {
parameterGroup: {
parameterGroupResourceId:
"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/maintenance-window-parameters",
applyMethod: "PendingReboot",
},
},
},
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
範例回覆
{
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01",
"name": "example-pool-01",
"type": "Microsoft.HorizonDb/clusters/pools",
"properties": {
"state": "Ready",
"computeModel": {
"type": "Provisioned",
"computeProcessor": "AMD",
"computeGeneration": 3,
"vCores": 8
},
"nodeCount": 3,
"highAvailability": {
"mode": "AnyZone"
},
"parameterGroup": {
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/maintenance-window-parameters",
"applyMethod": "PendingReboot",
"syncStatus": "PendingReboot"
},
"provisioningState": "Succeeded"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationStatuses/45454545-4545-4545-4545-454545454545?api-version=2026-10-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationResults/45454545-4545-4545-4545-454545454545?api-version=2026-10-01-preview
Retry-After: 30
Require zone-redundant placement for a HorizonDB pool
範例要求
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01?api-version=2026-10-01-preview
{
"properties": {
"highAvailability": {
"mode": "ZoneRedundant"
}
}
}
import com.azure.resourcemanager.horizondb.models.Pool;
import com.azure.resourcemanager.horizondb.models.PoolHighAvailabilityMode;
import com.azure.resourcemanager.horizondb.models.PoolHighAvailabilityPatch;
import com.azure.resourcemanager.horizondb.models.PoolPropertiesForPatchUpdate;
/**
* Samples for Pools Update.
*/
public final class Main {
/*
* x-ms-original-file: 2026-10-01-preview/Pools_UpdateHighAvailabilityMode.json
*/
/**
* Sample code: Require zone-redundant placement for a HorizonDB pool.
*
* @param manager Entry point to HorizonDbManager.
*/
public static void
requireZoneRedundantPlacementForAHorizonDBPool(com.azure.resourcemanager.horizondb.HorizonDbManager manager) {
Pool resource = manager.pools().getWithResponse("example-resource-group", "example-cluster", "example-pool-01",
com.azure.core.util.Context.NONE).getValue();
resource.update().withProperties(new PoolPropertiesForPatchUpdate()
.withHighAvailability(new PoolHighAvailabilityPatch().withMode(PoolHighAvailabilityMode.ZONE_REDUNDANT)))
.apply();
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.horizondb import HorizonDBMgmtClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-horizondb
# USAGE
python pools_update_high_availability_mode.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 = HorizonDBMgmtClient(
credential=DefaultAzureCredential(),
subscription_id="SUBSCRIPTION_ID",
)
response = client.pools.begin_update(
resource_group_name="example-resource-group",
cluster_name="example-cluster",
pool_name="example-pool-01",
properties={"properties": {"highAvailability": {"mode": "ZoneRedundant"}}},
).result()
print(response)
# x-ms-original-file: 2026-10-01-preview/Pools_UpdateHighAvailabilityMode.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
package armhorizondb_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/horizondb/armhorizondb"
)
// Generated from example definition: 2026-10-01-preview/Pools_UpdateHighAvailabilityMode.json
func ExamplePoolsClient_BeginUpdate_requireZoneRedundantPlacementForAHorizonDbPool() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhorizondb.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPoolsClient().BeginUpdate(ctx, "example-resource-group", "example-cluster", "example-pool-01", armhorizondb.PoolForPatchUpdate{
Properties: &armhorizondb.PoolPropertiesForPatchUpdate{
HighAvailability: &armhorizondb.PoolHighAvailabilityPatch{
Mode: to.Ptr(armhorizondb.PoolHighAvailabilityModeZoneRedundant),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %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 = armhorizondb.PoolsClientUpdateResponse{
// Pool: armhorizondb.Pool{
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01"),
// Name: to.Ptr("example-pool-01"),
// Type: to.Ptr("Microsoft.HorizonDb/clusters/pools"),
// Properties: &armhorizondb.PoolProperties{
// State: to.Ptr(armhorizondb.PoolStateReady),
// ComputeModel: &armhorizondb.PoolComputeModel{
// Type: to.Ptr(armhorizondb.PoolComputeModelTypeProvisioned),
// ComputeProcessor: to.Ptr(armhorizondb.ComputeProcessorTypeAMD),
// ComputeGeneration: to.Ptr[int32](3),
// VCores: to.Ptr[int32](8),
// },
// NodeCount: to.Ptr[int32](3),
// HighAvailability: &armhorizondb.PoolHighAvailability{
// Mode: to.Ptr(armhorizondb.PoolHighAvailabilityModeZoneRedundant),
// },
// ParameterGroup: &armhorizondb.PoolParameterGroupReference{
// ParameterGroupResourceID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/production-parameters"),
// ApplyMethod: to.Ptr(armhorizondb.ParameterApplyMethodImmediate),
// SyncStatus: to.Ptr(armhorizondb.ParameterGroupSyncStatusInSync),
// },
// ScheduledMaintenance: &armhorizondb.SystemScheduledMaintenanceProperties{
// MaintenanceManagementType: to.Ptr(armhorizondb.ScheduledMaintenanceManagementTypeSystem),
// },
// ProvisioningState: to.Ptr(armhorizondb.ProvisioningStateSucceeded),
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { HorizonDbClient } = require("@azure/arm-horizondb");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to updates an existing HorizonDB pool, including its node allocation, selected compute model properties, compute model type, high-availability configuration, or associated parameter group. Omitted nodeCount and highAvailability.mode values preserve their existing values; the service recursively merges the PATCH before atomically validating the effective tuple. nodeCount, when supplied, must be 1 through 16. Disabled is valid only when the effective nodeCount is 1. AnyZone and ZoneRedundant are valid only when the effective nodeCount is 2 through 16. Therefore, crossing between those node-count ranges requires nodeCount and highAvailability.mode to be changed together. AnyZone permits same-zone or cross-zone placement. Changing from AnyZone to ZoneRedundant may allocate a replacement node in another availability zone and replace a read-only node, disconnecting connections to the replaced node. If all requested nodes or the required zonal topology cannot be provisioned, the long-running operation fails and the previous resource state is preserved. To deallocate runtime compute without changing the configured nodeCount, use the Pool stop action. When parameterGroup is supplied, both parameterGroupResourceId and applyMethod are required. The pool can switch its association in either direction between the corresponding default parameter group and a customer-created parameter group. applyMethod controls when dynamic parameter changes become effective. Static parameter changes always require a customer-initiated Restart; Stop followed by Start and scheduled maintenance do not apply pending changes. Subtype-specific compute constraints are validated against the recursively merged configuration.
*
* @summary updates an existing HorizonDB pool, including its node allocation, selected compute model properties, compute model type, high-availability configuration, or associated parameter group. Omitted nodeCount and highAvailability.mode values preserve their existing values; the service recursively merges the PATCH before atomically validating the effective tuple. nodeCount, when supplied, must be 1 through 16. Disabled is valid only when the effective nodeCount is 1. AnyZone and ZoneRedundant are valid only when the effective nodeCount is 2 through 16. Therefore, crossing between those node-count ranges requires nodeCount and highAvailability.mode to be changed together. AnyZone permits same-zone or cross-zone placement. Changing from AnyZone to ZoneRedundant may allocate a replacement node in another availability zone and replace a read-only node, disconnecting connections to the replaced node. If all requested nodes or the required zonal topology cannot be provisioned, the long-running operation fails and the previous resource state is preserved. To deallocate runtime compute without changing the configured nodeCount, use the Pool stop action. When parameterGroup is supplied, both parameterGroupResourceId and applyMethod are required. The pool can switch its association in either direction between the corresponding default parameter group and a customer-created parameter group. applyMethod controls when dynamic parameter changes become effective. Static parameter changes always require a customer-initiated Restart; Stop followed by Start and scheduled maintenance do not apply pending changes. Subtype-specific compute constraints are validated against the recursively merged configuration.
* x-ms-original-file: 2026-10-01-preview/Pools_UpdateHighAvailabilityMode.json
*/
async function requireZoneRedundantPlacementForAHorizonDBPool() {
const credential = new DefaultAzureCredential();
const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
const client = new HorizonDbClient(credential, subscriptionId);
const result = await client.pools.update(
"example-resource-group",
"example-cluster",
"example-pool-01",
{ properties: { highAvailability: { mode: "ZoneRedundant" } } },
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
範例回覆
{
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01",
"name": "example-pool-01",
"type": "Microsoft.HorizonDb/clusters/pools",
"properties": {
"state": "Ready",
"computeModel": {
"type": "Provisioned",
"computeProcessor": "AMD",
"computeGeneration": 3,
"vCores": 8
},
"nodeCount": 3,
"highAvailability": {
"mode": "ZoneRedundant"
},
"parameterGroup": {
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/production-parameters",
"applyMethod": "Immediate",
"syncStatus": "InSync"
},
"scheduledMaintenance": {
"maintenanceManagementType": "System"
},
"provisioningState": "Succeeded"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationStatuses/78787878-7878-7878-7878-787878787878?api-version=2026-10-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationResults/78787878-7878-7878-7878-787878787878?api-version=2026-10-01-preview
Retry-After: 30
Switch a HorizonDB pool back to its corresponding default parameter group
範例要求
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01?api-version=2026-10-01-preview
{
"properties": {
"parameterGroup": {
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned",
"applyMethod": "Immediate"
}
}
}
import com.azure.resourcemanager.horizondb.models.ParameterApplyMethod;
import com.azure.resourcemanager.horizondb.models.Pool;
import com.azure.resourcemanager.horizondb.models.PoolParameterGroupReferenceForPatchUpdate;
import com.azure.resourcemanager.horizondb.models.PoolPropertiesForPatchUpdate;
/**
* Samples for Pools Update.
*/
public final class Main {
/*
* x-ms-original-file: 2026-10-01-preview/Pools_UpdateParameterGroupDefault.json
*/
/**
* Sample code: Switch a HorizonDB pool back to its corresponding default parameter group.
*
* @param manager Entry point to HorizonDbManager.
*/
public static void switchAHorizonDBPoolBackToItsCorrespondingDefaultParameterGroup(
com.azure.resourcemanager.horizondb.HorizonDbManager manager) {
Pool resource = manager.pools().getWithResponse("example-resource-group", "example-cluster", "example-pool-01",
com.azure.core.util.Context.NONE).getValue();
resource.update().withProperties(new PoolPropertiesForPatchUpdate()
.withParameterGroup(new PoolParameterGroupReferenceForPatchUpdate().withParameterGroupResourceId(
"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned")
.withApplyMethod(ParameterApplyMethod.IMMEDIATE)))
.apply();
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.horizondb import HorizonDBMgmtClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-horizondb
# USAGE
python pools_update_parameter_group_default.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 = HorizonDBMgmtClient(
credential=DefaultAzureCredential(),
subscription_id="SUBSCRIPTION_ID",
)
response = client.pools.begin_update(
resource_group_name="example-resource-group",
cluster_name="example-cluster",
pool_name="example-pool-01",
properties={
"properties": {
"parameterGroup": {
"applyMethod": "Immediate",
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned",
}
}
},
).result()
print(response)
# x-ms-original-file: 2026-10-01-preview/Pools_UpdateParameterGroupDefault.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
package armhorizondb_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/horizondb/armhorizondb"
)
// Generated from example definition: 2026-10-01-preview/Pools_UpdateParameterGroupDefault.json
func ExamplePoolsClient_BeginUpdate_switchAHorizonDbPoolBackToItsCorrespondingDefaultParameterGroup() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhorizondb.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPoolsClient().BeginUpdate(ctx, "example-resource-group", "example-cluster", "example-pool-01", armhorizondb.PoolForPatchUpdate{
Properties: &armhorizondb.PoolPropertiesForPatchUpdate{
ParameterGroup: &armhorizondb.PoolParameterGroupReferenceForPatchUpdate{
ParameterGroupResourceID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned"),
ApplyMethod: to.Ptr(armhorizondb.ParameterApplyMethodImmediate),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %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 = armhorizondb.PoolsClientUpdateResponse{
// Pool: armhorizondb.Pool{
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01"),
// Name: to.Ptr("example-pool-01"),
// Type: to.Ptr("Microsoft.HorizonDb/clusters/pools"),
// Properties: &armhorizondb.PoolProperties{
// State: to.Ptr(armhorizondb.PoolStateReady),
// ComputeModel: &armhorizondb.PoolComputeModel{
// Type: to.Ptr(armhorizondb.PoolComputeModelTypeProvisioned),
// ComputeProcessor: to.Ptr(armhorizondb.ComputeProcessorTypeAMD),
// ComputeGeneration: to.Ptr[int32](3),
// VCores: to.Ptr[int32](8),
// },
// NodeCount: to.Ptr[int32](3),
// HighAvailability: &armhorizondb.PoolHighAvailability{
// Mode: to.Ptr(armhorizondb.PoolHighAvailabilityModeAnyZone),
// },
// ParameterGroup: &armhorizondb.PoolParameterGroupReference{
// ParameterGroupResourceID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned"),
// ApplyMethod: to.Ptr(armhorizondb.ParameterApplyMethodImmediate),
// SyncStatus: to.Ptr(armhorizondb.ParameterGroupSyncStatusApplying),
// },
// ProvisioningState: to.Ptr(armhorizondb.ProvisioningStateSucceeded),
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { HorizonDbClient } = require("@azure/arm-horizondb");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to updates an existing HorizonDB pool, including its node allocation, selected compute model properties, compute model type, high-availability configuration, or associated parameter group. Omitted nodeCount and highAvailability.mode values preserve their existing values; the service recursively merges the PATCH before atomically validating the effective tuple. nodeCount, when supplied, must be 1 through 16. Disabled is valid only when the effective nodeCount is 1. AnyZone and ZoneRedundant are valid only when the effective nodeCount is 2 through 16. Therefore, crossing between those node-count ranges requires nodeCount and highAvailability.mode to be changed together. AnyZone permits same-zone or cross-zone placement. Changing from AnyZone to ZoneRedundant may allocate a replacement node in another availability zone and replace a read-only node, disconnecting connections to the replaced node. If all requested nodes or the required zonal topology cannot be provisioned, the long-running operation fails and the previous resource state is preserved. To deallocate runtime compute without changing the configured nodeCount, use the Pool stop action. When parameterGroup is supplied, both parameterGroupResourceId and applyMethod are required. The pool can switch its association in either direction between the corresponding default parameter group and a customer-created parameter group. applyMethod controls when dynamic parameter changes become effective. Static parameter changes always require a customer-initiated Restart; Stop followed by Start and scheduled maintenance do not apply pending changes. Subtype-specific compute constraints are validated against the recursively merged configuration.
*
* @summary updates an existing HorizonDB pool, including its node allocation, selected compute model properties, compute model type, high-availability configuration, or associated parameter group. Omitted nodeCount and highAvailability.mode values preserve their existing values; the service recursively merges the PATCH before atomically validating the effective tuple. nodeCount, when supplied, must be 1 through 16. Disabled is valid only when the effective nodeCount is 1. AnyZone and ZoneRedundant are valid only when the effective nodeCount is 2 through 16. Therefore, crossing between those node-count ranges requires nodeCount and highAvailability.mode to be changed together. AnyZone permits same-zone or cross-zone placement. Changing from AnyZone to ZoneRedundant may allocate a replacement node in another availability zone and replace a read-only node, disconnecting connections to the replaced node. If all requested nodes or the required zonal topology cannot be provisioned, the long-running operation fails and the previous resource state is preserved. To deallocate runtime compute without changing the configured nodeCount, use the Pool stop action. When parameterGroup is supplied, both parameterGroupResourceId and applyMethod are required. The pool can switch its association in either direction between the corresponding default parameter group and a customer-created parameter group. applyMethod controls when dynamic parameter changes become effective. Static parameter changes always require a customer-initiated Restart; Stop followed by Start and scheduled maintenance do not apply pending changes. Subtype-specific compute constraints are validated against the recursively merged configuration.
* x-ms-original-file: 2026-10-01-preview/Pools_UpdateParameterGroupDefault.json
*/
async function switchAHorizonDBPoolBackToItsCorrespondingDefaultParameterGroup() {
const credential = new DefaultAzureCredential();
const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
const client = new HorizonDbClient(credential, subscriptionId);
const result = await client.pools.update(
"example-resource-group",
"example-cluster",
"example-pool-01",
{
properties: {
parameterGroup: {
parameterGroupResourceId:
"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned",
applyMethod: "Immediate",
},
},
},
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
範例回覆
{
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01",
"name": "example-pool-01",
"type": "Microsoft.HorizonDb/clusters/pools",
"properties": {
"state": "Ready",
"computeModel": {
"type": "Provisioned",
"computeProcessor": "AMD",
"computeGeneration": 3,
"vCores": 8
},
"nodeCount": 3,
"highAvailability": {
"mode": "AnyZone"
},
"parameterGroup": {
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned",
"applyMethod": "Immediate",
"syncStatus": "Applying"
},
"provisioningState": "Succeeded"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationStatuses/56565656-5656-5656-5656-565656565656?api-version=2026-10-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationResults/56565656-5656-5656-5656-565656565656?api-version=2026-10-01-preview
Retry-After: 30
Update a single HorizonDB pool compute property
範例要求
PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01?api-version=2026-10-01-preview
{
"properties": {
"computeModel": {
"vCores": 16
},
"scheduledMaintenance": {
"maintenanceManagementType": "System"
}
}
}
import com.azure.resourcemanager.horizondb.models.Pool;
import com.azure.resourcemanager.horizondb.models.PoolComputeModelForPatchUpdate;
import com.azure.resourcemanager.horizondb.models.PoolPropertiesForPatchUpdate;
import com.azure.resourcemanager.horizondb.models.ScheduledMaintenanceManagementType;
import com.azure.resourcemanager.horizondb.models.ScheduledMaintenancePropertiesForPatchUpdate;
/**
* Samples for Pools Update.
*/
public final class Main {
/*
* x-ms-original-file: 2026-10-01-preview/Pools_Update.json
*/
/**
* Sample code: Update a single HorizonDB pool compute property.
*
* @param manager Entry point to HorizonDbManager.
*/
public static void
updateASingleHorizonDBPoolComputeProperty(com.azure.resourcemanager.horizondb.HorizonDbManager manager) {
Pool resource = manager.pools().getWithResponse("example-resource-group", "example-cluster", "example-pool-01",
com.azure.core.util.Context.NONE).getValue();
resource.update()
.withProperties(
new PoolPropertiesForPatchUpdate().withComputeModel(new PoolComputeModelForPatchUpdate().withVCores(16))
.withScheduledMaintenance(new ScheduledMaintenancePropertiesForPatchUpdate()
.withMaintenanceManagementType(ScheduledMaintenanceManagementType.SYSTEM)))
.apply();
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.horizondb import HorizonDBMgmtClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-horizondb
# USAGE
python pools_update.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 = HorizonDBMgmtClient(
credential=DefaultAzureCredential(),
subscription_id="SUBSCRIPTION_ID",
)
response = client.pools.begin_update(
resource_group_name="example-resource-group",
cluster_name="example-cluster",
pool_name="example-pool-01",
properties={
"properties": {
"computeModel": {"vCores": 16},
"scheduledMaintenance": {"maintenanceManagementType": "System"},
}
},
).result()
print(response)
# x-ms-original-file: 2026-10-01-preview/Pools_Update.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
package armhorizondb_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/horizondb/armhorizondb"
)
// Generated from example definition: 2026-10-01-preview/Pools_Update.json
func ExamplePoolsClient_BeginUpdate_updateASingleHorizonDbPoolComputeProperty() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhorizondb.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPoolsClient().BeginUpdate(ctx, "example-resource-group", "example-cluster", "example-pool-01", armhorizondb.PoolForPatchUpdate{
Properties: &armhorizondb.PoolPropertiesForPatchUpdate{
ComputeModel: &armhorizondb.PoolComputeModelForPatchUpdate{
VCores: to.Ptr[int32](16),
},
ScheduledMaintenance: &armhorizondb.ScheduledMaintenancePropertiesForPatchUpdate{
MaintenanceManagementType: to.Ptr(armhorizondb.ScheduledMaintenanceManagementTypeSystem),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %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 = armhorizondb.PoolsClientUpdateResponse{
// Pool: armhorizondb.Pool{
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01"),
// Name: to.Ptr("example-pool-01"),
// Type: to.Ptr("Microsoft.HorizonDb/clusters/pools"),
// Properties: &armhorizondb.PoolProperties{
// State: to.Ptr(armhorizondb.PoolStateReady),
// ComputeModel: &armhorizondb.PoolComputeModel{
// Type: to.Ptr(armhorizondb.PoolComputeModelTypeProvisioned),
// ComputeProcessor: to.Ptr(armhorizondb.ComputeProcessorTypeAMD),
// ComputeGeneration: to.Ptr[int32](3),
// VCores: to.Ptr[int32](16),
// },
// NodeCount: to.Ptr[int32](3),
// HighAvailability: &armhorizondb.PoolHighAvailability{
// Mode: to.Ptr(armhorizondb.PoolHighAvailabilityModeAnyZone),
// },
// ParameterGroup: &armhorizondb.PoolParameterGroupReference{
// ParameterGroupResourceID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned"),
// ApplyMethod: to.Ptr(armhorizondb.ParameterApplyMethodImmediate),
// SyncStatus: to.Ptr(armhorizondb.ParameterGroupSyncStatusInSync),
// },
// ScheduledMaintenance: &armhorizondb.SystemScheduledMaintenanceProperties{
// MaintenanceManagementType: to.Ptr(armhorizondb.ScheduledMaintenanceManagementTypeSystem),
// },
// ProvisioningState: to.Ptr(armhorizondb.ProvisioningStateSucceeded),
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { HorizonDbClient } = require("@azure/arm-horizondb");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to updates an existing HorizonDB pool, including its node allocation, selected compute model properties, compute model type, high-availability configuration, or associated parameter group. Omitted nodeCount and highAvailability.mode values preserve their existing values; the service recursively merges the PATCH before atomically validating the effective tuple. nodeCount, when supplied, must be 1 through 16. Disabled is valid only when the effective nodeCount is 1. AnyZone and ZoneRedundant are valid only when the effective nodeCount is 2 through 16. Therefore, crossing between those node-count ranges requires nodeCount and highAvailability.mode to be changed together. AnyZone permits same-zone or cross-zone placement. Changing from AnyZone to ZoneRedundant may allocate a replacement node in another availability zone and replace a read-only node, disconnecting connections to the replaced node. If all requested nodes or the required zonal topology cannot be provisioned, the long-running operation fails and the previous resource state is preserved. To deallocate runtime compute without changing the configured nodeCount, use the Pool stop action. When parameterGroup is supplied, both parameterGroupResourceId and applyMethod are required. The pool can switch its association in either direction between the corresponding default parameter group and a customer-created parameter group. applyMethod controls when dynamic parameter changes become effective. Static parameter changes always require a customer-initiated Restart; Stop followed by Start and scheduled maintenance do not apply pending changes. Subtype-specific compute constraints are validated against the recursively merged configuration.
*
* @summary updates an existing HorizonDB pool, including its node allocation, selected compute model properties, compute model type, high-availability configuration, or associated parameter group. Omitted nodeCount and highAvailability.mode values preserve their existing values; the service recursively merges the PATCH before atomically validating the effective tuple. nodeCount, when supplied, must be 1 through 16. Disabled is valid only when the effective nodeCount is 1. AnyZone and ZoneRedundant are valid only when the effective nodeCount is 2 through 16. Therefore, crossing between those node-count ranges requires nodeCount and highAvailability.mode to be changed together. AnyZone permits same-zone or cross-zone placement. Changing from AnyZone to ZoneRedundant may allocate a replacement node in another availability zone and replace a read-only node, disconnecting connections to the replaced node. If all requested nodes or the required zonal topology cannot be provisioned, the long-running operation fails and the previous resource state is preserved. To deallocate runtime compute without changing the configured nodeCount, use the Pool stop action. When parameterGroup is supplied, both parameterGroupResourceId and applyMethod are required. The pool can switch its association in either direction between the corresponding default parameter group and a customer-created parameter group. applyMethod controls when dynamic parameter changes become effective. Static parameter changes always require a customer-initiated Restart; Stop followed by Start and scheduled maintenance do not apply pending changes. Subtype-specific compute constraints are validated against the recursively merged configuration.
* x-ms-original-file: 2026-10-01-preview/Pools_Update.json
*/
async function updateASingleHorizonDBPoolComputeProperty() {
const credential = new DefaultAzureCredential();
const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
const client = new HorizonDbClient(credential, subscriptionId);
const result = await client.pools.update(
"example-resource-group",
"example-cluster",
"example-pool-01",
{
properties: {
computeModel: { vCores: 16 },
scheduledMaintenance: { maintenanceManagementType: "System" },
},
},
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
範例回覆
{
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01",
"name": "example-pool-01",
"type": "Microsoft.HorizonDb/clusters/pools",
"properties": {
"state": "Ready",
"computeModel": {
"type": "Provisioned",
"computeProcessor": "AMD",
"computeGeneration": 3,
"vCores": 16
},
"nodeCount": 3,
"highAvailability": {
"mode": "AnyZone"
},
"parameterGroup": {
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned",
"applyMethod": "Immediate",
"syncStatus": "InSync"
},
"scheduledMaintenance": {
"maintenanceManagementType": "System"
},
"provisioningState": "Succeeded"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationStatuses/77777777-7777-7777-7777-777777777777?api-version=2026-10-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationResults/77777777-7777-7777-7777-777777777777?api-version=2026-10-01-preview
Retry-After: 30
定義
ComputeProcessorType
列舉型別
運算處理器類型。
| 值 |
Description |
|
Intel
|
Intel 處理器
|
|
AMD
|
AMD 處理器
|
createdByType
列舉型別
建立此資源的身分識別類型。
| 值 |
Description |
|
User
|
|
|
Application
|
|
|
ManagedIdentity
|
|
|
Key
|
|
ErrorAdditionalInfo
Object
資源管理錯誤其他資訊。
| 名稱 |
類型 |
Description |
|
info
|
object
|
其他資訊。
|
|
type
|
string
|
其他信息類型。
|
ErrorDetail
Object
錯誤詳細資料。
ErrorResponse
Object
錯誤回應
ParameterApplyMethod
列舉型別
控制動態參數變更何時生效。 靜態參數變更總是在客戶發起的池子重新啟動後才生效。 停止後接啟動,排程維護不會套用待處理的參數變更。
| 值 |
Description |
|
Immediate
|
立即套用動態參數變更。 靜態參數變更將持續待處理,直到客戶發起的池子重新啟動。
|
|
PendingReboot
|
將動態與靜態參數變更保持待處理,直到客戶發起的池重新啟動。 停機後接開始,定期維護則不適用。
|
ParameterGroupSyncStatus
列舉型別
顯示 HorizonDB 資源與其參數群組之間的同步狀態。
| 值 |
Description |
|
Applying
|
參數更新目前正在進行中。
|
|
InSync
|
參數值已同步且保持最新。
|
|
FailedToApply
|
套用參數更新失敗。
|
|
PendingReboot
|
參數更新正在等待中,需由客戶發起的池重啟才能生效。 停止接著啟動,定期保養則保持此狀態。
|
Pool
Object
代表 HorizonDB 池。
| 名稱 |
類型 |
Description |
|
id
|
string
(arm-id)
|
資源的完整資源標識碼。 例如,“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
|
|
name
|
string
|
資源的名稱
|
|
properties
|
PoolProperties
|
此資源的資源特定屬性。
|
|
systemData
|
systemData
|
包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
|
|
tags
|
object
|
資源標籤。
|
|
type
|
string
|
資源的類型。 例如:「Microsoft.Compute/virtualMachines」或「Microsoft.Storage/storageAccounts」
|
PoolComputeModel
Object
HorizonDB 池的計算模型。
| 名稱 |
類型 |
Description |
|
computeGeneration
|
integer
(int32)
minimum: 1
|
計算模型的計算產生。
|
|
computeProcessor
|
ComputeProcessorType
|
計算模型的處理器類型。
|
|
type
|
PoolComputeModelType
|
計算模型的類型。
|
|
vCores
|
integer
(int32)
minimum: 2 maximum: 192
|
虛擬核心數目。 允許的數值為1到192。
|
PoolComputeModelForPatchUpdate
Object
HorizonDB 池的計算模型屬性,可以隨時更新。 物件是遞迴合併的:省略的屬性會保留其當前值。 不適用於目前或目標計算模型類型的屬性會被拒絕。 當型別改變時,請求必須包含完整的目標計算模型。 針對子型別的限制條件會根據有效合併配置進行驗證;無效請求會被拒絕,且不更改資源。
| 名稱 |
類型 |
Description |
|
computeGeneration
|
integer
(int32)
minimum: 1
|
計算模型的計算產生。 省略則保留目前的計算產生。
|
|
computeProcessor
|
ComputeProcessorType
|
計算模型的處理器類型。 省略則保留目前的處理器類型。
|
|
type
|
PoolComputeModelType
|
計算模型類型。 省略此屬性以保留目前的類型。 重新提交當前型態作為冪 no-op成功。 要更改類型,請提供所有共同屬性及目標類型所需的所有屬性。
|
|
vCores
|
integer
(int32)
minimum: 2 maximum: 192
|
已配置的 vCore 數量。 允許的數值為1到192。 此特性僅適用於配置計算模型。 省略則保留當前值。
|
PoolComputeModelType
列舉型別
計算模型類型。
| 值 |
Description |
|
Provisioned
|
配置運算模型
|
PoolForPatchUpdate
Object
用於更新操作的 HorizonDB 池。
PoolHighAvailability
Object
HorizonDB 池的高可用性配置。
| 名稱 |
類型 |
Description |
|
mode
|
PoolHighAvailabilityMode
|
高可用性模式。 當 nodeCount 為 1 時,必須停用。 當節點計數為 2 到 16 時,需要使用 AnyZone 或 ZoneRedundant。
|
PoolHighAvailabilityMode
列舉型別
高可用性模式要求 HorizonDB 池。
| 值 |
Description |
|
Disabled
|
高可用性被關閉。 此模式僅在 nodeCount 為 1 時有效。
|
|
AnyZone
|
服務可在同一可用性區域內分配節點,或跨越多個可用性區域。 此模式僅在 nodeCount 為 2 到 16 時有效。
|
|
ZoneRedundant
|
服務必須在可用區域間分配節點。 此模式僅在 nodeCount 為 2 到 16 時有效。
|
PoolHighAvailabilityPatch
Object
HorizonDB 池更新的高可用性配置。
PoolParameterGroupReference
Object
參考與 HorizonDB 池相關的參數群組。 該架構代表預設與客戶建立的參數群組,以促進建立與更新相容性。 在此 API 版本中,初始建立池僅接受對應的預設參數群組;對現有池的 PUT 更新可關聯任一群組類型。
| 名稱 |
類型 |
Description |
|
applyMethod
|
ParameterApplyMethod
|
判斷相關參數群組動態參數變更何時生效。 靜態參數變更總是需要客戶主動啟動池,不論這個值為何。 停止後接啟動,排程維護不會套用待處理的參數變更。
|
|
parameterGroupResourceId
|
string
(arm-id)
|
相關參數群組的 Azure 資源 ID。 此 API 版本的初始池建立需要對應的 Microsoft。HorizonDb/locations/parameterGroups 資源。 對於現有的池,PUT 可以指定對應的預設群組,或是客戶自行建立的 Microsoft。HorizonDb/parameterGroups 資源。
|
|
syncStatus
|
ParameterGroupSyncStatus
|
池與其參數群組之間的同步狀態。 待處理重啟的變更在停止、啟動及排程維護中持續進行,且僅在客戶主動啟動重新啟動後生效。
|
PoolParameterGroupReferenceForPatchUpdate
Object
一個用於更新現有 HorizonDB 池的參數群組參考。 該池可在對應的預設參數群組與客戶建立的參數群組間切換。
| 名稱 |
類型 |
Description |
|
applyMethod
|
ParameterApplyMethod
|
判斷相關參數群組動態參數變更何時生效。 靜態參數變更總是需要客戶主動啟動池,不論這個值為何。 停止後接啟動,排程維護不會套用待處理的參數變更。
|
|
parameterGroupResourceId
|
string
(arm-id)
|
將對應的預設或客戶建立參數群組的 Azure 資源 ID,與現有池相關聯。
|
PoolProperties
Object
HorizonDB 池的特性。
| 名稱 |
類型 |
Description |
|
computeModel
|
PoolComputeModel
|
HorizonDB 池所需的計算模型。
|
|
highAvailability
|
PoolHighAvailability
|
池所需的高可用性配置。 當 nodeCount 為 1 時,模式必須被停用;當 nodeCount 為 2 到 16 時,必須是 AnyZone 或 ZoneRedundant。
|
|
nodeCount
|
integer
(int32)
minimum: 1 maximum: 16
|
分配並指派到池中所需的節點數量。 允許的數值為1到16。 若要解除執行時運算而不改變已設定的節點數量,請停止池。
|
|
parameterGroup
|
PoolParameterGroupReference
|
與池相關聯的必要參數群組。 在此 API 版本建立新池時,呼叫者必須提供對應的預設參數群組;建立時不接受客戶建立的參數群組。 對於現有的池,PUT 或 PATCH 可以關聯對應的預設參數群組或客戶建立的參數群組。 建立可見的 shape 刻意支援兩種資源 ID 表單,因此未來的 API 版本能允許客戶在建立時建立參數群組,且不會破壞結構變更。
|
|
provisioningState
|
ProvisioningState
|
池的配置狀態。
|
|
scheduledMaintenance
|
ScheduledMaintenanceProperties:
SystemScheduledMaintenanceProperties
|
泳池的定期維護配置。 可選擇的物業取決於所選的維護管理類型。
|
|
state
|
PoolState
|
泳池目前狀況。
|
PoolPropertiesForPatchUpdate
Object
HorizonDB 更新操作池的特性。
PoolState
列舉型別
HorizonDB 池的現況。
| 值 |
Description |
|
Ready
|
已準備好並運作
|
|
Provisioning
|
正在進行配置
|
|
Deleting
|
正在被刪除
|
|
Inaccessible
|
無法進入
|
|
Updating
|
正在更新中
|
|
Starting
|
正在啟動
|
|
Restarting
|
正在重新啟動
|
|
Stopping
|
正在停止
|
|
Stopped
|
停止了
|
ProvisioningState
列舉型別
布建狀態。
| 值 |
Description |
|
Succeeded
|
資源已建立。
|
|
Failed
|
資源建立失敗。
|
|
Canceled
|
資源建立已取消。
|
|
InProgress
|
HorizonDB 的資源操作正在積極執行。
|
|
Provisioning
|
HorizonDB 資源仍在配置中。
|
ScheduledMaintenanceManagementType
列舉型別
指定誰負責管理 HorizonDB 池的定期維護。
| 值 |
Description |
|
System
|
系統會管理定期維護。
|
ScheduledMaintenancePropertiesForPatchUpdate
Object
池更新作業的預定維護配置。
systemData
Object
與建立和上次修改資源相關的元數據。
| 名稱 |
類型 |
Description |
|
createdAt
|
string
(date-time)
|
資源建立的時間戳(UTC)。
|
|
createdBy
|
string
|
建立此資源的身分。
|
|
createdByType
|
createdByType
|
建立此資源的身分識別類型。
|
|
lastModifiedAt
|
string
(date-time)
|
上次修改的資源時間戳 (UTC)
|
|
lastModifiedBy
|
string
|
上次修改資源的身分識別。
|
|
lastModifiedByType
|
createdByType
|
上次修改資源的身分識別類型。
|
SystemScheduledMaintenanceProperties
Object
HorizonDB 池的系統管理排程維護設定。 必須不包含使用者管理的排程屬性。
| 名稱 |
類型 |
Description |
|
maintenanceManagementType
|
string:
System
|
規定排程維護是由系統管理還是由使用者管理。
|