Microsoft.DBforPostgreSQL サーバーGroupsv2

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'
  }
}

プロパティ値

Microsoft.DBforPostgreSQL/serverGroupsv2 (英語)

名前 形容 価値
ID クラスターの ID について説明します。 IdentityProperties の
位置 リソースが存在する地理的な場所 string (必須)
名前 リソース名

制約:
最小長 = 3
最大長 = 40
パターン = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (必須)
プロパティ クラスターのプロパティ。 ClusterProperties の
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

認証設定

名前 形容 価値
アクティブディレクトリ認証 '無効'
'有効'
パスワード認証 '無効'
'有効'

クラスタプロパティ

名前 形容 価値
管理者ログインパスワード 管理者ログインのパスワード。 作成に必要です。

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
authConfigの クラスターの認証構成。 認証設定
citusバージョン すべてのクラスター サーバー上の Citus 拡張機能バージョン。 文字列
コーディネーターEnablePublicIpAccess コーディネーターでパブリック アクセスが有効になっている場合。 ブール (bool)
コーディネーターサーバーエディション コーディネーター サーバーのエディション (既定値: GeneralPurpose)。 作成に必要です。 文字列
coordinatorStorageQuotaInMb (英語) サーバーのストレージ (MB 単位)。 作成に必要です。 詳細については、/azure/cosmos-db/postgresql/resources-compute を参照してください。 整数 (int)
コーディネーターVCores サーバーの仮想コア数 (最大: 96)。 作成に必要です。 詳細については、/azure/cosmos-db/postgresql/resources-compute を参照してください。 整数 (int)
データベース名 クラスターのデータベース名。 サポートされているデータベースは、クラスターごとに 1 つだけです。 文字列
データ暗号化 クラスターのデータ暗号化プロパティ。 DataEncryption の
enableGeoBackup クラスターのバックアップが、クラスターのリージョンに格納されているバックアップのコピーに加えて、別の Azure リージョンに格納されている場合。 クラスターの作成時にのみ有効になります。 ブール (bool)
enableHa 高可用性 (HA) がクラスターに対して有効になっているかどうか。 ブール (bool)
enableShardsOnCoordinator 分散テーブルがコーディネーターに配置されているかどうか。 単一ノード クラスターで 'true' に設定する必要があります。 値が変更された後にシャードの再調整が必要です。 ブール (bool)
メンテナンスウィンドウ クラスターのメンテナンス期間。 メンテナンスウィンドウ
ノードカウント クラスターのワーカー ノード数。 ノード数が 0 の場合、ノードに分散テーブルを作成する機能を持つ単一のノード構成を表します。 2 つ以上のワーカー ノードがマルチノード構成を表します。 ノード数の値を 1 にすることはできません。 作成に必要です。 整数 (int)
ノードEnablePublicIpAccess ワーカー ノードでパブリック アクセスが有効になっている場合。 ブール (bool)
ノードサーバーエディション ノード サーバーのエディション (既定値: MemoryOptimized)。 文字列
ノードストレージクォータ (Mb) 各ワーカー ノードのストレージ (MB 単位)。 詳細については、/azure/cosmos-db/postgresql/resources-compute を参照してください。 整数 (int)
ノードVCores 各ワーカー ノードの仮想コア単位のコンピューティング (最大: 104)。 詳細については、/azure/cosmos-db/postgresql/resources-compute を参照してください。 整数 (int)
ポイントインタイムUTC クラスターの復元の UTC (ISO8601形式) の日付と時刻。 文字列
PostgreSQLのバージョン すべてのクラスター サーバー上の PostgreSQL のメジャー バージョン。 文字列
preferredPrimaryZone (優先プライマリゾーン) すべてのクラスター サーバーの優先プライマリ可用性ゾーン (AZ)。 文字列
ソースロケーション 読み取りレプリカ クラスターのソース クラスターの Azure リージョン。 文字列
ソースリソースID 読み取りレプリカ クラスターのソース クラスターのリソース ID。 文字列

データ暗号化

名前 形容 価値
primaryKeyUri プライマリ サーバーのデータ暗号化のための keyvault 内のキーの URI。 文字列
primaryUserAssignedIdentityId (英語) プライマリ サーバーのデータ暗号化に使用するユーザー割り当て ID のリソース ID。 文字列
'AzureKeyVault'
'システム割り当て'

