Microsoft.DBforPostgreSQL serverGroupsv2 2023-03-02-preview
Bicep 資源定義
serverGroupsv2 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DBforPostgreSQL/serverGroupsv2 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
administratorLoginPassword: 'string'
authConfig: {
activeDirectoryAuth: 'string'
passwordAuth: 'string'
}
citusVersion: 'string'
coordinatorEnablePublicIpAccess: bool
coordinatorServerEdition: 'string'
coordinatorStorageQuotaInMb: int
coordinatorVCores: int
databaseName: 'string'
dataEncryption: {
primaryKeyUri: 'string'
primaryUserAssignedIdentityId: 'string'
type: 'string'
}
enableGeoBackup: bool
enableHa: bool
enableShardsOnCoordinator: bool
maintenanceWindow: {
customWindow: 'string'
dayOfWeek: int
startHour: int
startMinute: int
}
nodeCount: int
nodeEnablePublicIpAccess: bool
nodeServerEdition: 'string'
nodeStorageQuotaInMb: int
nodeVCores: int
pointInTimeUTC: 'string'
postgresqlVersion: 'string'
preferredPrimaryZone: 'string'
sourceLocation: 'string'
sourceResourceId: 'string'
}
tags: {
{customized property}: 'string'
}
}
屬性值
AuthConfig
| 名字 | 描述 | 價值 |
|---|---|---|
| activeDirectoryAuth | 'disabled' 'enabled' |
|
| passwordAuth | 'disabled' 'enabled' |
ClusterProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| administratorLoginPassword | 系統管理員登入的密碼。 建立的必要專案。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| authConfig | 叢集的驗證組態。 | AuthConfig |
| citusVersion | 所有叢集伺服器上的 Citus 擴充功能版本。 | 字串 |
| coordinatorEnablePublicIpAccess | 如果在協調器上啟用公用存取。 | bool |
| coordinatorServerEdition | 協調器伺服器的版本（預設值：GeneralPurpose）。 建立的必要專案。 | 字串 |
| coordinatorStorageQuotaInMb | 以 MB 為單位的伺服器記憶體。 建立的必要專案。 如需詳細資訊，請參閱 /azure/cosmos-db/postgresql/resources-compute。 | int |
| coordinatorVCores | 伺服器的虛擬核心計數（最大值：96）。 建立的必要專案。 如需詳細資訊，請參閱 /azure/cosmos-db/postgresql/resources-compute。 | int |
| databaseName | 叢集的資料庫名稱。 每個叢集只支援一個資料庫。 | 字串 |
| dataEncryption | 叢集的數據加密屬性。 | DataEncryption |
| enableGeoBackup | 如果叢集備份除了儲存在叢集區域中的備份複本之外，還儲存在另一個 Azure 區域中。 只在叢集建立時啟用。 | bool |
| enableHa | 如果已啟用或未啟用叢集的高可用性 （HA）。 | bool |
| enableShardsOnCoordinator | 如果分散式資料表放在協調器上，則為 。 應該在單一節點叢集上設定為 『true』。 變更值之後，需要分區重新平衡。 | bool |
| maintenanceWindow | 叢集的維護時間範圍。 | MaintenanceWindow |
| nodeCount | 叢集的背景工作節點計數。 當節點計數為 0 時，它代表單一節點組態，能夠在該節點上建立分散式數據表。 2 個以上的背景工作節點代表多節點組態。 節點計數值不能是 1。 建立的必要專案。 | int |
| nodeEnablePublicIpAccess | 如果在背景工作節點上啟用公用存取。 | bool |
| nodeServerEdition | 節點伺服器的版本（預設值：MemoryOptimized）。 | 字串 |
| nodeStorageQuotaInMb | 每個背景工作節點上以 MB 為單位的記憶體。 如需詳細資訊，請參閱 /azure/cosmos-db/postgresql/resources-compute。 | int |
| nodeVCores | 每個背景工作節點上虛擬核心中的計算（最大值：104）。 如需詳細資訊，請參閱 /azure/cosmos-db/postgresql/resources-compute。 | int |
| pointInTimeUTC | 叢集還原的UTC日期和時間（ISO8601格式）。 | 字串 |
| postgresqlVersion | 所有叢集伺服器上的主要 PostgreSQL 版本。 | 字串 |
| preferredPrimaryZone | 所有叢集伺服器的慣用主要可用性區域 （AZ）。 | 字串 |
| sourceLocation | 讀取複本叢集的來源叢集 Azure 區域。 | 字串 |
| sourceResourceId | 讀取複本叢集的來源叢集資源標識碼。 | 字串 |
DataEncryption
| 名字 | 描述 | 價值 |
|---|---|---|
| primaryKeyUri | 金鑰保存庫中金鑰的 URI，用於主伺服器的數據加密。 | 字串 |
| primaryUserAssignedIdentityId | 要用於主伺服器數據加密之使用者指派身分識別的資源識別碼。 | 字串 |
| 類型 | 'AzureKeyVault' 'SystemAssigned' |
IdentityProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 'SystemAssigned' 'UserAssigned' |
|
| userAssignedIdentities | 與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件（{}）。 | UserAssignedIdentities |
MaintenanceWindow
| 名字 | 描述 | 價值 |
|---|---|---|
| customWindow | 指出是否啟用自定義維護期間。 | 字串 |
| dayOfWeek | 維護時段的一周慣用日期。 | int |
| startHour | 維護時段的慣用日內開始時間。 | int |
| startMinute | 維護期間開始時間範圍內的開始分鐘。 | int |
Microsoft.DBforPostgreSQL/serverGroupsv2
| 名字 | 描述 | 價值 |
|---|---|---|
| 身份 | 描述叢集的身分識別。 | IdentityProperties |
| 位置 | 資源所在的地理位置 | 字串 （必要） |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 3 最大長度 = 3 模式 = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ （必要） |
| 性能 | 叢集的屬性。 | ClusterProperties |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|
UserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|
UserAssignedIdentity
| 名字 | 描述 | 價值 |
|---|
ARM 樣本資源定義
serverGroupsv2 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DBforPostgreSQL/serverGroupsv2 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
"apiVersion": "2023-03-02-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"administratorLoginPassword": "string",
"authConfig": {
"activeDirectoryAuth": "string",
"passwordAuth": "string"
},
"citusVersion": "string",
"coordinatorEnablePublicIpAccess": "bool",
"coordinatorServerEdition": "string",
"coordinatorStorageQuotaInMb": "int",
"coordinatorVCores": "int",
"databaseName": "string",
"dataEncryption": {
"primaryKeyUri": "string",
"primaryUserAssignedIdentityId": "string",
"type": "string"
},
"enableGeoBackup": "bool",
"enableHa": "bool",
"enableShardsOnCoordinator": "bool",
"maintenanceWindow": {
"customWindow": "string",
"dayOfWeek": "int",
"startHour": "int",
"startMinute": "int"
},
"nodeCount": "int",
"nodeEnablePublicIpAccess": "bool",
"nodeServerEdition": "string",
"nodeStorageQuotaInMb": "int",
"nodeVCores": "int",
"pointInTimeUTC": "string",
"postgresqlVersion": "string",
"preferredPrimaryZone": "string",
"sourceLocation": "string",
"sourceResourceId": "string"
},
"tags": {
"{customized property}": "string"
}
}
屬性值
AuthConfig
| 名字 | 描述 | 價值 |
|---|---|---|
| activeDirectoryAuth | 'disabled' 'enabled' |
|
| passwordAuth | 'disabled' 'enabled' |
ClusterProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| administratorLoginPassword | 系統管理員登入的密碼。 建立的必要專案。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| authConfig | 叢集的驗證組態。 | AuthConfig |
| citusVersion | 所有叢集伺服器上的 Citus 擴充功能版本。 | 字串 |
| coordinatorEnablePublicIpAccess | 如果在協調器上啟用公用存取。 | bool |
| coordinatorServerEdition | 協調器伺服器的版本（預設值：GeneralPurpose）。 建立的必要專案。 | 字串 |
| coordinatorStorageQuotaInMb | 以 MB 為單位的伺服器記憶體。 建立的必要專案。 如需詳細資訊，請參閱 /azure/cosmos-db/postgresql/resources-compute。 | int |
| coordinatorVCores | 伺服器的虛擬核心計數（最大值：96）。 建立的必要專案。 如需詳細資訊，請參閱 /azure/cosmos-db/postgresql/resources-compute。 | int |
| databaseName | 叢集的資料庫名稱。 每個叢集只支援一個資料庫。 | 字串 |
| dataEncryption | 叢集的數據加密屬性。 | DataEncryption |
| enableGeoBackup | 如果叢集備份除了儲存在叢集區域中的備份複本之外，還儲存在另一個 Azure 區域中。 只在叢集建立時啟用。 | bool |
| enableHa | 如果已啟用或未啟用叢集的高可用性 （HA）。 | bool |
| enableShardsOnCoordinator | 如果分散式資料表放在協調器上，則為 。 應該在單一節點叢集上設定為 『true』。 變更值之後，需要分區重新平衡。 | bool |
| maintenanceWindow | 叢集的維護時間範圍。 | MaintenanceWindow |
| nodeCount | 叢集的背景工作節點計數。 當節點計數為 0 時，它代表單一節點組態，能夠在該節點上建立分散式數據表。 2 個以上的背景工作節點代表多節點組態。 節點計數值不能是 1。 建立的必要專案。 | int |
| nodeEnablePublicIpAccess | 如果在背景工作節點上啟用公用存取。 | bool |
| nodeServerEdition | 節點伺服器的版本（預設值：MemoryOptimized）。 | 字串 |
| nodeStorageQuotaInMb | 每個背景工作節點上以 MB 為單位的記憶體。 如需詳細資訊，請參閱 /azure/cosmos-db/postgresql/resources-compute。 | int |
| nodeVCores | 每個背景工作節點上虛擬核心中的計算（最大值：104）。 如需詳細資訊，請參閱 /azure/cosmos-db/postgresql/resources-compute。 | int |
| pointInTimeUTC | 叢集還原的UTC日期和時間（ISO8601格式）。 | 字串 |
| postgresqlVersion | 所有叢集伺服器上的主要 PostgreSQL 版本。 | 字串 |
| preferredPrimaryZone | 所有叢集伺服器的慣用主要可用性區域 （AZ）。 | 字串 |
| sourceLocation | 讀取複本叢集的來源叢集 Azure 區域。 | 字串 |
| sourceResourceId | 讀取複本叢集的來源叢集資源標識碼。 | 字串 |
DataEncryption
| 名字 | 描述 | 價值 |
|---|---|---|
| primaryKeyUri | 金鑰保存庫中金鑰的 URI，用於主伺服器的數據加密。 | 字串 |
| primaryUserAssignedIdentityId | 要用於主伺服器數據加密之使用者指派身分識別的資源識別碼。 | 字串 |
| 類型 | 'AzureKeyVault' 'SystemAssigned' |
IdentityProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 'SystemAssigned' 'UserAssigned' |
|
| userAssignedIdentities | 與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件（{}）。 | UserAssignedIdentities |
MaintenanceWindow
| 名字 | 描述 | 價值 |
|---|---|---|
| customWindow | 指出是否啟用自定義維護期間。 | 字串 |
| dayOfWeek | 維護時段的一周慣用日期。 | int |
| startHour | 維護時段的慣用日內開始時間。 | int |
| startMinute | 維護期間開始時間範圍內的開始分鐘。 | int |
Microsoft.DBforPostgreSQL/serverGroupsv2
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2023-03-02-preview' |
| 身份 | 描述叢集的身分識別。 | IdentityProperties |
| 位置 | 資源所在的地理位置 | 字串 （必要） |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 3 最大長度 = 3 模式 = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ （必要） |
| 性能 | 叢集的屬性。 | ClusterProperties |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
| 類型 | 資源類型 | 'Microsoft.DBforPostgreSQL/serverGroupsv2' |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|
UserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|
UserAssignedIdentity
| 名字 | 描述 | 價值 |
|---|
Terraform （AzAPI 提供者） 資源定義
serverGroupsv2 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DBforPostgreSQL/serverGroupsv2 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
administratorLoginPassword = "string"
authConfig = {
activeDirectoryAuth = "string"
passwordAuth = "string"
}
citusVersion = "string"
coordinatorEnablePublicIpAccess = bool
coordinatorServerEdition = "string"
coordinatorStorageQuotaInMb = int
coordinatorVCores = int
databaseName = "string"
dataEncryption = {
primaryKeyUri = "string"
primaryUserAssignedIdentityId = "string"
type = "string"
}
enableGeoBackup = bool
enableHa = bool
enableShardsOnCoordinator = bool
maintenanceWindow = {
customWindow = "string"
dayOfWeek = int
startHour = int
startMinute = int
}
nodeCount = int
nodeEnablePublicIpAccess = bool
nodeServerEdition = "string"
nodeStorageQuotaInMb = int
nodeVCores = int
pointInTimeUTC = "string"
postgresqlVersion = "string"
preferredPrimaryZone = "string"
sourceLocation = "string"
sourceResourceId = "string"
}
})
}
屬性值
AuthConfig
| 名字 | 描述 | 價值 |
|---|---|---|
| activeDirectoryAuth | 'disabled' 'enabled' |
|
| passwordAuth | 'disabled' 'enabled' |
ClusterProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| administratorLoginPassword | 系統管理員登入的密碼。 建立的必要專案。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| authConfig | 叢集的驗證組態。 | AuthConfig |
| citusVersion | 所有叢集伺服器上的 Citus 擴充功能版本。 | 字串 |
| coordinatorEnablePublicIpAccess | 如果在協調器上啟用公用存取。 | bool |
| coordinatorServerEdition | 協調器伺服器的版本（預設值：GeneralPurpose）。 建立的必要專案。 | 字串 |
| coordinatorStorageQuotaInMb | 以 MB 為單位的伺服器記憶體。 建立的必要專案。 如需詳細資訊，請參閱 /azure/cosmos-db/postgresql/resources-compute。 | int |
| coordinatorVCores | 伺服器的虛擬核心計數（最大值：96）。 建立的必要專案。 如需詳細資訊，請參閱 /azure/cosmos-db/postgresql/resources-compute。 | int |
| databaseName | 叢集的資料庫名稱。 每個叢集只支援一個資料庫。 | 字串 |
| dataEncryption | 叢集的數據加密屬性。 | DataEncryption |
| enableGeoBackup | 如果叢集備份除了儲存在叢集區域中的備份複本之外，還儲存在另一個 Azure 區域中。 只在叢集建立時啟用。 | bool |
| enableHa | 如果已啟用或未啟用叢集的高可用性 （HA）。 | bool |
| enableShardsOnCoordinator | 如果分散式資料表放在協調器上，則為 。 應該在單一節點叢集上設定為 『true』。 變更值之後，需要分區重新平衡。 | bool |
| maintenanceWindow | 叢集的維護時間範圍。 | MaintenanceWindow |
| nodeCount | 叢集的背景工作節點計數。 當節點計數為 0 時，它代表單一節點組態，能夠在該節點上建立分散式數據表。 2 個以上的背景工作節點代表多節點組態。 節點計數值不能是 1。 建立的必要專案。 | int |
| nodeEnablePublicIpAccess | 如果在背景工作節點上啟用公用存取。 | bool |
| nodeServerEdition | 節點伺服器的版本（預設值：MemoryOptimized）。 | 字串 |
| nodeStorageQuotaInMb | 每個背景工作節點上以 MB 為單位的記憶體。 如需詳細資訊，請參閱 /azure/cosmos-db/postgresql/resources-compute。 | int |
| nodeVCores | 每個背景工作節點上虛擬核心中的計算（最大值：104）。 如需詳細資訊，請參閱 /azure/cosmos-db/postgresql/resources-compute。 | int |
| pointInTimeUTC | 叢集還原的UTC日期和時間（ISO8601格式）。 | 字串 |
| postgresqlVersion | 所有叢集伺服器上的主要 PostgreSQL 版本。 | 字串 |
| preferredPrimaryZone | 所有叢集伺服器的慣用主要可用性區域 （AZ）。 | 字串 |
| sourceLocation | 讀取複本叢集的來源叢集 Azure 區域。 | 字串 |
| sourceResourceId | 讀取複本叢集的來源叢集資源標識碼。 | 字串 |
DataEncryption
| 名字 | 描述 | 價值 |
|---|---|---|
| primaryKeyUri | 金鑰保存庫中金鑰的 URI，用於主伺服器的數據加密。 | 字串 |
| primaryUserAssignedIdentityId | 要用於主伺服器數據加密之使用者指派身分識別的資源識別碼。 | 字串 |
| 類型 | 'AzureKeyVault' 'SystemAssigned' |
IdentityProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 'SystemAssigned' 'UserAssigned' |
|
| userAssignedIdentities | 與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件（{}）。 | UserAssignedIdentities |
MaintenanceWindow
| 名字 | 描述 | 價值 |
|---|---|---|
| customWindow | 指出是否啟用自定義維護期間。 | 字串 |
| dayOfWeek | 維護時段的一周慣用日期。 | int |
| startHour | 維護時段的慣用日內開始時間。 | int |
| startMinute | 維護期間開始時間範圍內的開始分鐘。 | int |
Microsoft.DBforPostgreSQL/serverGroupsv2
| 名字 | 描述 | 價值 |
|---|---|---|
| 身份 | 描述叢集的身分識別。 | IdentityProperties |
| 位置 | 資源所在的地理位置 | 字串 （必要） |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 3 最大長度 = 3 模式 = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ （必要） |
| 性能 | 叢集的屬性。 | ClusterProperties |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 |
| 類型 | 資源類型 | “Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview” |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|
UserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|
UserAssignedIdentity
| 名字 | 描述 | 價值 |
|---|