Microsoft.EventHub クラスター 2024-01-01

• 最新
• 2024-01-01
• 2023-01-01-preview
• 2022-10-01-preview
• 2022-01-01-preview
• 2021-11-01
• 2021-06-01-preview
• 2018-01-01-preview

Bicep リソース定義

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

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

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

リソース形式

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

resource symbolicname 'Microsoft.EventHub/clusters@2024-01-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'Dedicated'
  }
  properties: {
    supportsScaling: bool
    upgradePreferences: {
      startDayOfWeek: 'string'
      startHourOfDay: int
    }
  }
}

プロパティ値

clusters

名前	説明	値
name	リソース名	string (必須) 文字数制限: 6 から 50 有効な文字: 英数字とハイフン。 文字で開始します。 文字または数字で終了します。
location	リソースの場所。	string
tags	リソース タグ。	タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
sku	クラスター SKU のプロパティ。	ClusterSku
properties	List 操作または Get 操作の応答で指定された Event Hubs クラスターのプロパティ。	ClusterProperties

ClusterProperties

名前	説明	値
supportsScaling	スケーリングがサポートされているかどうかを示す 値です。	[bool]
upgradePreferences	クラスターのアップグレード設定のプロパティ。	UpgradePreferences

UpgradePreferences

名前	説明	値
startDayOfWeek	アップグレードを開始するには、UTC 時刻の曜日を指定します。 [Any]\(任意\) が選択されている場合、アップグレードは特定の曜日に続行されます	'Any' 'Friday' 'Monday' 'Saturday' '日曜日' '木曜日' 'Tuesday' '水曜'
startHourOfDay	アップグレードを開始するには、UTC 時刻で 1 日の優先時間を指定します	INT 制約: 最小値 = 0 最大値 = 23

ClusterSku

名前	説明	値
capacity	このクラスターに含まれる Event Hubs クラスター容量ユニットの数量。	INT 制約: 最小値 = 1
name	この SKU の名前。	'Dedicated' (必須)

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

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

Template	説明
Event Hub クラスター & namesapce をクラスターに作成します	このテンプレートを使用すると、EventHubs クラスターとクラスター内の名前空間を作成できます
Eventhub クラスターを作成し、namesapce & eventhub	このテンプレートを使用すると、EventHubs クラスター、名前空間、および eventhub をクラスターに作成できます

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

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

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

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

リソース形式

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

{
  "type": "Microsoft.EventHub/clusters",
  "apiVersion": "2024-01-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "Dedicated"
  },
  "properties": {
    "supportsScaling": "bool",
    "upgradePreferences": {
      "startDayOfWeek": "string",
      "startHourOfDay": "int"
    }
  }
}

プロパティ値

clusters

名前	説明	値
type	リソースの種類	'Microsoft.EventHub/clusters'
apiVersion	リソース API のバージョン	'2024-01-01'
name	リソース名	string (必須) 文字数制限: 6 から 50 有効な文字: 英数字とハイフン。 文字で開始します。 文字または数字で終了します。
location	リソースの場所。	string
tags	リソース タグ。	タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
sku	クラスター SKU のプロパティ。	ClusterSku
properties	List 操作または Get 操作の応答で指定された Event Hubs クラスターのプロパティ。	ClusterProperties

ClusterProperties

名前	説明	値
supportsScaling	スケーリングがサポートされているかどうかを示す 値です。	[bool]
upgradePreferences	クラスターのアップグレード設定のプロパティ。	UpgradePreferences

UpgradePreferences

名前	説明	値
startDayOfWeek	アップグレードを開始するには、UTC 時刻の曜日を指定します。 [Any]\(任意\) が選択されている場合、アップグレードは特定の曜日に続行されます	'Any' 'Friday' 'Monday' 'Saturday' '日曜日' '木曜日' 'Tuesday' '水曜'
startHourOfDay	アップグレードを開始するには、UTC 時刻で 1 日の優先時間を指定します	INT 制約: 最小値 = 0 最大値 = 23

ClusterSku

名前	説明	値
capacity	このクラスターに含まれる Event Hubs クラスター容量ユニットの数量。	INT 制約: 最小値 = 1
name	この SKU の名前。	'Dedicated' (必須)

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

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

Template	説明
Event Hub クラスター & namesapce をクラスターに作成します	このテンプレートを使用すると、EventHubs クラスターとクラスター内の名前空間を作成できます
Eventhub クラスターを作成し、namesapce & eventhub	このテンプレートを使用すると、EventHubs クラスター、名前空間、および eventhub をクラスターに作成できます

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

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

• リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventHub/clusters@2024-01-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      supportsScaling = bool
      upgradePreferences = {
        startDayOfWeek = "string"
        startHourOfDay = int
      }
    }
    sku = {
      capacity = int
      name = "Dedicated"
    }
  })
}

プロパティ値

clusters

名前	説明	値
type	リソースの種類	"Microsoft.EventHub/clusters@2024-01-01"
name	リソース名	string (必須) 文字制限: 6 から 50 有効な文字: 英数字とハイフン。 文字で開始します。 文字または数字で終了します。
location	リソースの場所。	string
parent_id	リソース グループにデプロイするには、そのリソース グループの ID を使用します。	string (必須)
tags	リソース タグ。	タグの名前と値のディクショナリ。
sku	クラスター SKU のプロパティ。	ClusterSku
properties	List 操作または Get 操作の応答で指定された Event Hubs クラスター プロパティ。	ClusterProperties

ClusterProperties

名前	説明	値
supportsScaling	スケーリングがサポートされているかどうかを示す値。	[bool]
upgradePreferences	クラスターのアップグレード設定のプロパティ。	UpgradePreferences

UpgradePreferences

名前	説明	値
startDayOfWeek	アップグレードを開始するために、UTC 時刻で推奨される曜日。 [Any]\(任意\) が選択されている場合、アップグレードは特定の曜日に続行されます	"Any" "金曜日" "月曜日" "土曜日" "日曜日" "木曜日" "火曜日" "水曜日"
startHourOfDay	アップグレードを開始するために UTC 時刻で 1 日の優先時間	INT 制約: 最小値 = 0 最大値 = 23

ClusterSku

名前	説明	値
capacity	このクラスターに含まれる Event Hubs クラスター容量ユニットの数量。	INT 制約: 最小値 = 1
name	この SKU の名前。	"Dedicated" (必須)