Clusters - Create Or Replace

建立新的 HorizonDB 叢集或替換現有叢集。 PointInTimeRestore 建立新的叢集資源,並從可用來源備份中水合其服務擁有的資料庫儲存。 它不會複製來源池、池範圍端點、防火牆規則、參數群組關聯或其他子資源。 新叢集會接收其服務生成的叢集範圍端點,稱為叢集。 對於還原,postgreSqlVersion 必須省略,因為服務是從備份元資料取得;其他所有新叢集配置則來自請求或服務預設。 同地點還原需要並遵守 pointInTimeUTC,並允許省略 creationSourceClusterLocation。 跨地點還原需要 creationSourceClusterLocation 來識別來源叢集的 Azure 位置,並使用 pointInTimeUtc,但會忽略所提供的時間戳記並還原最新的可用備份。 跨地點回應省略 pointInTimeUtc。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HorizonDb/clusters/{clusterName}?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 叢集的名稱。

resourceGroupName
path True

string

minLength: 1
maxLength: 90

資源群組的名稱。 名稱不區分大小寫。

subscriptionId
path True

string (uuid)

目標訂用帳戶的標識碼。 此值必須是 UUID。

api-version
query True

string

minLength: 1

用於此作業的 API 版本。

要求本文

名稱 必要 類型 Description
location True

string

資源所在的地理位置

identity

HorizonDbClusterManagedServiceIdentity

指派給此資源的受控服務識別。 省略 PUT 或 PATCH 中的整個身份屬性,可保留所有當前指派。 在提供時,PUT 會替換使用者指派的身份集,PATCH 會合併;空 PATCH 字典項目會移除個別身份。 將類型設為 None 會清除所有指派。

properties

ClusterProperties

此資源的資源特定屬性。

tags

object

資源標籤。

回覆

名稱 類型 Description
200 OK

Cluster

當接受非同步 HorizonDB 叢集替換時,回應會回傳。

標題

  • Azure-AsyncOperation: string
  • Retry-After: integer
201 Created

Cluster

當接受非同步 HorizonDB 叢集建立時,回應會回傳。

標題

  • Azure-AsyncOperation: 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 冒用您的使用者帳戶

範例

Create a HorizonDB cluster with customer-managed key data encryption
Create a PostgreSQL 18 HorizonDB cluster with minimum configuration and service defaults
Create or replace a HorizonDB cluster
Restore a HorizonDB cluster across Azure regions from the latest available backup
Restore a HorizonDB cluster to a point in time

Create a HorizonDB cluster with customer-managed key data encryption

範例要求

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster?api-version=2026-10-01-preview

{
  "location": "eastus2",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/identity-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/primary-encryption-identity": {}
    }
  },
  "properties": {
    "postgreSqlVersion": "17",
    "backup": {
      "geoRedundancy": "Disabled",
      "retentionDays": 14
    },
    "dataEncryption": {
      "type": "AzureKeyVault",
      "primaryKeyUri": "https://primary-key-vault.vault.azure.net/keys/horizondb-primary-key",
      "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/identity-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/primary-encryption-identity"
    }
  }
}

範例回覆

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationStatuses/11111111-1111-1111-1111-111111111111?api-version=2026-10-01-preview
Retry-After: 30
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster",
  "name": "example-cluster",
  "type": "Microsoft.HorizonDb/clusters",
  "location": "eastus2",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/identity-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/primary-encryption-identity": {
        "principalId": "11111111-1111-1111-1111-111111111111",
        "clientId": "22222222-2222-2222-2222-222222222222"
      }
    }
  },
  "properties": {
    "postgreSqlVersion": "17",
    "creationMode": "Create",
    "network": {
      "publicAccess": "Disabled"
    },
    "backup": {
      "geoRedundancy": "Disabled",
      "retentionDays": 14
    },
    "dataEncryption": {
      "type": "AzureKeyVault",
      "primaryKeyUri": "https://primary-key-vault.vault.azure.net/keys/horizondb-primary-key",
      "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/identity-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/primary-encryption-identity",
      "primaryEncryptionKeyStatus": "Valid",
      "primaryEncryptionKeyCurrentVersion": "33333333333333333333333333333333"
    },
    "state": "Updating",
    "provisioningState": "InProgress",
    "readWritePool": {}
  }
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationStatuses/11111111-1111-1111-1111-111111111111?api-version=2026-10-01-preview
Retry-After: 30
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster",
  "name": "example-cluster",
  "type": "Microsoft.HorizonDb/clusters",
  "location": "eastus2",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/identity-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/primary-encryption-identity": {
        "principalId": "11111111-1111-1111-1111-111111111111",
        "clientId": "22222222-2222-2222-2222-222222222222"
      }
    }
  },
  "properties": {
    "postgreSqlVersion": "17",
    "creationMode": "Create",
    "network": {
      "publicAccess": "Disabled"
    },
    "backup": {
      "geoRedundancy": "Disabled",
      "retentionDays": 14
    },
    "dataEncryption": {
      "type": "AzureKeyVault",
      "primaryKeyUri": "https://primary-key-vault.vault.azure.net/keys/horizondb-primary-key",
      "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/identity-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/primary-encryption-identity",
      "primaryEncryptionKeyStatus": "Valid",
      "primaryEncryptionKeyCurrentVersion": "33333333333333333333333333333333"
    },
    "state": "Provisioning",
    "provisioningState": "Provisioning",
    "readWritePool": {}
  }
}

