アプリケーショングループを使用してクライアントアプリケーションのリソースを管理する

[アーティクル]
03/09/2023

Azure Event Hubs を使用すると、アプリケーショングループを使用して Event Hubs に接続するクライアントアプリケーションのイベントストリーミングワークロードを管理することができます。詳細については、「アプリケーショングループを使用したリソース管理」を参照してください。

この記事では、次のタスクを実行する方法について説明します。

アプリケーショングループを作成します。
アプリケーショングループを有効または無効にする
しきい値の制限を定義し、アプリケーショングループに調整ポリシーを適用する
診断ログを使用して調整を検証する

注意

アプリケーショングループは、Premium レベルと Dedicated レベルでのみ使用できます。

アプリケーショングループを作成する

このセクションでは、Azure portal、CLI、PowerShell、Azure Resource Manager (ARM) テンプレートを使用してアプリケーショングループを作成する方法について説明します。

次の手順に従って、Azure portal を使用してアプリケーショングループを作成できます。

Event Hubs 名前空間に移動します。
左側のメニューの [設定] で [アプリケーショングループ] を選択します。
[アプリケーショングループ] ページで、コマンドバーにある [+ アプリケーショングループ] を選択します。
[アプリケーショングループの追加] ページで、以下の操作を行います。
1. アプリケーショングループの [名前] を指定します。
2. [有効] が選択されていることを確認します。最初にアプリケーショングループを無効状態にするには、[有効] オプションをオフにします。このフラグは、アプリケーショングループのクライアントが Event Hubs にアクセスできるかどうかを決定します。
3. [セキュリティコンテキストの種類] で、[名前空間の共有アクセスポリシー]、[イベントハブの共有アクセスポリシー]、または [Microsoft Entra アプリケーション] を選択します。アプリケーショングループでは、名前空間またはエンティティ (イベントハブ) レベルでの SAS キーの選択がサポートされます。アプリケーショングループを作成するときは、クライアントアプリケーションで使用される共有アクセス署名 (SAS) または Microsoft Entra アプリケーション ID のいずれかに関連付ける必要があります。
4. [名前空間の共有アクセスポリシー] を選択した場合:
  1. [SAS key name] (SAS キー名) には、このアプリケーショングループのセキュリティコンテキストとして使用できる SAS ポリシーを選択します。 [SAS ポリシーの追加] を選択して、新しいポリシーを追加し、アプリケーショングループに関連付けることができます。
5. [Event Hubs の共有アクセスポリシー] を選択した場合:
  1. [SAS キー名] には、Event Hubs の [共有アクセスポリシー] ページから SAS ポリシー名をコピーし、テキストボックスに貼り付けます
6. Microsoft Entra アプリケーションを選択した場合:
  1. Microsoft Entra Application (クライアント) ID には、Microsoft Entra アプリケーションまたはクライアント ID を指定します。

サポートされているセキュリティコンテキストの種類

自動生成された [Client group ID] (クライアントグループ ID) (アプリケーショングループに関連付けられている一意の ID) を確認します。アプリケーションガバナンスのスコープ (名前空間またはエンティティレベル) は、使用される Microsoft Entra アプリケーション ID のアクセスレベルによって異なります。次の表は、さまざまなセキュリティコンテキストの種類に対して自動生成されたクライアントグループ ID を示しています。

セキュリティコンテキストの種類	自動生成されたクライアントグループ ID
名前空間の共有アクセスキー	`NamespaceSASKeyName=<NamespaceLevelKeyName>`
Microsoft Entra アプリケーション	`AADAppID=<AppID>`
Event Hubs の共有アクセスキー	`EntitySASKeyName=<EntityLevelKeyName>`

Note

名前空間の共有アクセスキーを使用して作成されたすべての既存のアプリケーショングループは、SASKeyName 以降のクライアントグループ ID で引き続き動作します。ただし、上記のように、すべての新しいアプリケーショングループに、更新されたクライアントグループ ID が設定されます。

