Microsoft.EventHub 名前空間/applicationGroups

Bicep リソース定義

namespaces/applicationGroups リソースの種類は、次の対象にデプロイできます。

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

リソース形式

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

resource symbolicname 'Microsoft.EventHub/namespaces/applicationGroups@2022-01-01-preview' = {
  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 で子リソースの名前と型を設定する方法を参照してください。
string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。
型のリソースのシンボル名: 名前空間
properties ApplicationGroupProperties

ApplicationGroupProperties

名前 説明
clientAppGroupIdentifier アプリケーション グループの一意識別子。SAS(SASKeyName=KeyName) または AAD(AADAppID=Guid) をサポートします string (必須)
isEnabled アプリケーション グループが名前空間との接続を作成できるかどうかを決定します。 isEnabled を false に設定すると、アプリケーション グループのすべての既存の接続が削除され、新しい接続は許可されません [bool]
policies アプリケーション グループの動作を定義するグループ ポリシーの一覧。 これらのポリシーは、イングレスまたはエグレス トラフィックの制限などのリソース ガバナンス シナリオをサポートできます。 ApplicationGroupPolicy[]

ApplicationGroupPolicy

名前 説明
name このポリシーの名前 string (必須)
オブジェクトの種類を設定する ThrottlingPolicy (必須)

ThrottlingPolicy

名前 説明
type アプリケーションのグループ ポリシーの種類 'ThrottlingPolicy' (必須)
metricId スロットル制限を設定する必要があるメトリック ID。MetricId は、Azure Portal 内の Event Hub 名前空間の [メトリック] セクションで [メトリック] にカーソルを合わせると検出できます 'IncomingBytes'
'IncomingMessages'
'OutgoingBytes'
'OutgoingMessages' (必須)
rateLimitThreshold アプリケーション グループが調整されるしきい値の上限。レート制限は常に 1 秒あたりです。 int (必須)

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

namespaces/applicationGroups リソースの種類は、次の対象にデプロイできます。

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

リソース形式

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

{
  "type": "Microsoft.EventHub/namespaces/applicationGroups",
  "apiVersion": "2022-01-01-preview",
  "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

名前 説明
type リソースの種類 'Microsoft.EventHub/namespaces/applicationGroups'
apiVersion リソース API のバージョン '2022-01-01-preview'
name リソース名

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

ApplicationGroupProperties

名前 説明
clientAppGroupIdentifier アプリケーション グループの一意識別子。SAS(SASKeyName=KeyName) または AAD(AADAppID=Guid) をサポートします string (必須)
isEnabled アプリケーション グループが名前空間との接続を作成できるかどうかを決定します。 isEnabled を false に設定すると、アプリケーション グループのすべての既存の接続が削除され、新しい接続は許可されません [bool]
policies アプリケーション グループの動作を定義するグループ ポリシーの一覧。 これらのポリシーは、イングレスまたはエグレス トラフィックの制限などのリソース ガバナンス シナリオをサポートできます。 ApplicationGroupPolicy[]

ApplicationGroupPolicy

名前 説明
name このポリシーの名前 string (必須)
オブジェクトの種類を設定する ThrottlingPolicy (必須)

ThrottlingPolicy

名前 説明
type アプリケーションのグループ ポリシーの種類 'ThrottlingPolicy' (必須)
metricId スロットル制限を設定する必要があるメトリック ID。MetricId は、Azure Portal 内の Event Hub 名前空間の [メトリック] セクションで [メトリック] にカーソルを合わせると検出できます 'IncomingBytes'
'IncomingMessages'
'OutgoingBytes'
'OutgoingMessages' (必須)
rateLimitThreshold アプリケーション グループが調整されるしきい値の上限。レート制限は常に 1 秒あたりです。 int (必須)

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

namespaces/applicationGroups リソースの種類は、次の対象にデプロイできます。

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventHub/namespaces/applicationGroups@2022-01-01-preview"
  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

名前 説明
type リソースの種類 "Microsoft.EventHub/namespaces/applicationGroups@2022-01-01-preview"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 型のリソースの ID: 名前空間
properties ApplicationGroupProperties

ApplicationGroupProperties

名前 説明
clientAppGroupIdentifier アプリケーション グループの一意識別子。SAS(SASKeyName=KeyName) または AAD(AADAppID=Guid) をサポートします string (必須)
isEnabled アプリケーション グループが名前空間との接続を作成できるかどうかを決定します。 isEnabled を false に設定すると、アプリケーション グループのすべての既存の接続が削除され、新しい接続は許可されません [bool]
policies アプリケーション グループの動作を定義するグループ ポリシーの一覧。 これらのポリシーは、イングレスまたはエグレス トラフィックの制限などのリソース ガバナンス シナリオをサポートできます。 ApplicationGroupPolicy[]

ApplicationGroupPolicy

名前 説明
name このポリシーの名前 string (必須)
オブジェクトの種類を設定する ThrottlingPolicy (必須)

ThrottlingPolicy

名前 説明
type アプリケーションのグループ ポリシーの種類 "ThrottlingPolicy" (必須)
metricId スロットル制限を設定する必要があるメトリック ID。MetricId は、Azure Portal 内の Event Hub 名前空間の [メトリック] セクションで [メトリック] にカーソルを合わせると検出できます "IncomingBytes"
"IncomingMessages"
"OutgoingBytes"
"OutgoingMessages" (必須)
rateLimitThreshold アプリケーション グループが調整されるしきい値の上限。レート制限は常に 1 秒あたりです。 int (必須)