Create a PostgreSQL 18 HorizonDB cluster with minimum configuration and service defaults

範例要求

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/minimum-defaults?api-version=2026-10-01-preview

{
  "location": "eastus2",
  "properties": {
    "postgreSqlVersion": "18",
    "backup": {
      "geoRedundancy": "Disabled"
    }
  }
}

範例回覆

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationStatuses/55555555-5555-5555-5555-555555555555?api-version=2026-10-01-preview
Retry-After: 30
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/minimum-defaults",
  "name": "minimum-defaults",
  "type": "Microsoft.HorizonDb/clusters",
  "location": "eastus2",
  "properties": {
    "postgreSqlVersion": "18",
    "creationMode": "Create",
    "network": {
      "publicAccess": "Disabled"
    },
    "backup": {
      "geoRedundancy": "Disabled",
      "retentionDays": 7
    },
    "state": "Updating",
    "provisioningState": "InProgress",
    "readWritePool": {}
  }
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationStatuses/55555555-5555-5555-5555-555555555555?api-version=2026-10-01-preview
Retry-After: 30
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/minimum-defaults",
  "name": "minimum-defaults",
  "type": "Microsoft.HorizonDb/clusters",
  "location": "eastus2",
  "properties": {
    "postgreSqlVersion": "18",
    "creationMode": "Create",
    "network": {
      "publicAccess": "Disabled"
    },
    "backup": {
      "geoRedundancy": "Disabled",
      "retentionDays": 7
    },
    "state": "Provisioning",
    "provisioningState": "Provisioning",
    "readWritePool": {}
  }
}

Create or replace a HorizonDB cluster

範例要求

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster?api-version=2026-10-01-preview

{
  "location": "eastus2",
  "tags": {
    "environment": "production"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/identity-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/fabric-writer": {}
    }
  },
  "properties": {
    "postgreSqlVersion": "17",
    "network": {
      "publicAccess": "Enabled"
    },
    "backup": {
      "geoRedundancy": "Enabled",
      "retentionDays": 14
    }
  }
}

範例回覆

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationStatuses/44444444-4444-4444-4444-444444444444?api-version=2026-10-01-preview
Retry-After: 30
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster",
  "name": "example-cluster",
  "type": "Microsoft.HorizonDb/clusters",
  "location": "eastus2",
  "tags": {
    "environment": "production"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/identity-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/fabric-writer": {
        "principalId": "11111111-1111-1111-1111-111111111111",
        "clientId": "22222222-2222-2222-2222-222222222222"
      }
    }
  },
  "properties": {
    "postgreSqlVersion": "17",
    "creationMode": "Create",
    "network": {
      "publicAccess": "Enabled"
    },
    "backup": {
      "geoRedundancy": "Enabled",
      "retentionDays": 14,
      "earliestRestorePointUtc": "2026-07-27T02:00:00Z"
    },
    "state": "Updating",
    "provisioningState": "InProgress",
    "readWritePool": {
      "designatedPoolResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster/pools/example-pool-01"
    }
  }
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationStatuses/11111111-1111-1111-1111-111111111111?api-version=2026-10-01-preview
Retry-After: 30
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/example-cluster",
  "name": "example-cluster",
  "type": "Microsoft.HorizonDb/clusters",
  "location": "eastus2",
  "tags": {
    "environment": "production"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/identity-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/fabric-writer": {
        "principalId": "11111111-1111-1111-1111-111111111111",
        "clientId": "22222222-2222-2222-2222-222222222222"
      }
    }
  },
  "properties": {
    "postgreSqlVersion": "17",
    "creationMode": "Create",
    "network": {
      "publicAccess": "Enabled"
    },
    "backup": {
      "geoRedundancy": "Enabled",
      "retentionDays": 14,
      "earliestRestorePointUtc": "2026-07-27T02:00:00Z"
    },
    "state": "Provisioning",
    "provisioningState": "Provisioning",
    "readWritePool": {}
  }
}