ポリシーを追加するには、次の手順に従います。
1. ポリシーの [名前] を入力します。
2. [種類] には、[調整ポリシー] を選択します。
3. [メトリック ID] には、次のいずれかのオプションを選択します: [受信メッセージ]、[送信メッセージ]、[着信バイト数]、[発信バイト数]。次の例では、[受信メッセージ] が選択されています。
4. [レート制限のしきい値] には、しきい値を入力します。次の例では、受信メッセージ数のしきい値として 10000 が指定されています。
  
  別のポリシーが追加されたページのスクリーンショットを次に示します。
次に、[アプリケーショングループの追加] ページで、[追加] を選択します。
アプリケーショングループの一覧にアプリケーショングループが表示されていることを確認します。

一覧内のアプリケーショングループの横にあるごみ箱アイコンボタンを選択すると、一覧からアプリケーショングループを削除できます。

CLI コマンド az eventhubs namespace application-group create を使用して、Event Hubs 名前空間または Event Hubs レベルでアプリケーショングループを作成します。選択するセキュリティコンテキストの種類に基づいて、-client-app-group-identifier を設定する必要があります。サポートされているセキュリティコンテキストの種類については、上記の表を確認してください

次の例では、Azure リソースグループ MyResourceGroup 内の名前空間 mynamespace に myAppGroup という名前のアプリケーショングループを作成します。次の構成を使用します。

共有アクセスポリシーがセキュリティコンテキストとして使用されます。
クライアントアプリグループ ID が NamespaceSASKeyName=<NameOfTheSASkey> に設定されます。
Incoming messages メトリックの最初の調整ポリシーでは、しきい値は 10000 です。
Incoming bytes メトリックの 2 番目の調整ポリシーでは、しきい値は 20000 です。

az eventhubs namespace application-group create --namespace-name mynamespace \
                                                -g MyResourceGroup \
                                                --name myAppGroup \
                                                --client-app-group-identifier NamespaceSASKeyName=keyname \
                                                --throttling-policy-config name=policy1 metric-id=IncomingMessages rate-limit-threshold=10000 \
                                                --throttling-policy-config name=policy2 metric-id=IncomingBytes rate-limit-threshold=20000

CLI コマンドの詳細については、「az eventhubs namespace application-group create」を参照してください。

PowerShell コマンド New-AzEventHubApplicationGroup を使用して、Event Hubs 名前空間または Event Hubs レベルでアプリケーショングループを作成します。選択するセキュリティコンテキストの種類に基づいて、-ClientAppGroupIdentifier を設定する必要があります。サポートされているセキュリティコンテキストの種類については、上記の表を確認してください

次の例では、New-AzEventHubThrottlingPolicyConfig を使用して、アプリケーションに関連付けられる 2 つのポリシーを作成します。

Incoming bytes メトリックの最初の調整ポリシーでは、しきい値は 12345 です。
Incoming messages メトリックの 2 番目の調整ポリシーでは、しきい値は 23416 です。

次に、調整ポリシーと共有アクセスポリシーをセキュリティコンテキストとして指定することで、Azure リソースグループ myresourcegroup 内の名前空間 mynamespace に myappgroup という名前のアプリケーショングループを作成します。

$policy1 = New-AzEventHubThrottlingPolicyConfig -Name policy1 -MetricId IncomingBytes -RateLimitThreshold 12345

$policy2 = New-AzEventHubThrottlingPolicyConfig -Name policy2 -MetricId IncomingMessages -RateLimitThreshold 23416

New-AzEventHubApplicationGroup -ResourceGroupName myresourcegroup -NamespaceName mynamespace -Name myappgroup 
		-ClientAppGroupIdentifier NamespaceSASKeyName=myauthkey -ThrottlingPolicyConfig $policy1, $policy2

PowerShell コマンドの詳細については、「New-AzEventHubApplicationGroup」を参照してください。

