Microsoft.Sql servers/elasticPools

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.Sql/servers/elasticPools@2023-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  properties: {
    autoPauseDelay: int
    availabilityZone: 'string'
    highAvailabilityReplicaCount: int
    licenseType: 'string'
    maintenanceConfigurationId: 'string'
    maxSizeBytes: int
    minCapacity: int
    perDatabaseSettings: {
      autoPauseDelay: int
      maxCapacity: int
      minCapacity: int
    }
    preferredEnclaveType: 'string'
    zoneRedundant: bool
  }
}

プロパティ値

servers/elasticPools

名前 説明
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。
string (必須)

文字制限: 1 から 128

有効な文字:
次は使用できません:
`<>*%&:\/?` または制御文字

末尾をピリオドまたはスペースにすることはできません。
location リソースの場所。 string (必須)
tags リソース タグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
sku エラスティック プール SKU。

SKU の一覧は、リージョンとサポート オファーによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、REST API または次のコマンドを使用 Capabilities_ListByLocation します。

Azure CLI:
az sql elastic-pool list-editions -l {location} -o table

SKU
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部の子リソース」を参照してください。
種類のリソースのシンボル名: サーバー
properties リソースのプロパティ。 ElasticPoolProperties

ElasticPoolProperties

名前 説明
autoPauseDelay エラスティック プールが自動的に一時停止されるまでの時間 (分)。 値 -1 は、自動一時停止が無効になっていることを意味します INT
availabilityZone プールのプライマリ レプリカがピン留めされる可用性ゾーンを指定します。 '1'
'2'
'3'
'NoPreference'
highAvailabilityReplicaCount 高可用性を提供するために使用されるエラスティック プールに関連付けられているセカンダリ レプリカの数。 Hyperscale エラスティック プールにのみ適用されます。 INT
licenseType このエラスティック プールに適用するライセンスの種類。 'BasePrice'
'LicenseIncluded'
maintenanceConfigurationId エラスティック プールに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンス更新が発生する期間を定義します。 string
maxSizeBytes データベース エラスティック プールのストレージ制限 (バイト単位)。 INT
minCapacity 一時停止されていない場合、サーバーレス プールが以下に縮小しない最小容量 INT
perDatabaseSettings エラスティック プールのデータベースごとの設定。 ElasticPoolPerDatabaseSettings
preferredEnclaveType エラスティック プールで要求されたエンクレーブの種類。 'Default'
'VBS'
zoneRedundant このエラスティック プールがゾーン冗長であるかどうか。つまり、このエラスティック プールのレプリカは複数の可用性ゾーンに分散されます。 [bool]

ElasticPoolPerDatabaseSettings

名前 説明
autoPauseDelay プール内のデータベースごとの自動一時停止遅延 INT
maxCapacity 1 つのデータベースで使用できる最大容量。 INT
minCapacity すべてのデータベースの最小容量が保証されます。 INT

Sku

名前 説明
capacity 特定の SKU の容量。 INT
family 同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。 string
name SKU の名前 。通常は、文字 + 数値コード (P3 など)。 string (必須)
size 特定の SKU のサイズ string
レベル 特定の SKU のレベルまたはエディション (Basic、Premium など)。 string

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

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

Template 説明
新しい SQL エラスティック プールをデプロイする

Azure にデプロイする
このテンプレートを使用すると、新しい関連付けられたSQL Serverとそれに割り当てる新しい SQL データベースを含む新しい SQL エラスティック プールをデプロイできます。

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

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

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

リソース形式

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

{
  "type": "Microsoft.Sql/servers/elasticPools",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "properties": {
    "autoPauseDelay": "int",
    "availabilityZone": "string",
    "highAvailabilityReplicaCount": "int",
    "licenseType": "string",
    "maintenanceConfigurationId": "string",
    "maxSizeBytes": "int",
    "minCapacity": "int",
    "perDatabaseSettings": {
      "autoPauseDelay": "int",
      "maxCapacity": "int",
      "minCapacity": "int"
    },
    "preferredEnclaveType": "string",
    "zoneRedundant": "bool"
  }
}

プロパティ値

servers/elasticPools

名前 説明
type リソースの種類 'Microsoft.Sql/servers/elasticPools'
apiVersion リソース API のバージョン '2023-05-01-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。
string (必須)

文字数制限: 1 から 128

有効な文字:
次は使用できません:
`<>*%&:\/?` または制御文字

末尾をピリオドまたはスペースにすることはできません。
location リソースの場所。 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
sku エラスティック プール SKU。

SKU の一覧は、リージョンとサポート オファーによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、REST API または次のコマンドを使用 Capabilities_ListByLocation します。

Azure CLI:
az sql elastic-pool list-editions -l {location} -o table

SKU
properties リソースのプロパティ。 ElasticPoolProperties

ElasticPoolProperties