Restore a HorizonDB cluster across Azure regions from the latest available backup

範例要求

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/cross-region-restored-cluster?api-version=2026-10-01-preview

{
  "location": "westus2",
  "properties": {
    "creationMode": "PointInTimeRestore",
    "pointInTimeUtc": "2026-07-27T12:00:00Z",
    "creationSourceClusterResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/source-cluster",
    "creationSourceClusterLocation": "eastus2",
    "network": {
      "publicAccess": "Disabled"
    },
    "backup": {
      "geoRedundancy": "Enabled",
      "retentionDays": 14
    }
  }
}

範例回覆

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/westus2/operationStatuses/44444444-4444-4444-4444-444444444444?api-version=2026-10-01-preview
Retry-After: 30
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/cross-region-restored-cluster",
  "name": "cross-region-restored-cluster",
  "type": "Microsoft.HorizonDb/clusters",
  "location": "westus2",
  "properties": {
    "postgreSqlVersion": "17",
    "creationMode": "PointInTimeRestore",
    "creationSourceClusterResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/source-cluster",
    "creationSourceClusterLocation": "eastus2",
    "network": {
      "publicAccess": "Disabled"
    },
    "backup": {
      "geoRedundancy": "Enabled",
      "retentionDays": 14
    },
    "state": "Provisioning",
    "provisioningState": "Provisioning",
    "readWritePool": {}
  }
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/westus2/operationStatuses/44444444-4444-4444-4444-444444444444?api-version=2026-10-01-preview
Retry-After: 30
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/cross-region-restored-cluster",
  "name": "cross-region-restored-cluster",
  "type": "Microsoft.HorizonDb/clusters",
  "location": "westus2",
  "properties": {
    "postgreSqlVersion": "17",
    "creationMode": "PointInTimeRestore",
    "creationSourceClusterResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/source-cluster",
    "creationSourceClusterLocation": "eastus2",
    "network": {
      "publicAccess": "Disabled"
    },
    "backup": {
      "geoRedundancy": "Enabled",
      "retentionDays": 14
    },
    "state": "Provisioning",
    "provisioningState": "Provisioning",
    "readWritePool": {}
  }
}

Restore a HorizonDB cluster to a point in time

範例要求

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/restored-cluster?api-version=2026-10-01-preview

{
  "location": "eastus2",
  "properties": {
    "creationMode": "PointInTimeRestore",
    "pointInTimeUtc": "2026-07-27T12:00:00Z",
    "creationSourceClusterResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/source-cluster",
    "network": {
      "publicAccess": "Disabled"
    },
    "backup": {
      "geoRedundancy": "Enabled",
      "retentionDays": 14
    }
  }
}

範例回覆

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationStatuses/33333333-3333-3333-3333-333333333333?api-version=2026-10-01-preview
Retry-After: 30
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/restored-cluster",
  "name": "restored-cluster",
  "type": "Microsoft.HorizonDb/clusters",
  "location": "eastus2",
  "properties": {
    "postgreSqlVersion": "17",
    "creationMode": "PointInTimeRestore",
    "pointInTimeUtc": "2026-07-27T12:00:00Z",
    "creationSourceClusterResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/source-cluster",
    "network": {
      "publicAccess": "Disabled"
    },
    "backup": {
      "geoRedundancy": "Enabled",
      "retentionDays": 14
    },
    "state": "Provisioning",
    "provisioningState": "Provisioning",
    "readWritePool": {}
  }
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/operationStatuses/33333333-3333-3333-3333-333333333333?api-version=2026-10-01-preview
Retry-After: 30
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/restored-cluster",
  "name": "restored-cluster",
  "type": "Microsoft.HorizonDb/clusters",
  "location": "eastus2",
  "properties": {
    "postgreSqlVersion": "17",
    "creationMode": "PointInTimeRestore",
    "pointInTimeUtc": "2026-07-27T12:00:00Z",
    "creationSourceClusterResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/clusters/source-cluster",
    "network": {
      "publicAccess": "Disabled"
    },
    "backup": {
      "geoRedundancy": "Enabled",
      "retentionDays": 14
    },
    "state": "Provisioning",
    "provisioningState": "Provisioning",
    "readWritePool": {}
  }
}

