Share via


Microsoft.EventHub-Cluster

Bicep-Ressourcendefinition

Der Clusterressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.EventHub/clusters-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.

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

Eigenschaftswerte

clusters

Name BESCHREIBUNG Wert
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 6-50

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Beginnen Sie mit einem Buchstaben. Enden Sie mit einem Buchstaben oder einer Zahl.
location Ressourcenspeicherort Zeichenfolge
tags Ressourcentags. Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen.
sku Eigenschaften der Cluster-SKU. ClusterSku
properties Event Hubs-Clustereigenschaften, die in Antworten in Listen- oder Get-Vorgängen bereitgestellt werden. ClusterEigenschaften

ClusterEigenschaften

Name BESCHREIBUNG Wert
supportsScaling Ein -Wert, der angibt, ob Die Skalierung unterstützt wird. bool
upgradePreferences Eigenschaften der Clusterupgradeeinstellungen. UpgradePreferences

UpgradePreferences

Name BESCHREIBUNG Wert
startDayOfWeek Bevorzugter Wochentag in UTC-Zeit, um mit einem Upgrade zu beginnen. Wenn "Beliebige" ausgewählt ist, wird das Upgrade an jedem beliebigen Wochentag fortgesetzt. "Beliebig"
"Freitag"
"Montag"
"Samstag"
"Sonntag"
"Donnerstag"
"Dienstag"
"Mittwoch"
startHourOfDay Bevorzugte Tageszeit in UTC-Zeit zum Starten eines Upgrades INT

Einschränkungen:
Minimaler Wert = 0
Maximaler Wert = 23

ClusterSku

Name BESCHREIBUNG Wert
Kapazität Die Menge der Event Hubs-Clusterkapazitätseinheiten, die in diesem Cluster enthalten sind. INT

Einschränkungen:
Minimaler Wert = 1
name Name dieser SKU. "Dedicated" (erforderlich)

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellt Event Hub-Cluster & nameapce im Cluster

Bereitstellen in Azure
Mit dieser Vorlage können Sie einen EventHubs-Cluster und einen Namespace im Cluster erstellen.
Erstellt EventHub-Cluster, namesapce & eventhub

Bereitstellen in Azure
Mit dieser Vorlage können Sie EventHubs-Cluster, Namespace und EventHub im Cluster erstellen.

Ressourcendefinition mit einer ARM-Vorlage

Der Clusterressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.EventHub/clusters-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

clusters

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.EventHub/clusters"
apiVersion Die Version der Ressourcen-API '2024-01-01'
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 6-50

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Beginnen Sie mit einem Buchstaben. Enden Sie mit einem Buchstaben oder einer Zahl.
location Ressourcenspeicherort Zeichenfolge
tags Ressourcentags. Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen.
sku Eigenschaften der Cluster-SKU. ClusterSku
properties Event Hubs-Clustereigenschaften, die in Antworten in Listen- oder Get-Vorgängen bereitgestellt werden. ClusterEigenschaften

ClusterEigenschaften

Name BESCHREIBUNG Wert
supportsScaling Ein -Wert, der angibt, ob Die Skalierung unterstützt wird. bool
upgradePreferences Eigenschaften der Clusterupgradeeinstellungen. UpgradePreferences

UpgradePreferences

Name BESCHREIBUNG Wert
startDayOfWeek Bevorzugter Wochentag in UTC-Zeit, um mit einem Upgrade zu beginnen. Wenn "Beliebige" ausgewählt ist, wird das Upgrade an jedem beliebigen Wochentag fortgesetzt. "Beliebig"
"Freitag"
"Montag"
"Samstag"
"Sonntag"
"Donnerstag"
"Dienstag"
"Mittwoch"
startHourOfDay Bevorzugte Tageszeit in UTC-Zeit zum Starten eines Upgrades INT

Einschränkungen:
Minimaler Wert = 0
Maximaler Wert = 23

ClusterSku

Name BESCHREIBUNG Wert
Kapazität Die Menge der Event Hubs-Clusterkapazitätseinheiten, die in diesem Cluster enthalten sind. INT

Einschränkungen:
Minimaler Wert = 1
name Name dieser SKU. "Dedicated" (erforderlich)

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellt Event Hub-Cluster & nameapce im Cluster

Bereitstellen in Azure
Mit dieser Vorlage können Sie einen EventHubs-Cluster und einen Namespace im Cluster erstellen.
Erstellt EventHub-Cluster, namesapce & eventhub

Bereitstellen in Azure
Mit dieser Vorlage können Sie EventHubs-Cluster, Namespace und EventHub im Cluster erstellen.

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Clusterressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.EventHub/clusters-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Terraform hinzu.

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

Eigenschaftswerte

clusters

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.EventHub/clusters@2024-01-01"
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 6-50

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Beginnen Sie mit einem Buchstaben. Enden Sie mit einem Buchstaben oder einer Zahl.
location Ressourcenspeicherort Zeichenfolge
parent_id Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. Zeichenfolge (erforderlich)
tags Ressourcentags. Wörterbuch der Tagnamen und -werte.
sku Eigenschaften der Cluster-SKU. ClusterSku
properties Event Hubs-Clustereigenschaften, die in Antworten in Listen- oder Get-Vorgängen bereitgestellt werden. ClusterEigenschaften

ClusterEigenschaften

Name BESCHREIBUNG Wert
unterstütztSkalieren Ein Wert, der angibt, ob die Skalierung unterstützt wird. bool
upgradePreferences Eigenschaften der Clusterupgradeeinstellungen. UpgradePreferences

UpgradePreferences

Name BESCHREIBUNG Wert
startDayOfWeek Bevorzugter Wochentag in UTC-Zeit, um mit einem Upgrade zu beginnen. Wenn "Beliebige" ausgewählt ist, wird das Upgrade an einem beliebigen Wochentag fortgesetzt. "Beliebige"
„Friday“
„Monday“ (Montag)
„Saturday“ (Samstag)
„Sunday“
„Thursday“
„Tuesday“
„Wednesday“
startHourOfDay Bevorzugte Stunde des Tages in UTC-Zeit, um ein Upgrade zu starten INT

Einschränkungen:
Min-Wert = 0
Maximaler Wert = 23

ClusterSku

Name BESCHREIBUNG Wert
Kapazität Die Menge der Event Hubs-Clusterkapazitätseinheiten, die in diesem Cluster enthalten sind. INT

Einschränkungen:
Min-Wert = 1
name Name dieser SKU. "Dedicated" (erforderlich)