次の例は、ARM テンプレートを使用してアプリケーショングループを作成する方法を示しています。この例では、アプリケーショングループは、クライアント AppGroupIdentifier を NamespaceSASKeyName=contososaspolicy として設定することで、既存の SAS ポリシー名 contososaspolicy に関連付けられます。アプリケーショングループポリシーは、ARM テンプレートでも定義されます。選択するセキュリティコンテキストの種類に基づいて、ClientAppGroupIdentifier を設定する必要があります。サポートされているセキュリティコンテキストの種類については、上記の表を確認してください

{
	"type": "ApplicationGroups",
	"apiVersion": "2022-01-01-preview",
	"name": "[parameters('applicationGroupName')]",
	"dependsOn": [
		"[resourceId('Microsoft.EventHub/namespaces/', parameters('eventHubNamespaceName'))]",
		"[resourceId('Microsoft.EventHub/namespaces/authorizationRules', parameters('eventHubNamespaceName'),parameters('namespaceAuthorizationRuleName'))]"
	],
	"properties": {
		"ClientAppGroupIdentifier": "NamespaceSASKeyName=contososaspolicy",
		"policies": [{
				"Type": "ThrottlingPolicy",
				"Name": "ThrottlingPolicy1",
				"metricId": "IncomingMessages",
				"rateLimitThreshold": 10
			},
			{
				"Type": "ThrottlingPolicy",
				"Name": "ThrottlingPolicy2",
				"metricId": "IncomingBytes",
				"rateLimitThreshold": 3951729
			}
		],
		"isEnabled": true
	}
}

アプリケーショングループを有効または無効にする

クライアントアプリケーションが Event Hubs 名前空間にアクセスできないようにするには、それらのアプリケーションを含むアプリケーショングループを無効にします。アプリケーショングループを無効にすると、クライアントアプリケーションはデータを発行または使用できなくなります。そのアプリケーショングループのクライアントアプリケーションから確立されているすべての接続が終了します。

このセクションでは、Azure portal、PowerShell、CLI、ARM テンプレートを使用してアプリケーショングループを有効または無効にする方法について説明します。

[Event Hubs 名前空間] ページで、左側のメニューの [アプリケーショングループ] を選択します。
有効または無効にするアプリケーショングループを選択します。
[Edit application group] (アプリケーショングループの編集) ページで、[有効] の横にあるチェックボックスをオフにしてアプリケーショングループを無効にしてから、ページの下部にある [更新] を選択します。同様に、チェックボックスをオンにしてアプリケーショングループを有効にします。

アプリケーショングループを無効にするには、--is-enabled を false に設定した状態で az eventhubs namespace application-group update コマンドを使用します。同様に、アプリケーショングループを有効にするには、このプロパティを true に設定し、コマンドを実行します。

次のサンプルコマンドは、リソースグループ myresourcegroup 内にある Event Hubs 名前空間 mynamespace で、myappgroup という名前のアプリケーショングループを無効にします。

az eventhubs namespace application-group update --namespace-name mynamespace -g myresourcegroup --name myappgroup --is-enabled false

アプリケーショングループを無効にするには、-IsEnabled を false に設定した状態で Set-AzEventHubApplicationGroup コマンドを使用します。同様に、アプリケーショングループを有効にするには、このプロパティを true に設定し、コマンドを実行します。

Set-AzEventHubApplicationGroup -ResourceGroupName myresourcegroup -NamespaceName mynamespace -Name myappgroup -IsEnabled false

次の ARM テンプレートは、isEnabled プロパティを false に設定することにより、既存の名前空間 (contosonamespace) を更新してアプリケーショングループを無効にする方法を示しています。アプリグループの識別子は SASKeyName=RootManageSharedAccessKey です。

Note