定義

名稱 Description
AiModelManagementStatus

HorizonDB 叢集的 AI 模型管理狀態。

BackupProperties

HorizonDB 叢集的備份設定屬性。

Cluster

代表 HorizonDB 叢集。

ClusterCreateMode

控制 HorizonDB 叢集 PUT 請求的處理方式。

ClusterProperties

HorizonDB 叢集的特性。

ClusterState

HorizonDB 叢集的現況。

createdByType

建立此資源的身分識別類型。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細資料。

ErrorResponse

錯誤回應

GeoRedundancyState

表示地理冗餘狀態。

HorizonDbClusterDataEncryption

叢集層級的資料加密配置。 加密類型是在叢集建立時選擇;建立後不支援在 SystemManaged 與 AzureKeyVault 之間切換。 對於 AzureKeyVault 加密,必須使用 primaryKeyUri 和 primaryUserAssignedIdentityId,且 backup.geoRedundancy 必須被停用。 primaryKeyUri 與 primaryUserAssignedIdentityID 皆可在初始叢集建立時提供。 透過 PUT 或 PATCH 更新現有叢集時,每次請求只能更改其中一個屬性,且該更新必須完成後才能提交另一個屬性的獨立更新。 客戶管理的金鑰身份也必須透過叢集的頂層身份屬性分配給叢集。 僅支援無版本的 Azure Key Vault 金鑰 URI;金鑰版本路徑會被拒絕。 對於 SystemManaged 加密,必須省略金鑰與身份屬性。

HorizonDbClusterDataEncryptionType

HorizonDB 叢集所使用的資料加密類型。 該類型是在叢集建立時選擇的;建立後不支援在 SystemManaged 與 AzureKeyVault 之間切換。

HorizonDbClusterEncryptionKeyStatus

HorizonDB 叢集所使用的客戶管理加密金鑰的驗證狀態。

HorizonDbClusterIdentityType

HorizonDB 叢集所支援的管理身份類型。

HorizonDbClusterManagedServiceIdentity

使用者指派的管理身份分配給 HorizonDB 叢集。 省略 PUT 或 PATCH 的整個頂層身份屬性,可保留所有當前指派。 當 userAssignedIdentities 被提供時,PUT 會替換完整集合,PATCH 則將所提供的條目與現有集合合併;空 PATCH 條目則移除該單一身份。 將類型設為 None 會清除所有指派。 移除由變更資料擷取身份指派所參考的身份會被拒絕,直到該引用指派被刪除為止。

Network

網路屬性。

PostgreSqlVersion

由 HorizonDB 支援的 PostgreSQL 主要版本。 API 版本 2026-10-01-preview 接受 17 和 18。 未來的 API 版本可能會新增命名值,且用戶端必須容忍服務回傳的未知值。

ProvisioningState

布建狀態。

PublicNetworkAccessState

指示是否啟用公共網路訪問。

ReadWritePoolProperties

目前指定為 HorizonDB 叢集的讀寫節點的池。 當叢集目前沒有池時建立池,服務會自動指定新池為讀寫池。 此行為在叢集早期存在的所有池子都被刪除後同樣適用。

systemData

與建立和上次修改資源相關的元數據。

UserAssignedIdentity

使用者指派的身分識別屬性

AiModelManagementStatus

HorizonDB 叢集的 AI 模型管理狀態。

值 Description
Enabled

已啟用 AI 模型管理。

Disabled

AI 模型管理已被關閉。

BackupProperties

HorizonDB 叢集的備份設定屬性。

名稱 類型 預設值 Description
earliestRestorePointUtc

