Microsoft.DBforPostgreSQL flexibleServers 2022-12-01

[アーティクル]
01/13/2024

Bicep リソース定義

flexibleServers リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ - リソースグループのデプロイコマンドに関するページを参照してください

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

リソース形式

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

resource symbolicname 'Microsoft.DBforPostgreSQL/flexibleServers@2022-12-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    authConfig: {
      activeDirectoryAuth: 'string'
      passwordAuth: 'string'
      tenantId: 'string'
    }
    availabilityZone: 'string'
    backup: {
      backupRetentionDays: int
      geoRedundantBackup: 'string'
    }
    createMode: 'string'
    dataEncryption: {
      primaryKeyURI: 'string'
      primaryUserAssignedIdentityId: 'string'
      type: 'string'
    }
    highAvailability: {
      mode: 'string'
      standbyAvailabilityZone: 'string'
    }
    maintenanceWindow: {
      customWindow: 'string'
      dayOfWeek: int
      startHour: int
      startMinute: int
    }
    network: {
      delegatedSubnetResourceId: 'string'
      privateDnsZoneArmResourceId: 'string'
    }
    pointInTimeUTC: 'string'
    replicationRole: 'string'
    sourceServerResourceId: 'string'
    storage: {
      storageSizeGB: int
    }
    version: 'string'
  }
}

プロパティ値

flexibleServers

名前	説明	値
name	リソース名	string (必須)
location	リソースが保存されている地理的な場所	string (必須)
tags	リソースタグ。	タグ名と値のディクショナリ。「テンプレートのタグ」を参照してください
sku	サーバーの SKU (価格レベル)。	SKU
identity	アプリケーションの ID について説明します。	UserAssignedIdentity
properties	サーバーのプロパティ。	ServerProperties

UserAssignedIdentity

名前	説明	値
type	このリソースに関連付けられている ID の種類。現在、'None と UserAssigned' に制限されています	'None' 'UserAssigned' (必須)
userAssignedIdentities	は、ユーザー割り当て ID マップを表します。	object

ServerProperties

名前	説明	値
administratorLogin	サーバーの管理者のログイン名。サーバーの作成時にのみ指定できます (作成にはとが必要です)。	string
administratorLoginPassword	管理者ログインパスワード (サーバーの作成に必要)。	string
authConfig	サーバーの AuthConfig プロパティ。	AuthConfig
availabilityZone	サーバーの可用性ゾーン情報。	string
バックアップ (backup)	サーバーのバックアッププロパティ。	Backup
createMode	新しい PostgreSQL サーバーを作成するモード。	'Create' 'Default' 'GeoRestore' 'PointInTimeRestore' 'Replica' 'Update'
dataEncryption	サーバーのデータ暗号化プロパティ。	DataEncryption
highAvailability	サーバーの高可用性プロパティ。	HighAvailability
maintenanceWindow	サーバーのメンテナンス期間のプロパティ。	MaintenanceWindow
ネットワーク	サーバーのネットワークプロパティ。このネットワークプロパティは、サーバーをプライベートアクセスサーバーにする場合にのみ渡す必要があります。	Network
pointInTimeUTC	復元ポイントの作成時刻 (ISO8601形式)、復元元の時刻を指定します。 'createMode' が 'PointInTimeRestore' または 'GeoRestore' の場合は必須です。	string
replicationRole	サーバーのレプリケーションロール	'AsyncReplica' 'GeoAsyncReplica' 'None' 'Primary'
sourceServerResourceId	復元元のソースサーバーリソース ID。 'createMode' が 'PointInTimeRestore' または 'GeoRestore' または 'Replica' の場合は必須です。このプロパティは、レプリカサーバーに対してのみ返されます	string
storage	サーバーのストレージプロパティ。	Storage
version	PostgreSQL Server のバージョン。	'11' '12' '13' '14'

AuthConfig

名前	説明	値
activeDirectoryAuth	[有効] の場合、Azure Active Directory 認証が有効になります。	'Disabled' 'Enabled'
passwordAuth	[有効] の場合、パスワード認証が有効になります。	'Disabled' 'Enabled'
tenantId	サーバーのテナント ID。	string

Backup

