Microsoft.EventHub 名前空間/eventhubs 2018-01-01-preview
Bicep リソース定義
namespaces/eventhubs リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.EventHub/namespaces/eventhubs リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.EventHub/namespaces/eventhubs@2018-01-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
captureDescription: {
destination: {
name: 'string'
properties: {
archiveNameFormat: 'string'
blobContainer: 'string'
storageAccountResourceId: 'string'
}
}
enabled: bool
encoding: 'string'
intervalInSeconds: int
sizeLimitInBytes: int
skipEmptyArchives: bool
}
messageRetentionInDays: int
partitionCount: int
status: 'string'
}
}
プロパティ値
namespaces/eventhubs
名前 | 説明 | 値 |
---|---|---|
name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字数制限: 1 から 256 有効な文字: 英数字、ピリオド、ハイフン、およびアンダースコア。 先頭と末尾には、文字または数字を使用します。 |
parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部にある子リソース」を参照してください。 |
型のリソースのシンボル名: 名前空間 |
properties | イベント ハブの作成または更新操作に指定されたプロパティ。 | EventhubProperties |
EventhubProperties
名前 | 説明 | 値 |
---|---|---|
captureDescription | キャプチャの説明のプロパティ | CaptureDescription |
messageRetentionInDays | このイベント ハブのイベントを保持する日数。値は 1 日から 7 日にする必要があります | INT 制約: 最小値 = 1 |
partitionCount | イベント ハブ用に作成されたパーティションの数。使用できる値は 1 から 32 個のパーティションです。 | INT 制約: 最小値 = 1 |
status | イベント ハブの状態に使用できる値を列挙します。 | 'Active' 'Creating' '削除中' 'Disabled' 'ReceiveDisabled' '名前の変更' '復元中' 'SendDisabled' '不明' |
CaptureDescription
名前 | 説明 | 値 |
---|---|---|
destination | キャプチャが格納される Destination のプロパティ。 (ストレージ アカウント、BLOB 名) | 宛先 |
enabled | キャプチャの説明が有効かどうかを示す 値。 | [bool] |
encoding | キャプチャの説明のエンコード形式に使用できる値を列挙します。 注: 'AvroDeflate' は、新しい API バージョンでは非推奨になります | 'Avro' 'AvroDeflate' |
intervalInSeconds | 時間枠を使用すると、Azure BLOB へのキャプチャが発生する頻度を設定できます。値は 60 ~ 900 秒にする必要があります | INT 制約: 最小値 = 60 最大値 = 900 |
sizeLimitInBytes | [サイズ] ウィンドウでは、キャプチャ操作の前に Event Hub に構築されたデータの量を定義します。値は 10485760 から 524288000 バイトの間にする必要があります | INT 制約: 最小値 = 10485760 最大値 = 524288000 |
skipEmptyArchives | 空のアーカイブをスキップするかどうかを示す 値 | [bool] |
到着地
名前 | 説明 | 値 |
---|---|---|
name | キャプチャ先の名前 | string |
properties | キャプチャ先のストレージ アカウント、BLOB コンテナー、アーカイブ名の形式を記述するプロパティ | DestinationProperties |
DestinationProperties
名前 | 説明 | 値 |
---|---|---|
archiveNameFormat | アーカイブの BLOB 名前付け規則 (例: {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} など。 ここでは、順序に関係なく、すべてのパラメーター (名前空間、EventHub など) が必須です | string |
blobContainer | BLOB コンテナー名 | string |
storageAccountResourceId | BLOB の作成に使用するストレージ アカウントのリソース ID | string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
Azure Event Hubs用 PubNub Realtime Gateway |
Azure 用 PubNub Realtime Gateway は、PubNub データ Stream ネットワークとAzure Event Hubsの間のリアルタイム データ ストリーム ブリッジを提供します。 -- PubNub と Azure の間の双方向ブリッジと考えてください。 |
Azure アーキテクチャに Sports Analytics をデプロイする |
ADLS Gen 2 が有効になっている Azure ストレージ アカウント、ストレージ アカウント (デプロイされている場合は Azure SQL Database) のリンクされたサービスを持つAzure Data Factory インスタンス、および Azure Databricks インスタンスを作成します。 テンプレートをデプロイするユーザーの AAD ID と ADF インスタンスのマネージド ID には、ストレージ アカウントに対するストレージ BLOB データ共同作成者ロールが付与されます。 また、Azure Key Vault インスタンス、Azure SQL Database、Azure Event Hub (ストリーミングユース ケース用) をデプロイするオプションもあります。 Azure Key Vaultがデプロイされると、テンプレートをデプロイするユーザーのデータ ファクトリマネージド ID と AAD ID に、Key Vault シークレット ユーザー ロールが付与されます。 |
Moesif API Analytics と収益化 |
このテンプレートは、Azure API Management から Moesif API 分析と収益化プラットフォームへの API 呼び出しをログに記録します |
時間データ履歴接続を使用した Azure Digital Twins |
このテンプレートは、時系列データ履歴接続で構成された Azure Digital Twins インスタンスを作成します。 接続を作成するには、Event Hubs 名前空間、イベント ハブ、Azure Data Explorer クラスター、データベースなど、他のリソースを作成する必要があります。 データはイベント ハブに送信され、最終的には Azure Data Explorer クラスターにデータが転送されます。 データはクラスター内のデータベース テーブルに格納されます |
Event Grid カスタム トピックとイベント ハブ ハンドラーを作成する |
イベントを処理Azure Event Gridカスタム トピックとイベント ハブを作成します。 |
EventHubs 名前空間、Event Hub、& コンシューマー グループを作成する |
このテンプレートを使用すると、Event Hubs Standard 名前空間、イベント ハブ、コンシューマー グループをデプロイできます。 |
EventHubs authorizationRules を作成する |
このテンプレートを使用すると、EventHubs Standard 名前空間、Event Hub、コンシューマー グループ、authorizationRules をデプロイできます |
Eventhub クラスターを作成し、namesapce & eventhub |
このテンプレートを使用すると、EventHubs クラスター、名前空間、および eventhub をクラスターに作成できます |
キャプチャを有効にして EventHubs を作成する |
このテンプレートを使用すると、イベント ハブを使用して EventHubs 名前空間をデプロイし、その上でキャプチャを有効にできます |
キャプチャを有効にして EventHubs を作成する (ADLS) |
このテンプレートを使用すると、イベント ハブを使用して EventHubs 名前空間をデプロイし、その上でキャプチャを有効にできます |
EventHubs 名前空間を作成し、自動インフレを有効にする |
このテンプレートを使用すると、Event Hubs Standard 名前空間、イベント ハブ、コンシューマー グループをデプロイできます。このテンプレートでは、名前空間の自動インフレ機能も有効になります。 |
イベント ハブの作成 |
このテンプレートを使用すると、イベント ハブを使用して EventHubs 名前空間をデプロイできます。 |
プライベート エンドポイントを使用して Event Hubs 名前空間に接続する |
このサンプルでは、仮想ネットワークとプライベート DNS ゾーンを構成して、プライベート エンドポイント経由で Event Hubs 名前空間にアクセスする方法を示します。 |
MedTech サービスをデプロイする |
MedTech サービスは、複数のデバイスからデバイス データを取り込み、デバイス データを FHIR Observations に変換し、Azure Health Data Services FHIR サービスに永続化するように設計された Azure Health Data Services の 1 つです。 |
Azure IoT Hubを含む MedTech サービスをデプロイする |
MedTech サービスは、複数のデバイスからデバイス データを取り込み、デバイス データを FHIR Observations に変換し、Azure Health Data Services FHIR サービスに永続化するように設計された Azure Health Data Services の 1 つです。 |
Event Hub 接続を使用して Azure Data Explorer db をデプロイする |
Event Hub 接続を使用して Azure Data Explorer db をデプロイします。 |
監査がイベント ハブに書き込まれた Azure SQL Server |
このテンプレートを使用すると、監査が有効になっているAzure SQL サーバーをデプロイして、イベント ハブに監査ログを書き込むことができます |
ログとメトリックの送信を構成して SQL MI を作成する |
このテンプレートを使用すると、SQL MI と、ログとメトリック (診断ワークスペース、ストレージ アカウント、イベント ハブ) の格納に使用される追加のリソースをデプロイできます。 |
Event Hub イベント ソースを使用して環境を作成する |
このテンプレートを使用すると、イベント ハブからのイベントを使用するように構成された Time Series Insights 環境をデプロイできます。 |
イベント ハブとマネージド ID を使用した Azure 関数アプリ |
彼のテンプレートは、Event Hub、Azure Storage、Application Insights と共に、Linux 従量課金プランに Azure 関数アプリをプロビジョニングします。 関数アプリは、マネージド ID を使用してイベント ハブとストレージ アカウントに接続できます |
ARM テンプレート リソース定義
namespaces/eventhubs リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.EventHub/namespaces/eventhubs リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.EventHub/namespaces/eventhubs",
"apiVersion": "2018-01-01-preview",
"name": "string",
"properties": {
"captureDescription": {
"destination": {
"name": "string",
"properties": {
"archiveNameFormat": "string",
"blobContainer": "string",
"storageAccountResourceId": "string"
}
},
"enabled": "bool",
"encoding": "string",
"intervalInSeconds": "int",
"sizeLimitInBytes": "int",
"skipEmptyArchives": "bool"
},
"messageRetentionInDays": "int",
"partitionCount": "int",
"status": "string"
}
}
プロパティ値
namespaces/eventhubs
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.EventHub/namespaces/eventhubs' |
apiVersion | リソース API のバージョン | '2018-01-01-preview' |
name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字制限: 1 から 256 有効な文字: 英数字、ピリオド、ハイフン、およびアンダースコア。 先頭と末尾には、文字または数字を使用します。 |
properties | イベント ハブの作成または更新操作に指定されたプロパティ。 | EventhubProperties |
EventhubProperties
名前 | 説明 | 値 |
---|---|---|
captureDescription | キャプチャの説明のプロパティ | CaptureDescription |
messageRetentionInDays | このイベント ハブのイベントを保持する日数。値は 1 ~ 7 日にする必要があります | INT 制約: 最小値 = 1 |
partitionCount | Event Hub 用に作成されたパーティションの数。使用できる値は 1 から 32 個のパーティションです。 | INT 制約: 最小値 = 1 |
status | イベント ハブの状態に使用できる値を列挙します。 | 'Active' 'Creating' '削除中' 'Disabled' 'ReceiveDisabled' '名前の変更' '復元中' 'SendDisabled' '不明' |
CaptureDescription
名前 | 説明 | 値 |
---|---|---|
destination | キャプチャが格納される Destination のプロパティ。 (ストレージ アカウント、BLOB 名) | 宛先 |
enabled | キャプチャの説明が有効かどうかを示す値。 | [bool] |
encoding | キャプチャの説明のエンコード形式に使用できる値を列挙します。 注: "AvroDeflate" は、新しい API バージョンでは非推奨になります | 'Avro' 'AvroDeflate' |
intervalInSeconds | 時間枠を使用すると、Azure BLOB へのキャプチャが発生する頻度を設定できます。値は 60 から 900 秒の間である必要があります | INT 制約: 最小値 = 60 最大値 = 900 |
sizeLimitInBytes | サイズ ウィンドウでは、キャプチャ操作の前に Event Hub に組み込まれるデータの量が定義されます。値は10485760から524288000 バイトの間にする必要があります | INT 制約: 最小値 = 10485760 最大値 = 524288000 |
skipEmptyArchives | 空のアーカイブをスキップするかどうかを示す値 | [bool] |
到着地
名前 | 説明 | 値 |
---|---|---|
name | キャプチャ先の名前 | string |
properties | キャプチャ先のストレージ アカウント、BLOB コンテナー、アーカイブ名の形式を記述するプロパティ | DestinationProperties |
DestinationProperties
名前 | 説明 | 値 |
---|---|---|
archiveNameFormat | アーカイブの BLOB の名前付け規則 ({Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} など)。 ここでは、順序に関係なく、すべてのパラメーター (名前空間、EventHub など) が必須です | string |
blobContainer | BLOB コンテナー名 | string |
storageAccountResourceId | BLOB の作成に使用するストレージ アカウントのリソース ID | string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
Azure Event Hubs用 PubNub Realtime Gateway |
Azure 用 PubNub Realtime Gateway は、PubNub Data Stream Network と Azure Event Hubsの間のリアルタイム データ ストリーム ブリッジを提供します。 -- PubNub と Azure の間の双方向ブリッジと考えてください。 |
Azure アーキテクチャで Sports Analytics をデプロイする |
ADLS Gen 2 が有効な Azure ストレージ アカウント、ストレージ アカウント (デプロイされている場合はAzure SQL Database) のリンクされたサービスを持つAzure Data Factory インスタンス、および Azure Databricks インスタンスを作成します。 テンプレートをデプロイするユーザーの AAD ID と ADF インスタンスのマネージド ID には、ストレージ アカウントに対するストレージ BLOB データ共同作成者ロールが付与されます。 また、Azure Key Vault インスタンス、Azure SQL Database、Azure Event Hub (ストリーミング ユース ケース用) をデプロイするオプションもあります。 Azure Key Vaultがデプロイされると、テンプレートをデプロイするユーザーのデータ ファクトリマネージド ID と AAD ID に、Key Vault シークレット ユーザー ロールが付与されます。 |
Moesif API Analytics と収益化 |
テンプレートは、Azure API Management から Moesif API 分析と収益化プラットフォームへの API 呼び出しをログに記録します |
時間データ履歴接続を使用した Azure Digital Twins |
このテンプレートは、時系列データ履歴接続で構成された Azure Digital Twins インスタンスを作成します。 接続を作成するには、Event Hubs 名前空間、イベント ハブ、Azure Data Explorer クラスター、データベースなどの他のリソースを作成する必要があります。 データはイベント ハブに送信され、最終的には Azure Data Explorer クラスターにデータが転送されます。 データはクラスター内のデータベース テーブルに格納されます |
Event Grid カスタム トピックとイベント ハブ ハンドラーを作成する |
イベントを処理Azure Event Gridカスタム トピックとイベント ハブを作成します。 |
EventHubs 名前空間、Event Hub、& コンシューマー グループを作成する |
このテンプレートを使用すると、Event Hubs Standard 名前空間、イベント ハブ、コンシューマー グループをデプロイできます。 |
EventHubs authorizationRules を作成する |
このテンプレートを使用すると、EventHubs Standard 名前空間、Event Hub、コンシューマー グループ、authorizationRules をデプロイできます |
Eventhub クラスターを作成し、namesapce & eventhub |
このテンプレートを使用すると、EventHubs クラスター、名前空間、および eventhub をクラスターに作成できます |
キャプチャを有効にして EventHubs を作成する |
このテンプレートを使用すると、イベント ハブを使用して EventHubs 名前空間をデプロイし、その上でキャプチャを有効にできます |
キャプチャを有効にして EventHubs を作成する (ADLS) |
このテンプレートを使用すると、イベント ハブを使用して EventHubs 名前空間をデプロイし、その上でキャプチャを有効にできます |
EventHubs 名前空間を作成し、自動インフレを有効にする |
このテンプレートを使用すると、Event Hubs Standard 名前空間、イベント ハブ、コンシューマー グループをデプロイできます。このテンプレートでは、名前空間の自動インフレ機能も有効になります。 |
イベント ハブの作成 |
このテンプレートを使用すると、イベント ハブを使用して EventHubs 名前空間をデプロイできます。 |
プライベート エンドポイントを使用して Event Hubs 名前空間に接続する |
このサンプルでは、仮想ネットワークとプライベート DNS ゾーンを構成して、プライベート エンドポイント経由で Event Hubs 名前空間にアクセスする方法を示します。 |
MedTech サービスをデプロイする |
MedTech サービスは、複数のデバイスからデバイス データを取り込み、デバイス データを FHIR 監視に変換し、Azure Health Data Services FHIR サービスに保持するように設計された Azure Health Data Services の 1 つです。 |
Azure IoT Hubを含む MedTech サービスをデプロイする |
MedTech サービスは、複数のデバイスからデバイス データを取り込み、デバイス データを FHIR 監視に変換し、Azure Health Data Services FHIR サービスに保持するように設計された Azure Health Data Services の 1 つです。 |
Event Hub 接続を使用して Azure Data Explorer db をデプロイする |
Event Hub 接続を使用して Azure Data Explorer db をデプロイします。 |
Event Hub に書き込まれた監査を使用したサーバーのAzure SQL |
このテンプレートを使用すると、監査が有効になっているAzure SQL サーバーをデプロイして、監査ログを Event Hub に書き込むことができます |
ログとメトリックの送信が構成された SQL MI を作成する |
このテンプレートを使用すると、SQL MI と、ログとメトリック (診断ワークスペース、ストレージ アカウント、イベント ハブ) の格納に使用される追加のリソースをデプロイできます。 |
Event Hub イベント ソースを使用して環境を作成する |
このテンプレートを使用すると、イベント ハブからのイベントを使用するように構成された Time Series Insights 環境をデプロイできます。 |
イベント ハブとマネージド ID を使用した Azure 関数アプリ |
彼のテンプレートは、Azure Function アプリを Linux 従量課金プランに、Event Hub、Azure Storage、Application Insights と共にプロビジョニングします。 関数アプリは、マネージド ID を使用して Event Hub と Storage アカウントに接続できます |
Terraform (AzAPI プロバイダー) リソース定義
名前空間/eventhubs リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.EventHub/namespaces/eventhubs リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventHub/namespaces/eventhubs@2018-01-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
captureDescription = {
destination = {
name = "string"
properties = {
archiveNameFormat = "string"
blobContainer = "string"
storageAccountResourceId = "string"
}
}
enabled = bool
encoding = "string"
intervalInSeconds = int
sizeLimitInBytes = int
skipEmptyArchives = bool
}
messageRetentionInDays = int
partitionCount = int
status = "string"
}
})
}
プロパティ値
namespaces/eventhubs
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.EventHub/namespaces/eventhubs@2018-01-01-preview" |
name | リソース名 | string (必須) 文字制限: 1 から 256 有効な文字: 英数字、ピリオド、ハイフン、およびアンダースコア。 先頭と末尾には、文字または数字を使用します。 |
parent_id | このリソースの親であるリソースの ID。 | 型のリソースの ID: 名前空間 |
properties | イベント ハブの作成または更新操作に指定されたプロパティ。 | EventhubProperties |
EventhubProperties
名前 | 説明 | 値 |
---|---|---|
captureDescription | キャプチャの説明のプロパティ | CaptureDescription |
messageRetentionInDays | このイベント ハブのイベントを保持する日数。値は 1 ~ 7 日にする必要があります | INT 制約: 最小値 = 1 |
partitionCount | Event Hub 用に作成されたパーティションの数。使用できる値は 1 から 32 個のパーティションです。 | INT 制約: 最小値 = 1 |
status | イベント ハブの状態に使用できる値を列挙します。 | "アクティブ" "作成中" "削除中" "無効" "ReceiveDisabled" "名前の変更" "復元中" "SendDisabled" "Unknown" |
CaptureDescription
名前 | 説明 | 値 |
---|---|---|
destination | キャプチャが格納される Destination のプロパティ。 (ストレージ アカウント、BLOB 名) | 宛先 |
enabled | キャプチャの説明が有効かどうかを示す値。 | [bool] |
encoding | キャプチャの説明のエンコード形式に使用できる値を列挙します。 注: "AvroDeflate" は、新しい API バージョンでは非推奨になります | "Avro" "AvroDeflate" |
intervalInSeconds | 時間枠を使用すると、Azure BLOB へのキャプチャが発生する頻度を設定できます。値は 60 から 900 秒の間である必要があります | INT 制約: 最小値 = 60 最大値 = 900 |
sizeLimitInBytes | サイズ ウィンドウでは、キャプチャ操作の前に Event Hub に組み込まれるデータの量が定義されます。値は10485760から524288000 バイトの間にする必要があります | INT 制約: 最小値 = 10485760 最大値 = 524288000 |
skipEmptyArchives | 空のアーカイブをスキップするかどうかを示す値 | [bool] |
到着地
名前 | 説明 | 値 |
---|---|---|
name | キャプチャ先の名前 | string |
properties | キャプチャ先のストレージ アカウント、BLOB コンテナー、アーカイブ名の形式を記述するプロパティ | DestinationProperties |
DestinationProperties
名前 | 説明 | 値 |
---|---|---|
archiveNameFormat | アーカイブの BLOB の名前付け規則 ({Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} など)。 ここでは、順序に関係なく、すべてのパラメーター (名前空間、EventHub など) が必須です | string |
blobContainer | BLOB コンテナー名 | string |
storageAccountResourceId | BLOB の作成に使用するストレージ アカウントのリソース ID | string |