Identityプロパティ

名前 形容 価値
'システム割り当て'
'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

名前 形容 価値

メンテナンスウィンドウ

名前 形容 価値
カスタムウィンドウ カスタム メンテナンス期間が有効かどうかを示します。 文字列
dayOfWeekの メンテナンス期間の優先曜日。 整数 (int)
スタートアワー メンテナンス期間の希望する曜日内の開始時間。 整数 (int)
スタートミニッツ メンテナンス期間の開始時刻内の開始分。 整数 (int)

追跡リソースタグ

名前 形容 価値

ユーザー割り当て識別子

名前 形容 価値

使用例

Bicep サンプル

Azure Cosmos DB for PostgreSQL クラスターをデプロイする基本的な例。

param resourceName string = 'acctest0001'
param location string = 'westeurope'
@secure()
@description('The administrator login password for the PostgreSQL server group')
param administratorLoginPassword string

resource serverGroupsv2 'Microsoft.DBforPostgreSQL/serverGroupsv2@2022-11-08' = {
  name: resourceName
  location: location
  properties: {
    administratorLoginPassword: null
    coordinatorEnablePublicIpAccess: true
    coordinatorServerEdition: 'GeneralPurpose'
    coordinatorStorageQuotaInMb: 131072
    coordinatorVCores: 2
    enableHa: false
    nodeCount: 0
    nodeEnablePublicIpAccess: false
    nodeServerEdition: 'MemoryOptimized'
  }
}

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"
  }
}

プロパティ値

Microsoft.DBforPostgreSQL/serverGroupsv2 (英語)

名前 形容 価値
apiVersion (英語) API のバージョン 「2023-03-02-プレビュー」
ID クラスターの ID について説明します。 IdentityProperties の
位置 リソースが存在する地理的な場所 string (必須)
名前 リソース名

制約:
最小長 = 3
最大長 = 40
パターン = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (必須)
プロパティ クラスターのプロパティ。 ClusterProperties の
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
リソースの種類 'Microsoft.DBforPostgreSQL/serverGroupsv2'

認証設定

名前 形容 価値
アクティブディレクトリ認証 '無効'
'有効'
パスワード認証 '無効'
'有効'

クラスタプロパティ

名前 形容 価値
管理者ログインパスワード 管理者ログインのパスワード。 作成に必要です。

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
authConfigの クラスターの認証構成。 認証設定
citusバージョン すべてのクラスター サーバー上の Citus 拡張機能バージョン。 文字列
コーディネーターEnablePublicIpAccess コーディネーターでパブリック アクセスが有効になっている場合。 ブール (bool)
コーディネーターサーバーエディション コーディネーター サーバーのエディション (既定値: GeneralPurpose)。 作成に必要です。 文字列
coordinatorStorageQuotaInMb (英語) サーバーのストレージ (MB 単位)。 作成に必要です。 詳細については、/azure/cosmos-db/postgresql/resources-compute を参照してください。 整数 (int)
コーディネーターVCores サーバーの仮想コア数 (最大: 96)。 作成に必要です。 詳細については、/azure/cosmos-db/postgresql/resources-compute を参照してください。 整数 (int)
データベース名 クラスターのデータベース名。 サポートされているデータベースは、クラスターごとに 1 つだけです。 文字列
データ暗号化 クラスターのデータ暗号化プロパティ。 DataEncryption の
enableGeoBackup クラスターのバックアップが、クラスターのリージョンに格納されているバックアップのコピーに加えて、別の Azure リージョンに格納されている場合。 クラスターの作成時にのみ有効になります。 ブール (bool)
enableHa 高可用性 (HA) がクラスターに対して有効になっているかどうか。 ブール (bool)
enableShardsOnCoordinator 分散テーブルがコーディネーターに配置されているかどうか。 単一ノード クラスターで 'true' に設定する必要があります。 値が変更された後にシャードの再調整が必要です。 ブール (bool)
メンテナンスウィンドウ クラスターのメンテナンス期間。 メンテナンスウィンドウ
ノードカウント クラスターのワーカー ノード数。 ノード数が 0 の場合、ノードに分散テーブルを作成する機能を持つ単一のノード構成を表します。 2 つ以上のワーカー ノードがマルチノード構成を表します。 ノード数の値を 1 にすることはできません。 作成に必要です。 整数 (int)
ノードEnablePublicIpAccess ワーカー ノードでパブリック アクセスが有効になっている場合。 ブール (bool)
ノードサーバーエディション ノード サーバーのエディション (既定値: MemoryOptimized)。 文字列
ノードストレージクォータ (Mb) 各ワーカー ノードのストレージ (MB 単位)。 詳細については、/azure/cosmos-db/postgresql/resources-compute を参照してください。 整数 (int)
ノードVCores 各ワーカー ノードの仮想コア単位のコンピューティング (最大: 104)。 詳細については、/azure/cosmos-db/postgresql/resources-compute を参照してください。 整数 (int)
ポイントインタイムUTC クラスターの復元の UTC (ISO8601形式) の日付と時刻。 文字列
PostgreSQLのバージョン すべてのクラスター サーバー上の PostgreSQL のメジャー バージョン。 文字列
preferredPrimaryZone (優先プライマリゾーン) すべてのクラスター サーバーの優先プライマリ可用性ゾーン (AZ)。 文字列
ソースロケーション 読み取りレプリカ クラスターのソース クラスターの Azure リージョン。 文字列
ソースリソースID 読み取りレプリカ クラスターのソース クラスターのリソース ID。 文字列