名前	説明	値
backupRetentionDays	サーバーのバックアップ保有日数。	INT
geoRedundantBackup	サーバーで Geo-Redundant バックアップが有効になっているかどうかを示す値。	'Disabled' 'Enabled'

DataEncryption

名前	説明	値
primaryKeyURI	プライマリサーバーのデータ暗号化のキーの URI。	string
primaryUserAssignedIdentityId	プライマリサーバーのデータ暗号化に使用するユーザー割り当て ID のリソース ID。	string
type	システムマネージドと Azure Key Vault の場合に示すデータ暗号化の種類。	'AzureKeyVault' 'SystemManaged'

HighAvailability

名前	説明	値
mode	サーバーの HA モード。	'Disabled' 'SameZone' 'ZoneRedundant'
standbyAvailabilityZone	スタンバイの可用性ゾーン情報。	string

MaintenanceWindow

名前	説明	値
customWindow	は、カスタムウィンドウが有効か無効かを示します	string
dayOfWeek	メンテナンス期間の曜日	INT
startHour	メンテナンス期間の開始時刻	INT
startMinute	メンテナンス期間の開始時間 (分)	INT

ネットワーク

名前	説明	値
delegatedSubnetResourceId	委任されたサブネット arm リソース ID。これは、サーバーを VNET に挿入する場合 (プライベートアクセスサーバーなど) の作成時に渡す必要があります。更新中に、ゾーンの値を更新する場合にのみプライベート DNS渡します。	string
privateDnsZoneArmResourceId	プライベート DNS ゾーンの arm リソース ID。これは、サーバーを VNET に挿入する場合 (プライベートアクセスサーバーなど) の作成時に渡す必要があります。更新中に、ゾーンの値を更新する場合にのみプライベート DNS渡します。	string

Storage

名前	説明	値
storageSizeGB	サーバーに対して許可される最大ストレージ数。	INT

Sku

名前	説明	値
name	sku の名前 (通常は階層 + ファミリ + コア) (Standard_D4s_v3など)。	string (必須)
レベル	バースト可能など、特定の SKU のレベル。	'Burstable' 'GeneralPurpose' 'MemoryOptimized' (必須)

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

Template	説明
AAD を使用してAzure Database for PostgreSQL (柔軟) をデプロイする	このテンプレートは、AAD 統合を使用してフレキシブルサーバー Azure Database for PostgreSQL をデプロイする方法を提供します。
VNet を使用してAzure Database for PostgreSQL (フレキシブル) をデプロイする	このテンプレートは、VNet 統合を使用してフレキシブルサーバー Azure Database for PostgreSQL をデプロイする方法を提供します。
Web App 上の SonarQube と PostgreSQL と VNet の統合	このテンプレートを使用すると、PostgreSQL フレキシブルサーバー、VNet 統合、プライベート DNS を使用して、Linux 上の Web App に SonarQube を簡単にデプロイできます。

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

flexibleServers リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ - リソースグループのデプロイコマンドに関するページを参照してください

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

リソース形式

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

{
  "type": "Microsoft.DBforPostgreSQL/flexibleServers",
  "apiVersion": "2022-12-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "authConfig": {
      "activeDirectoryAuth": "string",
      "passwordAuth": "string",
      "tenantId": "string"
    },
    "availabilityZone": "string",
    "backup": {
      "backupRetentionDays": "int",
      "geoRedundantBackup": "string"
    },
    "createMode": "string",
    "dataEncryption": {
      "primaryKeyURI": "string",
      "primaryUserAssignedIdentityId": "string",
      "type": "string"
    },
    "highAvailability": {
      "mode": "string",
      "standbyAvailabilityZone": "string"
    },
    "maintenanceWindow": {
      "customWindow": "string",
      "dayOfWeek": "int",
      "startHour": "int",
      "startMinute": "int"
    },
    "network": {
      "delegatedSubnetResourceId": "string",
      "privateDnsZoneArmResourceId": "string"
    },
    "pointInTimeUTC": "string",
    "replicationRole": "string",
    "sourceServerResourceId": "string",
    "storage": {
      "storageSizeGB": "int"
    },
    "version": "string"
  }
}

プロパティ値

flexibleServers