string (date-time)

目前叢集可恢復的最早時間點,UTC。

geoRedundancy

GeoRedundancyState

地理冗餘狀態。 當 dataEncryption.type 是 AzureKeyVault 時,不支援地理冗餘備份。

retentionDays

integer (int32)

minimum: 1
maximum: 35
7

自動備份保留的天數。 當此屬性被省略時,服務預設為7天。

Cluster

代表 HorizonDB 叢集。

名稱 類型 Description
id

string (arm-id)

資源的完整資源標識碼。 例如,“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

identity

HorizonDbClusterManagedServiceIdentity

指派給此資源的受控服務識別。 省略 PUT 或 PATCH 中的整個身份屬性,可保留所有當前指派。 在提供時,PUT 會替換使用者指派的身份集,PATCH 會合併;空 PATCH 字典項目會移除個別身份。 將類型設為 None 會清除所有指派。

location

string

資源所在的地理位置

name

string

資源的名稱

properties

ClusterProperties

此資源的資源特定屬性。

systemData

systemData

包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。

tags

object

資源標籤。

type

string

資源的類型。 例如:「Microsoft.Compute/virtualMachines」或「Microsoft.Storage/storageAccounts」

ClusterCreateMode

控制 HorizonDB 叢集 PUT 請求的處理方式。

值 Description
Create

將請求處理為正常叢集建立。

PointInTimeRestore

從時間點還原建立叢集。

ClusterProperties

HorizonDB 叢集的特性。

名稱 類型 Description
aiModelManagement

AiModelManagementStatus

指定叢集是否啟用 AI 模型管理。

backup

BackupProperties

叢集的備用設定。

creationMode

ClusterCreateMode

建立叢集的模式。 當建立新叢集時省略此屬性,服務會記錄 Create。 PointInTimeRestore 從可用備份建立新叢集;因此需要 pointInTimeUtc 和 creationSourceClusterResourceId,postgreSqlVersion 必須省略,因為 postgreSqlVersion 是從備份中繼資料取得,且當來源與目標叢集位置不同時,則需要 creationSourceClusterLocation。 此屬性不可更改,並以創造來源(creation provenance)形式返回。 替換時,遺漏保留記錄值,重新提交相同值則被接受,變更則被拒絕。

creationSourceClusterLocation

string

用於點點還原的 HorizonDB 原始叢集的 Azure 位置。 當來源與目標叢集位置相同時,此特性為可選。 當來源叢集位置與目標叢集位置不同時,必須識別來源叢集的位置。 此屬性在 PointInTimeRestore 以外的創建模式或省略 creationMode 時必須不存在。 這種不可改變的創作來源價值在創造後不會改變。

creationSourceClusterResourceId

string (arm-id)

選取建立模式所使用的來源 HorizonDB 叢集的 Azure 資源 ID。 此屬性是 PointInTimeRestore 及其他基於原始碼的建立模式所必需的,且在創建或省略 creationMode 時必須缺席。 只要有可用的備份,來源叢集就不需要有池可以還原。 這種不可改變的創作來源價值在創造後不會改變。

dataEncryption

HorizonDbClusterDataEncryption

叢集的資料加密配置。 當初始叢集建立時省略此功能,服務則使用 SystemManaged 加密。 在初始叢集建立時提供時,則需要類型。 對於現有叢集的 PUT 更新,類型可以省略;若提供,必須與現有加密類型相符。 加密類型是在叢集建立時選擇;建立後不支援在 SystemManaged 與 AzureKeyVault 之間切換。

network

Network

叢集的網路配置。 當這個物件被省略時,服務會預設為 publicAccess Disabled。

pointInTimeUtc

string (date-time)

請求的時間點,也就是世界協調時間。 這個屬性是每個 PointInTimeRestore 請求中必不可少的。 對於同一地點還原,服務會還原該值或之前的最新備份。 對於跨地點還原,服務要求但忽略此值,並還原最新的可用備份;跨地點回應則省略此特性。 此特性在其他創建模式或 creationMode 省略且只能在資源建立時指定時必須不具備。

postgreSqlVersion

PostgreSqlVersion