データ暗号化

名前 形容 価値
primaryKeyUri プライマリ サーバーのデータ暗号化のための keyvault 内のキーの URI。 文字列
primaryUserAssignedIdentityId (英語) プライマリ サーバーのデータ暗号化に使用するユーザー割り当て ID のリソース ID。 文字列
'AzureKeyVault'
'システム割り当て'

Identityプロパティ

名前 形容 価値
'システム割り当て'
'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

名前 形容 価値

メンテナンスウィンドウ

名前 形容 価値
カスタムウィンドウ カスタム メンテナンス期間が有効かどうかを示します。 文字列
dayOfWeekの メンテナンス期間の優先曜日。 整数 (int)
スタートアワー メンテナンス期間の希望する曜日内の開始時間。 整数 (int)
スタートミニッツ メンテナンス期間の開始時刻内の開始分。 整数 (int)

追跡リソースタグ

名前 形容 価値

ユーザー割り当て識別子

名前 形容 価値

使用例

Terraform (AzAPI プロバイダー) リソース定義

serverGroupsv2 リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループ

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DBforPostgreSQL/serverGroupsv2 リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
    }
  }
}

プロパティ値

Microsoft.DBforPostgreSQL/serverGroupsv2 (英語)

名前 形容 価値
ID クラスターの ID について説明します。 IdentityProperties の
位置 リソースが存在する地理的な場所 string (必須)
名前 リソース名

制約:
最小長 = 3
最大長 = 40
パターン = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (必須)
プロパティ クラスターのプロパティ。 ClusterProperties の
タグ リソース タグ タグ名と値のディクショナリ。
リソースの種類 "Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview" (英語)

認証設定

名前 形容 価値
アクティブディレクトリ認証 '無効'
'有効'
パスワード認証 '無効'
'有効'

クラスタプロパティ