名前	説明	値
type	リソースの種類	'Microsoft.DBforPostgreSQL/flexibleServers'
apiVersion	リソース API のバージョン	'2022-12-01'
name	リソース名	string (必須)
location	リソースが保存されている地理的な場所	string (必須)
tags	リソースタグ。	タグ名と値のディクショナリ。「テンプレートのタグ」を参照してください
sku	サーバーの SKU (価格レベル)。	SKU
identity	アプリケーションの ID について説明します。	UserAssignedIdentity
properties	サーバーのプロパティ。	ServerProperties

UserAssignedIdentity

名前	説明	値
type	このリソースに関連付けられている ID の種類。現在、'None と UserAssigned' に制限されています	'None' 'UserAssigned' (必須)
userAssignedIdentities	は、ユーザー割り当て ID マップを表します。	object

ServerProperties

名前	説明	値
administratorLogin	サーバーの管理者のログイン名。サーバーの作成時にのみ指定できます (作成にはとが必要です)。	string
administratorLoginPassword	管理者ログインパスワード (サーバーの作成に必要)。	string
authConfig	サーバーの AuthConfig プロパティ。	AuthConfig
availabilityZone	サーバーの可用性ゾーン情報。	string
バックアップ (backup)	サーバーのバックアッププロパティ。	Backup
createMode	新しい PostgreSQL サーバーを作成するモード。	'Create' 'Default' 'GeoRestore' 'PointInTimeRestore' 'Replica' 'Update'
dataEncryption	サーバーのデータ暗号化プロパティ。	DataEncryption
highAvailability	サーバーの高可用性プロパティ。	HighAvailability
maintenanceWindow	サーバーのメンテナンス期間のプロパティ。	MaintenanceWindow
ネットワーク	サーバーのネットワークプロパティ。このネットワークプロパティは、サーバーをプライベートアクセスサーバーにする場合にのみ渡す必要があります。	Network
pointInTimeUTC	復元ポイントの作成時刻 (ISO8601形式)、復元元の時刻を指定します。 'createMode' が 'PointInTimeRestore' または 'GeoRestore' の場合は必須です。	string
replicationRole	サーバーのレプリケーションロール	'AsyncReplica' 'GeoAsyncReplica' 'None' 'Primary'
sourceServerResourceId	復元元のソースサーバーリソース ID。 'createMode' が 'PointInTimeRestore' または 'GeoRestore' または 'Replica' の場合は必須です。このプロパティは、レプリカサーバーに対してのみ返されます	string
storage	サーバーのストレージプロパティ。	Storage
version	PostgreSQL Server のバージョン。	'11' '12' '13' '14'

AuthConfig

名前	説明	値
activeDirectoryAuth	[有効] の場合、Azure Active Directory 認証が有効になります。	'Disabled' 'Enabled'
passwordAuth	[有効] の場合、パスワード認証が有効になります。	'Disabled' 'Enabled'
tenantId	サーバーのテナント ID。	string

Backup

名前	説明	値
backupRetentionDays	サーバーのバックアップ保有日数。	INT
geoRedundantBackup	サーバーで Geo-Redundant バックアップが有効になっているかどうかを示す値。	'Disabled' 'Enabled'

DataEncryption

名前	説明	値
primaryKeyURI	プライマリサーバーのデータ暗号化のキーの URI。	string
primaryUserAssignedIdentityId	プライマリサーバーのデータ暗号化に使用するユーザー割り当て ID のリソース ID。	string
type	システムマネージドと Azure Key Vault の場合に示すデータ暗号化の種類。	'AzureKeyVault' 'SystemManaged'

HighAvailability

名前	説明	値
mode	サーバーの HA モード。	'Disabled' 'SameZone' 'ZoneRedundant'
standbyAvailabilityZone	スタンバイの可用性ゾーン情報。	string

MaintenanceWindow

名前	説明	値
customWindow	は、カスタムウィンドウが有効か無効かを示します	string
dayOfWeek	メンテナンス期間の曜日	INT
startHour	メンテナンス期間の開始時刻	INT
startMinute	メンテナンス期間の開始時間 (分)	INT

ネットワーク

名前	説明	値
delegatedSubnetResourceId	委任されたサブネット arm リソース ID。これは、サーバーを VNET に挿入する場合 (プライベートアクセスサーバーなど) の作成時に渡す必要があります。更新中に、ゾーンの値を更新する場合にのみプライベート DNS渡します。	string
privateDnsZoneArmResourceId	プライベート DNS ゾーンの arm リソース ID。これは、サーバーを VNET に挿入する場合 (プライベートアクセスサーバーなど) の作成時に渡す必要があります。更新中に、ゾーンの値を更新する場合にのみプライベート DNS渡します。	string