次のサンプルは、2 つの調整ポリシーも追加します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "namespace_name": {
      "defaultValue": "contosonamespace",
      "type": "String"
    },
    "client-app-group-identifier": {
      "defaultValue": "SASKeyName=RootManageSharedAccessKey",
      "type": "String"
    }
  },
  "resources": [
    {
      "type": "Microsoft.EventHub/namespaces/applicationGroups",
      "apiVersion": "2022-01-01-preview",
      "name": "[concat(parameters('namespace_name'), '/contosoappgroup')]",
      "properties": {
        "clientAppGroupIdentifier": "[parameters('client-app-group-identifier')]",
        "isEnabled": false,
		"policies": [
			{
				"type": "ThrottlingPolicy",
				"name": "incomingmsgspolicy",
				"metricId": "IncomingMessages",
				"rateLimitThreshold": 10000
			},
			{
				"type": "ThrottlingPolicy",
				"name": "incomingbytespolicy",
				"metricId": "IncomingBytes",
				"rateLimitThreshold": 20000
			}
		]
      }
    }
  ]
}

調整ポリシーを適用する

アプリケーショングループまたは既存のアプリケーショングループを作成するときに、0 個以上のポリシーを追加できます。たとえば、IncomingMessages、IncomingBytes、または OutgoingBytes に関連する調整ポリシーを contosoAppGroup に追加できます。これらのポリシーは、SAS ポリシー contososaspolicy を使用するクライアントアプリケーションのイベントストリーミングワークロードに適用されます。

アプリケーショングループの作成時にポリシーを追加する方法については、「アプリケーショングループを作成する」セクションを参照してください。

アプリケーショングループの作成後にポリシーを追加することもできます。

[Event Hubs 名前空間] ページで、左側のメニューの [アプリケーショングループ] を選択します。
ポリシーを追加、更新、または削除するアプリケーショングループを選択します。
[Edit application group] (アプリケーショングループの編集) ページで、次の手順を実行できます。
1. 既存のポリシーの設定 (しきい値を含む) を更新する
2. 新しいポリシーを追加する

az eventhubs namespace application-group policy add を使用して、既存のアプリケーショングループにポリシーを追加します。

例:

az eventhubs namespace application-group policy add --namespace-name mynamespace -g MyResourceGroup --name myAppGroup --throttling-policy-config name=policy1 metric-id=OutgoingMessages rate-limit-threshold=10500 --throttling-policy-config name=policy2 metric-id=IncomingBytes rate-limit-threshold=20000

-ThrottingPolicyConfig を適切な値に設定した状態で Set-AzEventHubApplicationGroup コマンドを使用します。

例:

$policyToBeAppended = New-AzEventHubThrottlingPolicyConfig -Name policy1 -MetricId IncomingBytes -RateLimitThreshold 12345

$appGroup = Get-AzEventHubApplicationGroup -ResourceGroupName myresourcegroup -NamespaceName mynamespace -Name myappgroup

$appGroup.ThrottlingPolicyConfig += $policyToBeAppended

Set-AzEventHubApplicationGroup -ResourceGroupName myresourcegroup -NamespaceName mynamespace -Name myappgroup -ThrottlingPolicyConfig $appGroup.ThrottlingPolicyConfig

次の ARM テンプレートは、既存の名前空間 (contosonamespace) を更新して調整ポリシーを追加する方法を示しています。アプリグループの識別子は NamespaceSASKeyName=RootManageSharedAccessKey です。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "namespace_name": {
      "defaultValue": "contosonamespace",
      "type": "String"
    },
    "client-app-group-identifier": {
      "defaultValue": "NamespaceSASKeyName=RootManageSharedAccessKey",
      "type": "String"
    }
  },
  "resources": [
    {
      "type": "Microsoft.EventHub/namespaces/applicationGroups",
      "apiVersion": "2022-01-01-preview",
      "name": "[concat(parameters('namespace_name'), '/contosoappgroup')]",
      "properties": {
        "clientAppGroupIdentifier": "[parameters('client-app-group-identifier')]",
        "isEnabled": true,
		"policies": [
			{
				"type": "ThrottlingPolicy",
				"name": "incomingmsgspolicy",
				"metricId": "IncomingMessages",
				"rateLimitThreshold": 10000
			},
			{
				"type": "ThrottlingPolicy",
				"name": "incomingbytespolicy",
				"metricId": "IncomingBytes",
				"rateLimitThreshold": 20000
			}
		]
      }
    }
  ]
}

調整ポリシーのしきい値を決定する

