Microsoft.DBforPostgreSQL serverGroupsv2

[アーティクル]
12/09/2024

最新のをする
2023-03-02-preview
2022-11-08

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	クラスターのデータベース名。サポートされているデータベースは、クラスターごとに 1 つだけです。	糸
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	読み取りレプリカクラスターのソースクラスターのリソース ID。	糸

DataEncryption

名前	形容	価値
primaryKeyUri	プライマリサーバーのデータ暗号化のための keyvault 内のキーの URI。	糸
primaryUserAssignedIdentityId	プライマリサーバーのデータ暗号化に使用するユーザー割り当て ID のリソース ID。	糸
種類		'AzureKeyVault' 'SystemAssigned'

IdentityProperties

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

MaintenanceWindow

名前	形容	価値
customWindow	カスタムメンテナンス期間が有効かどうかを示します。	糸
dayOfWeek	メンテナンス期間の優先曜日。	int
startHour	メンテナンス期間の希望する曜日内の開始時間。	int
startMinute	メンテナンス期間の開始時刻内の開始分。	int

Microsoft.DBforPostgreSQL/serverGroupsv2

名前	形容	価値
同一性	クラスターの ID について説明します。	IdentityProperties の
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	糸制約：最小長 = 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	クラスターのデータベース名。サポートされているデータベースは、クラスターごとに 1 つだけです。	糸
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	読み取りレプリカクラスターのソースクラスターのリソース ID。	糸

DataEncryption

名前	形容	価値
primaryKeyUri	プライマリサーバーのデータ暗号化のための keyvault 内のキーの URI。	糸
primaryUserAssignedIdentityId	プライマリサーバーのデータ暗号化に使用するユーザー割り当て ID のリソース ID。	糸
種類		'AzureKeyVault' 'SystemAssigned'

IdentityProperties

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

MaintenanceWindow

名前	形容	価値
customWindow	カスタムメンテナンス期間が有効かどうかを示します。	糸
dayOfWeek	メンテナンス期間の優先曜日。	int
startHour	メンテナンス期間の希望する曜日内の開始時間。	int
startMinute	メンテナンス期間の開始時刻内の開始分。	int

Microsoft.DBforPostgreSQL/serverGroupsv2

名前	形容	価値
apiVersion	API のバージョン	'2023-03-02-preview'
同一性	クラスターの ID について説明します。	IdentityProperties の
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	糸制約：最小長 = 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	クラスターのデータベース名。サポートされているデータベースは、クラスターごとに 1 つだけです。	糸
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	読み取りレプリカクラスターのソースクラスターのリソース ID。	糸

DataEncryption

名前	形容	価値
primaryKeyUri	プライマリサーバーのデータ暗号化のための keyvault 内のキーの URI。	糸
primaryUserAssignedIdentityId	プライマリサーバーのデータ暗号化に使用するユーザー割り当て ID のリソース ID。	糸
種類		'AzureKeyVault' 'SystemAssigned'

IdentityProperties

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

MaintenanceWindow

名前	形容	価値
customWindow	カスタムメンテナンス期間が有効かどうかを示します。	糸
dayOfWeek	メンテナンス期間の優先曜日。	int
startHour	メンテナンス期間の希望する曜日内の開始時間。	int
startMinute	メンテナンス期間の開始時刻内の開始分。	int

Microsoft.DBforPostgreSQL/serverGroupsv2

名前	形容	価値
同一性	クラスターの ID について説明します。	IdentityProperties の
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	糸制約：最小長 = 3 最大長 = 3 パターン = `^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$` (必須)
プロパティ	クラスターのプロパティ。	ClusterProperties の
タグ	リソースタグ	タグ名と値のディクショナリ。
種類	リソースの種類	"Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview"

TrackedResourceTags

名前	形容	価値

UserAssignedIdentities

名前	形容	価値

UserAssignedIdentity

名前	形容	価値

次の方法で共有

Microsoft.DBforPostgreSQL serverGroupsv2

Bicep リソース定義

リソースの形式

プロパティ値

AuthConfig

ClusterProperties

DataEncryption

IdentityProperties

MaintenanceWindow

Microsoft.DBforPostgreSQL/serverGroupsv2

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

ARM テンプレートリソース定義

リソースの形式

プロパティ値

AuthConfig

ClusterProperties

DataEncryption

IdentityProperties

MaintenanceWindow

Microsoft.DBforPostgreSQL/serverGroupsv2

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

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

リソースの形式

プロパティ値

AuthConfig

ClusterProperties

DataEncryption

IdentityProperties

MaintenanceWindow

Microsoft.DBforPostgreSQL/serverGroupsv2

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

フィードバック

その他のリソース

次の方法で共有

Microsoft.DBforPostgreSQL serverGroupsv2

Bicep リソース定義

リソースの形式

プロパティ値

AuthConfig

ClusterProperties

DataEncryption

IdentityProperties

MaintenanceWindow

Microsoft.DBforPostgreSQL/serverGroupsv2

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

ARM テンプレート リソース定義

リソースの形式

プロパティ値

AuthConfig

ClusterProperties

DataEncryption

IdentityProperties

MaintenanceWindow

Microsoft.DBforPostgreSQL/serverGroupsv2

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

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

リソースの形式

プロパティ値

AuthConfig

ClusterProperties

DataEncryption

IdentityProperties

MaintenanceWindow

Microsoft.DBforPostgreSQL/serverGroupsv2

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

フィードバック

その他のリソース

ARM テンプレートリソース定義