HorizonDB 叢集所使用的 PostgreSQL 主要版本。 API 版本 2026-10-01-preview 支援版本 17 與 18。 一般叢集建立時,該版本會在請求中提供,且建立後不可更改。 對於點點還原,服務會從來源備份的中繼資料取得版本,而請求必須省略此特性。 此 API 版本不支援原地 PostgreSQL 主版本升級。

provisioningState

ProvisioningState

叢集的佈建狀態。

readWritePool

ReadWritePoolProperties

目前指定為叢集的讀寫節點的儲存池。

state

ClusterState

集群目前狀況。

ClusterState

HorizonDB 叢集的現況。

值 Description
Ready

已準備好並運作

Provisioning

正在進行配置

Deleting

正在被刪除

Inaccessible

無法進入

Updating

正在更新中

createdByType

建立此資源的身分識別類型。

值 Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細資料。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤的其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳情

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

GeoRedundancyState

表示地理冗餘狀態。

值 Description
Enabled

地理冗餘已啟用。 當 dataEncryption.type 為 AzureKeyVault 時,此值不被支援。

Disabled

地理冗餘已被禁用

HorizonDbClusterDataEncryption

叢集層級的資料加密配置。 加密類型是在叢集建立時選擇;建立後不支援在 SystemManaged 與 AzureKeyVault 之間切換。 對於 AzureKeyVault 加密,必須使用 primaryKeyUri 和 primaryUserAssignedIdentityId,且 backup.geoRedundancy 必須被停用。 primaryKeyUri 與 primaryUserAssignedIdentityID 皆可在初始叢集建立時提供。 透過 PUT 或 PATCH 更新現有叢集時,每次請求只能更改其中一個屬性,且該更新必須完成後才能提交另一個屬性的獨立更新。 客戶管理的金鑰身份也必須透過叢集的頂層身份屬性分配給叢集。 僅支援無版本的 Azure Key Vault 金鑰 URI;金鑰版本路徑會被拒絕。 對於 SystemManaged 加密,必須省略金鑰與身份屬性。

名稱 類型 Description
primaryEncryptionKeyCurrentVersion

string

叢集目前使用的主要加密金鑰版本。 此屬性用於 AzureKeyVault 加密,而 SystemManaged 加密則不存在。

primaryEncryptionKeyStatus

HorizonDbClusterEncryptionKeyStatus

主要加密金鑰的驗證狀態。 此屬性用於 AzureKeyVault 加密,而 SystemManaged 加密則不存在。

primaryKeyUri

string (uri)

pattern: ^https://[A-Za-z0-9-]+[.]vault([.]azure[.]net|[.]usgovcloudapi[.]net|[.]azure[.]cn)/keys/[A-Za-z0-9-]+/?$

無版本的 Azure Key Vault 金鑰 URI 用來加密叢集的主要儲存裝置。 不支援金鑰版本路徑。 在初始叢集建立時,此屬性可與 primaryUserAssignedIdentityID 一同提供。 對於透過 PUT 或 PATCH 對現有叢集的更新,這個屬性與 primaryUserAssignedIdentityID 不能同時在同一請求中同時變更;第一次更新必須完成,才能為另一個屬性提交獨立更新。

primaryUserAssignedIdentityId

string (arm-id)

使用者指派管理身份的 Azure 資源 ID,用於存取主要加密金鑰。 身份也必須透過叢集的頂層身份屬性被指派給叢集。 在初始叢集建立時,此特性可與 primaryKeyUri 一同提供。 對於透過 PUT 或 PATCH 更新現有叢集時,這個屬性和 primaryKeyUri 不能在同一請求中同時變更;第一次更新必須完成,才能為另一個屬性提交獨立更新。

type

HorizonDbClusterDataEncryptionType

叢集所使用的資料加密類型。 當資料加密配置在初始叢集建立時提供時,此特性是必需的。 對於現有叢集的 PUT 更新,可以省略此特性;若提供,必須與現有加密類型相符。 此值在叢集建立時選擇,之後無法從 SystemManaged 改為 AzureKeyVault,或從 AzureKeyVault 改為 SystemManaged。

HorizonDbClusterDataEncryptionType

HorizonDB 叢集所使用的資料加密類型。 該類型是在叢集建立時選擇的;建立後不支援在 SystemManaged 與 AzureKeyVault 之間切換。

值 Description
SystemManaged

資料加密由 Azure 使用平台管理金鑰管理。

AzureKeyVault