Storage

名前	説明	値
storageSizeGB	サーバーに対して許可される最大ストレージ数。	INT

Sku

名前	説明	値
name	sku の名前 (通常は階層 + ファミリ + コア)(例: Standard_D4s_v3)。	string (必須)
レベル	特定の SKU のレベル (バースト可能など)。	'Burstable' 'GeneralPurpose' 'MemoryOptimized' (必須)

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

Template	説明
AAD を使用してAzure Database for PostgreSQL (フレキシブル) をデプロイする	このテンプレートは、AAD 統合を使用してフレキシブルサーバー Azure データベース for PostgreSQL をデプロイする方法を提供します。
VNet を使用してAzure Database for PostgreSQL (フレキシブル) をデプロイする	このテンプレートは、VNet 統合を使用してフレキシブルサーバー Azure データベース for PostgreSQL をデプロイする方法を提供します。
PostgreSQL と VNet の統合を使用した Web アプリ上の SonarQube	このテンプレートを使用すると、PostgreSQL フレキシブルサーバー、VNet 統合、プライベート DNS を使用して、SonarQube を Linux 上の Web アプリに簡単にデプロイできます。

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

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

リソースグループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/flexibleServers@2022-12-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "UserAssigned"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      authConfig = {
        activeDirectoryAuth = "string"
        passwordAuth = "string"
        tenantId = "string"
      }
      availabilityZone = "string"
      backup = {
        backupRetentionDays = int
        geoRedundantBackup = "string"
      }
      createMode = "string"
      dataEncryption = {
        primaryKeyURI = "string"
        primaryUserAssignedIdentityId = "string"
        type = "string"
      }
      highAvailability = {
        mode = "string"
        standbyAvailabilityZone = "string"
      }
      maintenanceWindow = {
        customWindow = "string"
        dayOfWeek = int
        startHour = int
        startMinute = int
      }
      network = {
        delegatedSubnetResourceId = "string"
        privateDnsZoneArmResourceId = "string"
      }
      pointInTimeUTC = "string"
      replicationRole = "string"
      sourceServerResourceId = "string"
      storage = {
        storageSizeGB = int
      }
      version = "string"
    }
    sku = {
      name = "string"
      tier = "string"
    }
  })
}

プロパティ値

flexibleServers

名前	説明	値
type	リソースの種類	"Microsoft.DBforPostgreSQL/flexibleServers@2022-12-01"
name	リソース名	string (必須)
location	リソースが保存されている地理的な場所	string (必須)
parent_id	リソースグループにデプロイするには、そのリソースグループの ID を使用します。	string (必須)
tags	リソースタグ。	タグの名前と値のディクショナリ。
sku	サーバーの SKU (価格レベル)。	SKU
identity	アプリケーションの ID について説明します。	UserAssignedIdentity
properties	サーバーのプロパティ。	ServerProperties

UserAssignedIdentity

名前	説明	値
type	このリソースに関連付けられている ID の種類。現在、'None と UserAssigned' に制限されています	"UserAssigned" (必須)
identity_ids	は、ユーザー割り当て ID マップを表します。	ユーザー ID ID の配列。

ServerProperties

名前	説明	値
administratorLogin	サーバーの管理者のログイン名。サーバーの作成時にのみ指定できます (作成にはとが必要です)。	string
administratorLoginPassword	管理者ログインパスワード (サーバーの作成に必要)。	string
authConfig	サーバーの AuthConfig プロパティ。	AuthConfig
availabilityZone	サーバーの可用性ゾーン情報。	string
バックアップ (backup)	サーバーのバックアッププロパティ。	Backup
createMode	新しい PostgreSQL サーバーを作成するモード。	[作成] "Default" "GeoRestore" "PointInTimeRestore" "Replica" "更新"
dataEncryption	サーバーのデータ暗号化プロパティ。	DataEncryption
highAvailability	サーバーの高可用性プロパティ。	HighAvailability
maintenanceWindow	サーバーのメンテナンス期間のプロパティ。	MaintenanceWindow
ネットワーク	サーバーのネットワークプロパティ。このネットワークプロパティは、サーバーをプライベートアクセスサーバーにする場合にのみ渡す必要があります。	Network
pointInTimeUTC	復元ポイントの作成時刻 (ISO8601形式)、復元元の時刻を指定します。 'createMode' が 'PointInTimeRestore' または 'GeoRestore' の場合は必須です。	string
replicationRole	サーバーのレプリケーションロール	"AsyncReplica" "GeoAsyncReplica" "None" "Primary"
sourceServerResourceId	復元元のソースサーバーリソース ID。 'createMode' が 'PointInTimeRestore' または 'GeoRestore' または 'Replica' の場合は必須です。このプロパティは、レプリカサーバーに対してのみ返されます	string
storage	サーバーのストレージプロパティ。	Storage
version	PostgreSQL Server のバージョン。	"11" "12" "13" "14"

