Поделиться через


Microsoft.DBforPostgreSQL serverGroupsv2

Определение ресурсов 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 "отключено"
"Включено"
passwordAuth "отключено"
"Включено"

ClusterProperties

Имя Описание Ценность
administratorLoginPassword Пароль для входа администратора. Требуется для создания. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
authConfig Конфигурация проверки подлинности кластера. AuthConfig
citusVersion Версия расширения Citus на всех серверах кластера. струна
координаторEnablePublicIpAccess Если общедоступный доступ включен в координаторе. bool
coordinatorServerEdition Выпуск сервера координатора (по умолчанию: GeneralPurpose). Требуется для создания. струна
coordinatorStorageQuotaInMb Хранилище сервера в МБ. Требуется для создания. Дополнительные сведения см. в статье /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
обслуживаниеWindow Период обслуживания кластера. MaintenanceWindow
nodeCount Количество рабочих узлов кластера. Если число узлов равно 0, он представляет конфигурацию одного узла с возможностью создания распределенных таблиц на этом узле. 2 или более рабочих узлов представляют конфигурацию с несколькими узлами. Значение счетчика узлов не может быть 1. Требуется для создания. int
nodeEnablePublicIpAccess Если общедоступный доступ включен на рабочих узлах. bool
nodeServerEdition Выпуск сервера узлов (по умолчанию: MemoryOptimized). струна
nodeStorageQuotaInMb Хранилище в МБ на каждом рабочем узле. Дополнительные сведения см. в статье /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) для ключа в keyvault для шифрования данных первичного сервера. струна
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
Максимальная длина = 40
Pattern = ^(?![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 "отключено"
"Включено"
passwordAuth "отключено"
"Включено"

ClusterProperties

Имя Описание Ценность
administratorLoginPassword Пароль для входа администратора. Требуется для создания. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
authConfig Конфигурация проверки подлинности кластера. AuthConfig
citusVersion Версия расширения Citus на всех серверах кластера. струна
координаторEnablePublicIpAccess Если общедоступный доступ включен в координаторе. bool
coordinatorServerEdition Выпуск сервера координатора (по умолчанию: GeneralPurpose). Требуется для создания. струна
coordinatorStorageQuotaInMb Хранилище сервера в МБ. Требуется для создания. Дополнительные сведения см. в статье /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
обслуживаниеWindow Период обслуживания кластера. MaintenanceWindow
nodeCount Количество рабочих узлов кластера. Если число узлов равно 0, он представляет конфигурацию одного узла с возможностью создания распределенных таблиц на этом узле. 2 или более рабочих узлов представляют конфигурацию с несколькими узлами. Значение счетчика узлов не может быть 1. Требуется для создания. int
nodeEnablePublicIpAccess Если общедоступный доступ включен на рабочих узлах. bool
nodeServerEdition Выпуск сервера узлов (по умолчанию: MemoryOptimized). струна
nodeStorageQuotaInMb Хранилище в МБ на каждом рабочем узле. Дополнительные сведения см. в статье /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) для ключа в keyvault для шифрования данных первичного сервера. струна
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
Максимальная длина = 40
Pattern = ^(?![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 "отключено"
"Включено"
passwordAuth "отключено"
"Включено"

ClusterProperties

Имя Описание Ценность
administratorLoginPassword Пароль для входа администратора. Требуется для создания. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
authConfig Конфигурация проверки подлинности кластера. AuthConfig
citusVersion Версия расширения Citus на всех серверах кластера. струна
координаторEnablePublicIpAccess Если общедоступный доступ включен в координаторе. bool
coordinatorServerEdition Выпуск сервера координатора (по умолчанию: GeneralPurpose). Требуется для создания. струна
coordinatorStorageQuotaInMb Хранилище сервера в МБ. Требуется для создания. Дополнительные сведения см. в статье /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
обслуживаниеWindow Период обслуживания кластера. MaintenanceWindow
nodeCount Количество рабочих узлов кластера. Если число узлов равно 0, он представляет конфигурацию одного узла с возможностью создания распределенных таблиц на этом узле. 2 или более рабочих узлов представляют конфигурацию с несколькими узлами. Значение счетчика узлов не может быть 1. Требуется для создания. int
nodeEnablePublicIpAccess Если общедоступный доступ включен на рабочих узлах. bool
nodeServerEdition Выпуск сервера узлов (по умолчанию: MemoryOptimized). струна
nodeStorageQuotaInMb Хранилище в МБ на каждом рабочем узле. Дополнительные сведения см. в статье /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) для ключа в keyvault для шифрования данных первичного сервера. струна
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
Максимальная длина = 40
Pattern = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (обязательно)
свойства Свойства кластера. ClusterProperties
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview"

TrackedResourceTags

Имя Описание Ценность

UserAssignedIdentities

Имя Описание Ценность

UserAssignedIdentity

Имя Описание Ценность