資料加密使用客戶管理的金鑰,存放在 Azure Key Vault 中。

HorizonDbClusterEncryptionKeyStatus

HorizonDB 叢集所使用的客戶管理加密金鑰的驗證狀態。

值 Description
Valid

加密金鑰是有效且可被設定的使用者指派管理身份存取的。

Invalid

加密金鑰對已設定的使用者指派管理身份來說無效或無法存取。

HorizonDbClusterIdentityType

HorizonDB 叢集所支援的管理身份類型。

值 Description
None

沒有被指派管理身份。 將類型設為 None 會清除所有受管理身份指派。

UserAssigned

使用者指派的受管理身份會被指派。

HorizonDbClusterManagedServiceIdentity

使用者指派的管理身份分配給 HorizonDB 叢集。 省略 PUT 或 PATCH 的整個頂層身份屬性,可保留所有當前指派。 當 userAssignedIdentities 被提供時,PUT 會替換完整集合,PATCH 則將所提供的條目與現有集合合併;空 PATCH 條目則移除該單一身份。 將類型設為 None 會清除所有指派。 移除由變更資料擷取身份指派所參考的身份會被拒絕,直到該引用指派被刪除為止。

名稱 類型 Description
type

HorizonDbClusterIdentityType

分配給叢集的管理身份類型。 將此屬性設為 None 後,所有受管理身份指派都會被清除。

userAssignedIdentities

<string,  UserAssignedIdentity>

使用者指派的管理身份與叢集相關聯。 當 PUT 提供時,此字典會替換完整的指派集合。 當 PATCH 提供時,條目會與現有集合合併,空值則移除對應的身份。 每個字典鍵必須是 Microsoft 的完整 Azure 資源 ID。ManagedIdentity/userAssignedIdentities 資源。 非空請求值可以是空物件;回應值包含服務填充的 clientID 和 principalId。 指派身份並不代表能存取目的地資源;所需的角色指派必須另外設定。

Network

網路屬性。

名稱 類型 預設值 Description
publicAccess

PublicNetworkAccessState

Disabled

指定叢集是否啟用公開存取。 當此屬性被省略時,服務會預設為 Disabled。

PostgreSqlVersion

由 HorizonDB 支援的 PostgreSQL 主要版本。 API 版本 2026-10-01-preview 接受 17 和 18。 未來的 API 版本可能會新增命名值,且用戶端必須容忍服務回傳的未知值。

值 Description
17

PostgreSQL 主要版本 17。

18

PostgreSQL 主要版本 18。

ProvisioningState

布建狀態。

值 Description
Succeeded

資源已建立。

Failed

資源建立失敗。

Canceled

資源建立已取消。

InProgress

HorizonDB 的資源操作正在積極執行。

Provisioning

HorizonDB 資源仍在配置中。

PublicNetworkAccessState

指示是否啟用公共網路訪問。

值 Description
Enabled

已啟用公共網路存取

Disabled

公共網路存取被停用

ReadWritePoolProperties

目前指定為 HorizonDB 叢集的讀寫節點的池。 當叢集目前沒有池時建立池,服務會自動指定新池為讀寫池。 此行為在叢集早期存在的所有池子都被刪除後同樣適用。

名稱 類型 Description
designatedPoolResourceId

string (arm-id)

指定用於主機叢集讀寫節點的 Azure 資源 ID。 這個池塘是這個群組的子資源。 當叢集目前沒有池時建立池,服務會自動將此屬性設定為新池的資源 ID,包括當叢集生命週期早期存在的所有池池被刪除時。 當沒有指定池時,例如 clearReadWritePool 成功後,這個屬性就不存在。

systemData

與建立和上次修改資源相關的元數據。

名稱 類型 Description
createdAt

string (date-time)

資源建立的時間戳(UTC)。

createdBy

string

建立此資源的身分。

createdByType

createdByType

建立此資源的身分識別類型。

lastModifiedAt

string (date-time)

上次修改的資源時間戳 (UTC)

lastModifiedBy

string

上次修改資源的身分識別。

lastModifiedByType

createdByType

上次修改資源的身分識別類型。

UserAssignedIdentity

使用者指派的身分識別屬性

名稱 類型 Description
clientId

string (uuid)

指派之身分識別的用戶端標識碼。

principalId

string (uuid)

指派之身分識別的主體標識碼。