你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.EventHub namespaces/applicationGroups 2024-01-01

Bicep 资源定义

命名空间/applicationGroups 资源类型可以使用面向以下对象的操作进行部署:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.EventHub/namespaces/applicationGroups 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.EventHub/namespaces/applicationGroups@2024-01-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    clientAppGroupIdentifier: 'string'
    isEnabled: bool
    policies: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see ApplicationGroupPolicy objects
      }
    ]
  }
}

ApplicationGroupPolicy 对象

设置 type 属性以指定对象的类型。

对于 ThrottlingPolicy,请使用:

  type: 'ThrottlingPolicy'
  metricId: 'string'
  rateLimitThreshold: int

属性值

namespaces/applicationGroups

名称 说明
name 资源名称

了解如何在 Bicep 中为子资源设置名称和类型。
字符串 (必需)
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型为资源的符号名称: 命名空间
properties ApplicationGroupProperties

ApplicationGroupProperties

名称 说明
clientAppGroupIdentifier 应用程序组的唯一标识符。支持 SAS (SASKeyName=KeyName) 或 AAD (AADAppID=Guid) 字符串 (必需)
isEnabled 确定是否允许应用程序组创建与命名空间的连接。 将 isEnabled 设置为 false 后,将删除应用程序组的所有现有连接,并且不允许任何新连接 bool
策略 定义应用程序组行为的组策略列表。 这些策略可以支持资源治理方案,例如限制入口或出口流量。 ApplicationGroupPolicy[]

ApplicationGroupPolicy

名称 说明
name 此策略的名称 字符串 (必需)
类型 设置对象类型 ThrottlingPolicy (必需)

ThrottlingPolicy

名称 说明 Value
type 应用程序组策略类型 “ThrottlingPolicy” (必需)
metricId 应设置限制的指标 ID,可以通过将鼠标悬停在 Azure 门户内事件中心命名空间的“指标”部分中的“指标”部分中的指标上来发现 MetricId “IncomingBytes”
“IncomingMessages”
“OutgoingBytes”
“OutgoingMessages” (必需)
rateLimitThreshold 超过此限制的应用程序组将受到限制的阈值限制。速率限制始终为每秒。 int (必需)

ARM 模板资源定义

命名空间/applicationGroups 资源类型可以使用面向以下对象的操作进行部署:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.EventHub/namespaces/applicationGroups 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.EventHub/namespaces/applicationGroups",
  "apiVersion": "2024-01-01",
  "name": "string",
  "properties": {
    "clientAppGroupIdentifier": "string",
    "isEnabled": "bool",
    "policies": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see ApplicationGroupPolicy objects
      }
    ]
  }
}

ApplicationGroupPolicy 对象

设置 type 属性以指定对象的类型。

对于 ThrottlingPolicy,请使用:

  "type": "ThrottlingPolicy",
  "metricId": "string",
  "rateLimitThreshold": "int"

属性值

namespaces/applicationGroups

名称 说明 Value
type 资源类型 'Microsoft.EventHub/namespaces/applicationGroups'
apiVersion 资源 API 版本 '2024-01-01'
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。
字符串 (必需)
properties ApplicationGroupProperties

ApplicationGroupProperties

名称 说明
clientAppGroupIdentifier 应用程序组的唯一标识符。支持 SAS (SASKeyName=KeyName) 或 AAD (AADAppID=Guid) 字符串 (必需)
isEnabled 确定是否允许应用程序组创建与命名空间的连接。 isEnabled 设置为 false 后,将删除应用程序组的所有现有连接,并且不允许任何新连接 bool
策略 定义应用程序组行为的组策略列表。 这些策略可以支持资源治理方案,例如限制入口或出口流量。 ApplicationGroupPolicy[]

ApplicationGroupPolicy

名称 说明
name 此策略的名称 字符串 (必需)
类型 设置对象类型 ThrottlingPolicy (必需)

ThrottlingPolicy

名称 说明 Value
type 应用程序组策略类型 需要“ThrottlingPolicy” ()
metricId 应设置限制的指标 ID,可以通过将鼠标悬停在 Azure 门户内事件中心命名空间的“指标”部分中的“指标”部分中的“指标”上来发现 MetricId “IncomingBytes”
“IncomingMessages”
“OutgoingBytes”
需要“OutgoingMessages” ()
rateLimitThreshold 超过此限制的应用程序组将受到限制的阈值限制。速率限制始终为每秒。 int (必需)

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 namespaces/applicationGroups 资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.EventHub/namespaces/applicationGroups 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventHub/namespaces/applicationGroups@2024-01-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      clientAppGroupIdentifier = "string"
      isEnabled = bool
      policies = [
        {
          name = "string"
          type = "string"
          // For remaining properties, see ApplicationGroupPolicy objects
        }
      ]
    }
  })
}

ApplicationGroupPolicy 对象

设置 type 属性以指定对象的类型。

对于 ThrottlingPolicy,请使用:

  type = "ThrottlingPolicy"
  metricId = "string"
  rateLimitThreshold = int

属性值

namespaces/applicationGroups

名称 说明 Value
type 资源类型 “Microsoft.EventHub/namespaces/applicationGroups@2024-01-01”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源的 ID。 类型为:命名空间的资源的 ID
properties ApplicationGroupProperties

ApplicationGroupProperties

名称 说明
clientAppGroupIdentifier 应用程序组的唯一标识符。支持 SAS (SASKeyName=KeyName) 或 AAD (AADAppID=Guid) 字符串 (必需)
isEnabled 确定是否允许应用程序组创建与命名空间的连接。 isEnabled 设置为 false 后,将删除应用程序组的所有现有连接,并且不允许任何新连接 bool
策略 定义应用程序组行为的组策略列表。 这些策略可以支持资源治理方案,例如限制入口或出口流量。 ApplicationGroupPolicy[]

ApplicationGroupPolicy

名称 说明
name 此策略的名称 字符串 (必需)
类型 设置对象类型 ThrottlingPolicy (必需)

ThrottlingPolicy

名称 说明 Value
type 应用程序组策略类型 需要“ThrottlingPolicy” ()
metricId 应设置限制的指标 ID,可以通过将鼠标悬停在 Azure 门户内事件中心命名空间的“指标”部分中的“指标”部分中的“指标”上来发现 MetricId “IncomingBytes”
“IncomingMessages”
“OutgoingBytes”
“OutgoingMessages” (必需)
rateLimitThreshold 超过此限制的应用程序组将受到限制的阈值限制。速率限制始终为每秒。 int (必需)