AuthConfig

名前	説明	値
activeDirectoryAuth	[有効] の場合、Azure Active Directory 認証が有効になります。	"無効" "有効"
passwordAuth	[有効] の場合、パスワード認証が有効になります。	"無効" "有効"
tenantId	サーバーのテナント ID。	string

Backup

名前	説明	値
backupRetentionDays	サーバーのバックアップ保有日数。	INT
geoRedundantBackup	Geo-Redundant バックアップがサーバーで有効になっているかどうかを示す値。	"無効" "有効"

DataEncryption

名前	説明	値
primaryKeyURI	プライマリサーバーのデータ暗号化のキーの URI。	string
primaryUserAssignedIdentityId	プライマリサーバーのデータ暗号化に使用するユーザー割り当て ID のリソース ID。	string
type	システムマネージドと Azure Key Vault の場合に示すデータ暗号化の種類。	"AzureKeyVault" "SystemManaged"

HighAvailability

名前	説明	値
mode	サーバーの HA モード。	"無効" "SameZone" "ZoneRedundant"
standbyAvailabilityZone	スタンバイの可用性ゾーン情報。	string

MaintenanceWindow

名前	説明	値
customWindow	は、カスタムウィンドウが有効か無効かを示します	string
dayOfWeek	メンテナンス期間の曜日	INT
startHour	メンテナンス期間の開始時刻	INT
startMinute	メンテナンス期間の開始時間 (分)	INT

ネットワーク

名前	説明	値
delegatedSubnetResourceId	委任されたサブネット arm リソース ID。これは、サーバーを VNET に挿入する場合 (つまり、プライベートアクセスサーバー) の作成時に渡す必要があります。更新中に、ゾーンの値を更新する場合にのみプライベート DNS渡します。	string
privateDnsZoneArmResourceId	プライベート DNS ゾーンの arm リソース ID。これは、サーバーを VNET に挿入する場合 (つまり、プライベートアクセスサーバー) の作成時に渡す必要があります。更新中に、ゾーンの値を更新する場合にのみプライベート DNS渡します。	string

Storage

名前	説明	値
storageSizeGB	サーバーに対して許可される最大ストレージ数。	INT

Sku

名前	説明	値
name	sku の名前 (通常は階層 + ファミリ + コア) (Standard_D4s_v3など)。	string (必須)
レベル	バースト可能など、特定の SKU のレベル。	"Burstable" "GeneralPurpose" "MemoryOptimized" (必須)

Microsoft.DBforPostgreSQL flexibleServers 2022-12-01

Bicep リソース定義

リソース形式

プロパティ値

flexibleServers

UserAssignedIdentity

ServerProperties

AuthConfig

Backup

DataEncryption

HighAvailability

MaintenanceWindow

ネットワーク

Storage

Sku

クイック スタート テンプレート

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

リソース形式

プロパティ値

flexibleServers

UserAssignedIdentity

ServerProperties

AuthConfig

Backup

DataEncryption

HighAvailability

MaintenanceWindow

ネットワーク

Storage

Sku

クイック スタート テンプレート

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

リソース形式

プロパティ値

flexibleServers

UserAssignedIdentity

ServerProperties

AuthConfig

Backup

DataEncryption

HighAvailability

MaintenanceWindow

ネットワーク

Storage

Sku

フィードバック

フィードバック

その他のリソース

クイックスタートテンプレート

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

クイックスタートテンプレート