名前 形容 価値
管理者ログインパスワード 管理者ログインのパスワード。 作成に必要です。

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
authConfigの クラスターの認証構成。 認証設定
citusバージョン すべてのクラスター サーバー上の Citus 拡張機能バージョン。 文字列
コーディネーターEnablePublicIpAccess コーディネーターでパブリック アクセスが有効になっている場合。 ブール (bool)
コーディネーターサーバーエディション コーディネーター サーバーのエディション (既定値: GeneralPurpose)。 作成に必要です。 文字列
coordinatorStorageQuotaInMb (英語) サーバーのストレージ (MB 単位)。 作成に必要です。 詳細については、/azure/cosmos-db/postgresql/resources-compute を参照してください。 整数 (int)
コーディネーターVCores サーバーの仮想コア数 (最大: 96)。 作成に必要です。 詳細については、/azure/cosmos-db/postgresql/resources-compute を参照してください。 整数 (int)
データベース名 クラスターのデータベース名。 サポートされているデータベースは、クラスターごとに 1 つだけです。 文字列
データ暗号化 クラスターのデータ暗号化プロパティ。 DataEncryption の
enableGeoBackup クラスターのバックアップが、クラスターのリージョンに格納されているバックアップのコピーに加えて、別の Azure リージョンに格納されている場合。 クラスターの作成時にのみ有効になります。 ブール (bool)
enableHa 高可用性 (HA) がクラスターに対して有効になっているかどうか。 ブール (bool)
enableShardsOnCoordinator 分散テーブルがコーディネーターに配置されているかどうか。 単一ノード クラスターで 'true' に設定する必要があります。 値が変更された後にシャードの再調整が必要です。 ブール (bool)
メンテナンスウィンドウ クラスターのメンテナンス期間。 メンテナンスウィンドウ
ノードカウント クラスターのワーカー ノード数。 ノード数が 0 の場合、ノードに分散テーブルを作成する機能を持つ単一のノード構成を表します。 2 つ以上のワーカー ノードがマルチノード構成を表します。 ノード数の値を 1 にすることはできません。 作成に必要です。 整数 (int)
ノードEnablePublicIpAccess ワーカー ノードでパブリック アクセスが有効になっている場合。 ブール (bool)
ノードサーバーエディション ノード サーバーのエディション (既定値: MemoryOptimized)。 文字列
ノードストレージクォータ (Mb) 各ワーカー ノードのストレージ (MB 単位)。 詳細については、/azure/cosmos-db/postgresql/resources-compute を参照してください。 整数 (int)
ノードVCores 各ワーカー ノードの仮想コア単位のコンピューティング (最大: 104)。 詳細については、/azure/cosmos-db/postgresql/resources-compute を参照してください。 整数 (int)
ポイントインタイムUTC クラスターの復元の UTC (ISO8601形式) の日付と時刻。 文字列
PostgreSQLのバージョン すべてのクラスター サーバー上の PostgreSQL のメジャー バージョン。 文字列
preferredPrimaryZone (優先プライマリゾーン) すべてのクラスター サーバーの優先プライマリ可用性ゾーン (AZ)。 文字列
ソースロケーション 読み取りレプリカ クラスターのソース クラスターの Azure リージョン。 文字列
ソースリソースID 読み取りレプリカ クラスターのソース クラスターのリソース ID。 文字列

データ暗号化

名前 形容 価値
primaryKeyUri プライマリ サーバーのデータ暗号化のための keyvault 内のキーの URI。 文字列
primaryUserAssignedIdentityId (英語) プライマリ サーバーのデータ暗号化に使用するユーザー割り当て ID のリソース ID。 文字列
'AzureKeyVault'
'システム割り当て'

Identityプロパティ

名前 形容 価値
'システム割り当て'
'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

名前 形容 価値

メンテナンスウィンドウ

名前 形容 価値
カスタムウィンドウ カスタム メンテナンス期間が有効かどうかを示します。 文字列
dayOfWeekの メンテナンス期間の優先曜日。 整数 (int)
スタートアワー メンテナンス期間の希望する曜日内の開始時間。 整数 (int)
スタートミニッツ メンテナンス期間の開始時刻内の開始分。 整数 (int)

追跡リソースタグ

名前 形容 価値

ユーザー割り当て識別子

名前 形容 価値

使用例

Terraformサンプル

Azure Cosmos DB for PostgreSQL クラスターをデプロイする基本的な例。

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

variable "administrator_login_password" {
  type        = string
  description = "The administrator login password for the PostgreSQL server group"
  sensitive   = true
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "serverGroupsv2" {
  type      = "Microsoft.DBforPostgreSQL/serverGroupsv2@2022-11-08"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      administratorLoginPassword      = var.administrator_login_password
      coordinatorEnablePublicIpAccess = true
      coordinatorServerEdition        = "GeneralPurpose"
      coordinatorStorageQuotaInMb     = 131072
      coordinatorVCores               = 2
      enableHa                        = false
      nodeCount                       = 0
      nodeEnablePublicIpAccess        = false
      nodeServerEdition               = "MemoryOptimized"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}