Azure Event Hubs では、アプリケーションメトリックログ機能をサポートして、システム内の通常のスループットを監視し、それに応じてアプリケーショングループのしきい値が決定されます。以下の手順に従って、しきい値を決定できます。

アプリケーションメトリックログを選択されたカテゴリとして Event Hubs で診断設定を有効にし、宛先として Log Analytics を選択します。
調整ポリシーを使用せずに空のアプリケーショングループを作成します。
通常のスループットで、イベントハブにメッセージやイベントを送信し続けます。
Log Analytics ワークスペースに移動し、AzureDiagnostics テーブルで適切なアクティビティ名 ((resource-governance-overview.md#throttling-policy---threshold-limits) に基づいた) のクエリを実行します。次のサンプルクエリは、受信メッセージのしきい値を追跡するように設定されています。
```
AzureDiagnostics 
    | where ActivityName_s =="IncomingMessages" 
    | where Outcome_s =="Success"      
```
Log Analytics ワークスペースで [グラフ] セクションを選択し、生成された時間を Y 軸、送信されたメッセージの数を X 軸とするグラフをプロットします。

この例では、通常のスループットでメッセージが 550 件を超えることはないということがわかります (予想される現在のスループット)。この観察は、実際のしきい値を定義する際に役立ちます。
しきい値を決定したら、アプリケーショングループ内に新しい調整ポリシーを追加します。

イベントを発行または使用する

アプリケーショングループに調整ポリシーを正常に追加したら、contosoAppGroup アプリケーショングループの一部であるクライアントアプリケーションを使用してイベントを発行または使用することで、調整動作をテストできます。テストするには、AMQP クライアントまたは Kafka クライアントアプリケーションと、アプリケーショングループの作成に使用されたものと同じ SAS ポリシー名または Microsoft Entra アプリケーション ID を使用できます。

Note

クライアントアプリケーションが調整されると、データの公開または使用が遅くなるはずです。

アプリケーショングループを使用して調整を検証する

調整ポリシーのしきい値制限の決定と同様に、アプリケーションメトリックログを使用して調整を検証し、詳細を見つけることができます。

次のクエリ例を使用して、特定の時間枠内のすべての調整された要求を確認できます。調整が予想される操作に一致するように ActivityName を更新する必要があります。


  AzureDiagnostics 
  |  where Category =="ApplicationMetricsLogs"
  | where ActivityName_s =="IncomingMessages" 
  | where Outcome_s =="Throttled"

プロトコルレベルの制限のため、調整された要求ログは、イベントハブ内のコンシューマー操作 (OutgoingMessages または OutgoingBytes) に対して生成されません。要求がコンシューマー側でスロットルされているときは、エグレススループットの低下が観察されます。

次の手順

アプリケーショングループの概念については、「アプリケーショングループを使用したリソースガバナンス」を参照してください。
Event Hubs の Azure PowerShell リファレンスを参照してください
Event Hubs の Azure CLI リファレンスを参照してください

次の方法で共有

アプリケーショングループを使用してクライアントアプリケーションのリソースを管理する

アプリケーショングループを作成する

サポートされているセキュリティコンテキストの種類

アプリケーショングループを有効または無効にする

調整ポリシーを適用する

調整ポリシーのしきい値を決定する

イベントを発行または使用する

アプリケーショングループを使用して調整を検証する

次の手順

フィードバック

その他のリソース

次の方法で共有

アプリケーション グループを使用してクライアント アプリケーションのリソースを管理する

アプリケーション グループを作成する

サポートされているセキュリティ コンテキストの種類

アプリケーション グループを有効または無効にする

調整ポリシーを適用する

調整ポリシーのしきい値を決定する

イベントを発行または使用する

アプリケーション グループを使用して調整を検証する

次の手順

フィードバック

その他のリソース

アプリケーショングループを使用してクライアントアプリケーションのリソースを管理する

アプリケーショングループを作成する

サポートされているセキュリティコンテキストの種類

アプリケーショングループを有効または無効にする

アプリケーショングループを使用して調整を検証する