名前 説明
autoPauseDelay エラスティック プールが自動的に一時停止されるまでの時間 (分)。 値 -1 は、自動一時停止が無効になっていることを意味します INT
availabilityZone プールのプライマリ レプリカがピン留めされる可用性ゾーンを指定します。 '1'
'2'
'3'
'NoPreference'
highAvailabilityReplicaCount 高可用性を提供するために使用されるエラスティック プールに関連付けられているセカンダリ レプリカの数。 Hyperscale エラスティック プールにのみ適用されます。 INT
licenseType このエラスティック プールに適用するライセンスの種類。 'BasePrice'
'LicenseIncluded'
maintenanceConfigurationId エラスティック プールに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンス更新が発生する期間を定義します。 string
maxSizeBytes データベース エラスティック プールのストレージ制限 (バイト単位)。 INT
minCapacity 一時停止されていない場合、サーバーレス プールが以下に縮小しない最小容量 INT
perDatabaseSettings エラスティック プールのデータベースごとの設定。 ElasticPoolPerDatabaseSettings
preferredEnclaveType エラスティック プールで要求されたエンクレーブの種類。 'Default'
'VBS'
zoneRedundant このエラスティック プールがゾーン冗長であるかどうか。つまり、このエラスティック プールのレプリカは複数の可用性ゾーンに分散されます。 [bool]

ElasticPoolPerDatabaseSettings

名前 説明
autoPauseDelay プール内のデータベースごとの自動一時停止遅延 INT
maxCapacity 1 つのデータベースで使用できる最大容量。 INT
minCapacity すべてのデータベースの最小容量が保証されます。 INT

Sku

名前 説明
capacity 特定の SKU の容量。 INT
family 同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。 string
name SKU の名前 。通常は、文字 + 数値コード (P3 など)。 string (必須)
size 特定の SKU のサイズ string
レベル 特定の SKU のレベルまたはエディション (Basic、Premium など)。 string

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

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

Template 説明
新しい SQL エラスティック プールをデプロイする

Azure にデプロイする
このテンプレートを使用すると、新しい関連付けられたSQL Serverとそれに割り当てる新しい SQL データベースを含む新しい SQL エラスティック プールをデプロイできます。

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/elasticPools@2023-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      autoPauseDelay = int
      availabilityZone = "string"
      highAvailabilityReplicaCount = int
      licenseType = "string"
      maintenanceConfigurationId = "string"
      maxSizeBytes = int
      minCapacity = int
      perDatabaseSettings = {
        autoPauseDelay = int
        maxCapacity = int
        minCapacity = int
      }
      preferredEnclaveType = "string"
      zoneRedundant = bool
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  })
}

プロパティ値

servers/elasticPools

名前 説明
type リソースの種類 "Microsoft.Sql/servers/elasticPools@2023-05-01-preview"
name リソース名 string (必須)

文字数制限: 1 から 128

有効な文字:
次は使用できません:
`<>*%&:\/?` または制御文字

末尾をピリオドまたはスペースにすることはできません。
location リソースの場所。 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サーバー
tags リソース タグ。 タグ名と値のディクショナリ。
sku エラスティック プール SKU。

SKU の一覧は、リージョンとサポート オファーによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、REST API または次のコマンドを使用 Capabilities_ListByLocation します。

Azure CLI:
az sql elastic-pool list-editions -l {location} -o table

SKU
properties リソースのプロパティ。 ElasticPoolProperties

ElasticPoolProperties

名前 説明
autoPauseDelay エラスティック プールが自動的に一時停止されるまでの時間 (分)。 値 -1 は、自動一時停止が無効になっていることを意味します INT
availabilityZone プールのプライマリ レプリカがピン留めされる可用性ゾーンを指定します。 "1"
"2"
"3"
"NoPreference"
highAvailabilityReplicaCount 高可用性を提供するために使用されるエラスティック プールに関連付けられているセカンダリ レプリカの数。 Hyperscale エラスティック プールにのみ適用されます。 INT
licenseType このエラスティック プールに適用するライセンスの種類。 "BasePrice"
"LicenseIncluded"
maintenanceConfigurationId エラスティック プールに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンス更新が発生する期間を定義します。 string
maxSizeBytes データベース エラスティック プールのストレージ制限 (バイト単位)。 INT
minCapacity 一時停止されていない場合、サーバーレス プールが以下に縮小しない最小容量 INT
perDatabaseSettings エラスティック プールのデータベースごとの設定。 ElasticPoolPerDatabaseSettings
preferredEnclaveType エラスティック プールで要求されたエンクレーブの種類。 "Default"
"VBS"
zoneRedundant このエラスティック プールがゾーン冗長かどうか。つまり、このエラスティック プールのレプリカは複数の可用性ゾーンに分散されます。 [bool]

ElasticPoolPerDatabaseSettings

名前 説明
autoPauseDelay プール内のデータベースごとの自動一時停止遅延 INT
maxCapacity 1 つのデータベースで使用できる最大容量。 INT
minCapacity すべてのデータベースの最小容量が保証されます。 INT

Sku

名前 説明
capacity 特定の SKU の容量。 INT
family サービスのハードウェアの世代が異なる場合は、同じ SKU に対して、ここでキャプチャできます。 string
name SKU の名前 (通常は文字 + 番号コード、例: P3)。 string (必須)
size 特定の SKU のサイズ string
レベル 特定の SKU のレベルまたはエディション (Basic、Premium など)。 string