Microsoft.EventHub namespaces/eventhubs 2022-10-01-preview
Bicep リソース定義
名前空間/eventhubs リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.EventHub/namespaces/eventhubs リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.EventHub/namespaces/eventhubs@2022-10-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
captureDescription: {
destination: {
name: 'string'
properties: {
archiveNameFormat: 'string'
blobContainer: 'string'
dataLakeAccountName: 'string'
dataLakeFolderPath: 'string'
dataLakeSubscriptionId: 'string'
storageAccountResourceId: 'string'
}
}
enabled: bool
encoding: 'string'
intervalInSeconds: int
sizeLimitInBytes: int
skipEmptyArchives: bool
}
messageRetentionInDays: int
partitionCount: int
retentionDescription: {
cleanupPolicy: 'string'
retentionTimeInHours: int
tombstoneRetentionTimeInHours: int
}
status: 'string'
}
}
プロパティ値
CaptureDescription
名前 | 形容 | 価値 |
---|---|---|
行き先 | キャプチャが格納される Destination のプロパティ。 (ストレージ アカウント、BLOB 名) | Destination |
有効 | キャプチャの説明が有効かどうかを示す値。 | bool |
エンコーディング | キャプチャの説明のエンコード形式に使用できる値を列挙します。 注: 'AvroDeflate' は新しい API バージョンで非推奨になります | 'Avro' 'AvroDeflate' |
intervalInSeconds | 時間枠を使用すると、Azure BLOB へのキャプチャの頻度を設定できます。値は 60 ~ 900 秒にする必要があります | int |
sizeLimitInBytes | サイズ ウィンドウは、キャプチャ操作の前にイベント ハブに構築されたデータの量を定義します。値は10485760から524288000 バイトの間にする必要があります | int |
skipEmptyArchives | 空のアーカイブをスキップするかどうかを示す値 | bool |
行き先
名前 | 形容 | 価値 |
---|---|---|
名前 | キャプチャ先の名前 | 糸 |
プロパティ | キャプチャ先のストレージ アカウント、BLOB コンテナー、アーカイブ名の形式を記述するプロパティ | DestinationProperties を |
DestinationProperties
名前 | 形容 | 価値 |
---|---|---|
archiveNameFormat | アーカイブの BLOB 名前付け規則 ({Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} など)。 ここでは、順序に関係なく、すべてのパラメーター (Namespace、EventHub など) が必須です | 糸 |
blobContainer | BLOB コンテナー名 | 糸 |
dataLakeAccountName | キャプチャされたイベントの Azure Data Lake Store 名 | 糸 |
dataLakeFolderPath | キャプチャされたイベントの宛先フォルダー パス | 糸 |
dataLakeSubscriptionId | Azure Data Lake Store のサブスクリプション ID | 糸 制約: 最小長 = 36 最大長 = 36 パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
storageAccountResourceId | BLOB の作成に使用するストレージ アカウントのリソース ID | 糸 |
EventhubProperties
名前 | 形容 | 価値 |
---|---|---|
captureDescription | キャプチャの説明のプロパティ | CaptureDescription |
messageRetentionInDays | このイベント ハブのイベントを保持する日数。値は 1 ~ 7 日にする必要があります | int 制約: 最小値 = 1 |
partitionCount | イベント ハブ用に作成されたパーティションの数。使用できる値は 1 から 32 個のパーティションです。 | int 制約: 最小値 = 1 |
retentionDescription | イベント ハブの保持設定 | RetentionDescription |
地位 | イベント ハブの状態に使用できる値を列挙します。 | 'Active' 'Creating' '削除中' 'Disabled' 'ReceiveDisabled' '名前の変更' '復元中' 'SendDisabled' 'Unknown' |
Microsoft.EventHub/namespaces/eventhubs
名前 | 形容 | 価値 |
---|---|---|
名前 | リソース名 | 糸 制約: 最小長 = 1 最大長 = 1 (必須) |
親 | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 |
種類のリソースのシンボリック名: 名前空間 |
プロパティ | イベント ハブの作成または更新操作に指定されたプロパティ。 | EventhubProperties の |
RetentionDescription
名前 | 形容 | 価値 |
---|---|---|
cleanupPolicy | クリーンアップ ポリシーで使用可能な値を列挙します。 | 'Compact' 'Delete' |
retentionTimeInHours | このイベント ハブのイベントを保持する時間数。 この値は、cleanupPolicy が Delete の場合にのみ使用されます。 cleanupPolicy が Compact の場合、このプロパティの戻り値は Long.MaxValue です | int |
tombstoneRetentionTimeInHours | 圧縮されたイベント ハブの廃棄石マーカーを保持する時間数。 この値は、cleanupPolicy が Compact の場合にのみ使用されます。 コンシューマーは、圧縮されたイベント ハブ内の廃棄石マーカーによって記述された特定のキーの有効なスナップショットを取得するようにオフセットの開始から開始する場合、この指定された時間内に廃棄石マーカーの読み取りを完了する必要があります | int |
クイック スタートのサンプル
次のクイック スタート サンプルでは、このリソースの種類をデプロイします。
Bicep ファイル | 形容 |
---|---|
時間データ履歴接続 を使用した Azure Digital Twins の |
このテンプレートは、時系列データ履歴接続で構成された Azure Digital Twins インスタンスを作成します。 接続を作成するには、Event Hubs 名前空間、イベント ハブ、Azure Data Explorer クラスター、データベースなどの他のリソースを作成する必要があります。 データはイベント ハブに送信され、最終的にデータが Azure Data Explorer クラスターに転送されます。 データはクラスター内のデータベース テーブルに格納されます |
Event Hub とマネージド ID を使用して Azure Function App を |
彼のテンプレートは、Linux 従量課金プランに Azure 関数アプリを、Event Hub、Azure Storage、Application Insights と共にプロビジョニングします。 関数アプリは、マネージド ID を使用してイベント ハブとストレージ アカウントに接続できます |
イベント ハブ を作成する | このテンプレートを使用すると、EventHubs 名前空間をイベント ハブと共にデプロイできます。 |
EventHubs 名前空間、Event Hub、& コンシューマー グループ を作成する | このテンプレートを使用すると、Event Hubs Standard 名前空間、イベント ハブ、およびコンシューマー グループをデプロイできます。 |
Eventhub クラスター、namesapce & eventhub を作成します | このテンプレートを使用すると、クラスター内に EventHubs クラスター、名前空間、および eventhub を作成できます |
Event Grid 接続 を使用して Azure Data Explorer db をデプロイ |
Event Grid 接続を使用して Azure Data Explorer db をデプロイします。 |
Event Hub 接続 を使用して Azure Data Explorer db をデプロイする | Event Hub 接続を使用して Azure Data Explorer db をデプロイします。 |
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 つです。 |
Azure アーキテクチャ に Sports Analytics をデプロイする |
ADLS Gen 2 が有効な Azure ストレージ アカウント、ストレージ アカウントのリンクされたサービスを持つ Azure Data Factory インスタンス (デプロイされている場合は Azure SQL Database)、Azure Databricks インスタンスを作成します。 テンプレートをデプロイするユーザーの AAD ID と ADF インスタンスのマネージド ID には、ストレージ アカウントのストレージ BLOB データ共同作成者ロールが付与されます。 Azure Key Vault インスタンス、Azure SQL Database、Azure Event Hub (ストリーミングユース ケース用) をデプロイするオプションもあります。 Azure Key Vault がデプロイされると、テンプレートをデプロイするユーザーのデータ ファクトリマネージド ID と AAD ID に Key Vault シークレット ユーザー ロールが付与されます。 |
WAF、ドメイン、ログを使用して EventHub に FrontDoor CDN を |
このテンプレートでは、新しい Azure FrontDoor cdn プロファイルが作成されます。 カスタムおよびマネージド ルール、CDN ルート、配信元、およびグループを WAF とルートとの関連付けを使用して WAF を作成し、カスタム ドメインを構成し、イベント ハブを使用して CDN アクセス ログを送信するためのイベント ハブと診断設定を作成します。 |
Moesif API Analytics と収益化の | このテンプレートは、Azure API Management から Moesif API 分析および収益化プラットフォームへの API 呼び出しをログに記録します |
ARM テンプレート リソース定義
名前空間/eventhubs リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.EventHub/namespaces/eventhubs リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.EventHub/namespaces/eventhubs",
"apiVersion": "2022-10-01-preview",
"name": "string",
"properties": {
"captureDescription": {
"destination": {
"name": "string",
"properties": {
"archiveNameFormat": "string",
"blobContainer": "string",
"dataLakeAccountName": "string",
"dataLakeFolderPath": "string",
"dataLakeSubscriptionId": "string",
"storageAccountResourceId": "string"
}
},
"enabled": "bool",
"encoding": "string",
"intervalInSeconds": "int",
"sizeLimitInBytes": "int",
"skipEmptyArchives": "bool"
},
"messageRetentionInDays": "int",
"partitionCount": "int",
"retentionDescription": {
"cleanupPolicy": "string",
"retentionTimeInHours": "int",
"tombstoneRetentionTimeInHours": "int"
},
"status": "string"
}
}
プロパティ値
CaptureDescription
名前 | 形容 | 価値 |
---|---|---|
行き先 | キャプチャが格納される Destination のプロパティ。 (ストレージ アカウント、BLOB 名) | Destination |
有効 | キャプチャの説明が有効かどうかを示す値。 | bool |
エンコーディング | キャプチャの説明のエンコード形式に使用できる値を列挙します。 注: 'AvroDeflate' は新しい API バージョンで非推奨になります | 'Avro' 'AvroDeflate' |
intervalInSeconds | 時間枠を使用すると、Azure BLOB へのキャプチャの頻度を設定できます。値は 60 ~ 900 秒にする必要があります | int |
sizeLimitInBytes | サイズ ウィンドウは、キャプチャ操作の前にイベント ハブに構築されたデータの量を定義します。値は10485760から524288000 バイトの間にする必要があります | int |
skipEmptyArchives | 空のアーカイブをスキップするかどうかを示す値 | bool |
行き先
名前 | 形容 | 価値 |
---|---|---|
名前 | キャプチャ先の名前 | 糸 |
プロパティ | キャプチャ先のストレージ アカウント、BLOB コンテナー、アーカイブ名の形式を記述するプロパティ | DestinationProperties を |
DestinationProperties
名前 | 形容 | 価値 |
---|---|---|
archiveNameFormat | アーカイブの BLOB 名前付け規則 ({Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} など)。 ここでは、順序に関係なく、すべてのパラメーター (Namespace、EventHub など) が必須です | 糸 |
blobContainer | BLOB コンテナー名 | 糸 |
dataLakeAccountName | キャプチャされたイベントの Azure Data Lake Store 名 | 糸 |
dataLakeFolderPath | キャプチャされたイベントの宛先フォルダー パス | 糸 |
dataLakeSubscriptionId | Azure Data Lake Store のサブスクリプション ID | 糸 制約: 最小長 = 36 最大長 = 36 パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
storageAccountResourceId | BLOB の作成に使用するストレージ アカウントのリソース ID | 糸 |
EventhubProperties
名前 | 形容 | 価値 |
---|---|---|
captureDescription | キャプチャの説明のプロパティ | CaptureDescription |
messageRetentionInDays | このイベント ハブのイベントを保持する日数。値は 1 ~ 7 日にする必要があります | int 制約: 最小値 = 1 |
partitionCount | イベント ハブ用に作成されたパーティションの数。使用できる値は 1 から 32 個のパーティションです。 | int 制約: 最小値 = 1 |
retentionDescription | イベント ハブの保持設定 | RetentionDescription |
地位 | イベント ハブの状態に使用できる値を列挙します。 | 'Active' 'Creating' '削除中' 'Disabled' 'ReceiveDisabled' '名前の変更' '復元中' 'SendDisabled' 'Unknown' |
Microsoft.EventHub/namespaces/eventhubs
名前 | 形容 | 価値 |
---|---|---|
apiVersion | API のバージョン | '2022-10-01-preview' |
名前 | リソース名 | 糸 制約: 最小長 = 1 最大長 = 1 (必須) |
プロパティ | イベント ハブの作成または更新操作に指定されたプロパティ。 | EventhubProperties の |
種類 | リソースの種類 | 'Microsoft.EventHub/namespaces/eventhubs' |
RetentionDescription
名前 | 形容 | 価値 |
---|---|---|
cleanupPolicy | クリーンアップ ポリシーで使用可能な値を列挙します。 | 'Compact' 'Delete' |
retentionTimeInHours | このイベント ハブのイベントを保持する時間数。 この値は、cleanupPolicy が Delete の場合にのみ使用されます。 cleanupPolicy が Compact の場合、このプロパティの戻り値は Long.MaxValue です | int |
tombstoneRetentionTimeInHours | 圧縮されたイベント ハブの廃棄石マーカーを保持する時間数。 この値は、cleanupPolicy が Compact の場合にのみ使用されます。 コンシューマーは、圧縮されたイベント ハブ内の廃棄石マーカーによって記述された特定のキーの有効なスナップショットを取得するようにオフセットの開始から開始する場合、この指定された時間内に廃棄石マーカーの読み取りを完了する必要があります | int |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
テンプレート | 形容 |
---|---|
時間データ履歴接続 を使用した Azure Digital Twins の Azure |
このテンプレートは、時系列データ履歴接続で構成された Azure Digital Twins インスタンスを作成します。 接続を作成するには、Event Hubs 名前空間、イベント ハブ、Azure Data Explorer クラスター、データベースなどの他のリソースを作成する必要があります。 データはイベント ハブに送信され、最終的にデータが Azure Data Explorer クラスターに転送されます。 データはクラスター内のデータベース テーブルに格納されます |
Event Hub とマネージド ID を使用して Azure Function App を Azure |
彼のテンプレートは、Linux 従量課金プランに Azure 関数アプリを、Event Hub、Azure Storage、Application Insights と共にプロビジョニングします。 関数アプリは、マネージド ID を使用してイベント ハブとストレージ アカウントに接続できます |
イベント ハブ を作成する Azure にデプロイする |
このテンプレートを使用すると、EventHubs 名前空間をイベント ハブと共にデプロイできます。 |
EventHubs 名前空間、Event Hub、& コンシューマー グループ を作成する Azure にデプロイする |
このテンプレートを使用すると、Event Hubs Standard 名前空間、イベント ハブ、およびコンシューマー グループをデプロイできます。 |
Eventhub クラスター、namesapce & eventhub を作成します Azure にデプロイする |
このテンプレートを使用すると、クラスター内に EventHubs クラスター、名前空間、および eventhub を作成できます |
Event Grid 接続 を使用して Azure Data Explorer db をデプロイ Azure |
Event Grid 接続を使用して Azure Data Explorer db をデプロイします。 |
Event Hub 接続 を使用して Azure Data Explorer db をデプロイする Azure にデプロイする |
Event Hub 接続を使用して Azure Data Explorer db をデプロイします。 |
MedTech サービス をデプロイする Azure にデプロイする |
MedTech サービスは、複数のデバイスからデバイス データを取り込み、デバイス データを FHIR Observations に変換し、Azure Health Data Services FHIR サービスに保持するように設計された Azure Health Data Services の 1 つです。 |
Azure IoT Hub を含む MedTech サービスをデプロイする Azure にデプロイする |
MedTech サービスは、複数のデバイスからデバイス データを取り込み、デバイス データを FHIR Observations に変換し、Azure Health Data Services FHIR サービスに保持するように設計された Azure Health Data Services の 1 つです。 |
Azure アーキテクチャ に Sports Analytics をデプロイする Azure |
ADLS Gen 2 が有効な Azure ストレージ アカウント、ストレージ アカウントのリンクされたサービスを持つ Azure Data Factory インスタンス (デプロイされている場合は Azure SQL Database)、Azure Databricks インスタンスを作成します。 テンプレートをデプロイするユーザーの AAD ID と ADF インスタンスのマネージド ID には、ストレージ アカウントのストレージ BLOB データ共同作成者ロールが付与されます。 Azure Key Vault インスタンス、Azure SQL Database、Azure Event Hub (ストリーミングユース ケース用) をデプロイするオプションもあります。 Azure Key Vault がデプロイされると、テンプレートをデプロイするユーザーのデータ ファクトリマネージド ID と AAD ID に Key Vault シークレット ユーザー ロールが付与されます。 |
WAF、ドメイン、ログを使用して EventHub に FrontDoor CDN を Azure |
このテンプレートでは、新しい Azure FrontDoor cdn プロファイルが作成されます。 カスタムおよびマネージド ルール、CDN ルート、配信元、およびグループを WAF とルートとの関連付けを使用して WAF を作成し、カスタム ドメインを構成し、イベント ハブを使用して CDN アクセス ログを送信するためのイベント ハブと診断設定を作成します。 |
Moesif API Analytics と収益化の Azure にデプロイする |
このテンプレートは、Azure API Management から Moesif API 分析および収益化プラットフォームへの API 呼び出しをログに記録します |
Terraform (AzAPI プロバイダー) リソース定義
名前空間/eventhubs リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.EventHub/namespaces/eventhubs リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventHub/namespaces/eventhubs@2022-10-01-preview"
name = "string"
body = jsonencode({
properties = {
captureDescription = {
destination = {
name = "string"
properties = {
archiveNameFormat = "string"
blobContainer = "string"
dataLakeAccountName = "string"
dataLakeFolderPath = "string"
dataLakeSubscriptionId = "string"
storageAccountResourceId = "string"
}
}
enabled = bool
encoding = "string"
intervalInSeconds = int
sizeLimitInBytes = int
skipEmptyArchives = bool
}
messageRetentionInDays = int
partitionCount = int
retentionDescription = {
cleanupPolicy = "string"
retentionTimeInHours = int
tombstoneRetentionTimeInHours = int
}
status = "string"
}
})
}
プロパティ値
CaptureDescription
名前 | 形容 | 価値 |
---|---|---|
行き先 | キャプチャが格納される Destination のプロパティ。 (ストレージ アカウント、BLOB 名) | Destination |
有効 | キャプチャの説明が有効かどうかを示す値。 | bool |
エンコーディング | キャプチャの説明のエンコード形式に使用できる値を列挙します。 注: 'AvroDeflate' は新しい API バージョンで非推奨になります | 'Avro' 'AvroDeflate' |
intervalInSeconds | 時間枠を使用すると、Azure BLOB へのキャプチャの頻度を設定できます。値は 60 ~ 900 秒にする必要があります | int |
sizeLimitInBytes | サイズ ウィンドウは、キャプチャ操作の前にイベント ハブに構築されたデータの量を定義します。値は10485760から524288000 バイトの間にする必要があります | int |
skipEmptyArchives | 空のアーカイブをスキップするかどうかを示す値 | bool |
行き先
名前 | 形容 | 価値 |
---|---|---|
名前 | キャプチャ先の名前 | 糸 |
プロパティ | キャプチャ先のストレージ アカウント、BLOB コンテナー、アーカイブ名の形式を記述するプロパティ | DestinationProperties を |
DestinationProperties
名前 | 形容 | 価値 |
---|---|---|
archiveNameFormat | アーカイブの BLOB 名前付け規則 ({Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} など)。 ここでは、順序に関係なく、すべてのパラメーター (Namespace、EventHub など) が必須です | 糸 |
blobContainer | BLOB コンテナー名 | 糸 |
dataLakeAccountName | キャプチャされたイベントの Azure Data Lake Store 名 | 糸 |
dataLakeFolderPath | キャプチャされたイベントの宛先フォルダー パス | 糸 |
dataLakeSubscriptionId | Azure Data Lake Store のサブスクリプション ID | 糸 制約: 最小長 = 36 最大長 = 36 パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
storageAccountResourceId | BLOB の作成に使用するストレージ アカウントのリソース ID | 糸 |
EventhubProperties
名前 | 形容 | 価値 |
---|---|---|
captureDescription | キャプチャの説明のプロパティ | CaptureDescription |
messageRetentionInDays | このイベント ハブのイベントを保持する日数。値は 1 ~ 7 日にする必要があります | int 制約: 最小値 = 1 |
partitionCount | イベント ハブ用に作成されたパーティションの数。使用できる値は 1 から 32 個のパーティションです。 | int 制約: 最小値 = 1 |
retentionDescription | イベント ハブの保持設定 | RetentionDescription |
地位 | イベント ハブの状態に使用できる値を列挙します。 | 'Active' 'Creating' '削除中' 'Disabled' 'ReceiveDisabled' '名前の変更' '復元中' 'SendDisabled' 'Unknown' |
Microsoft.EventHub/namespaces/eventhubs
名前 | 形容 | 価値 |
---|---|---|
名前 | リソース名 | 糸 制約: 最小長 = 1 最大長 = 1 (必須) |
parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: 名前空間 |
プロパティ | イベント ハブの作成または更新操作に指定されたプロパティ。 | EventhubProperties の |
種類 | リソースの種類 | "Microsoft.EventHub/namespaces/eventhubs@2022-10-01-preview" |
RetentionDescription
名前 | 形容 | 価値 |
---|---|---|
cleanupPolicy | クリーンアップ ポリシーで使用可能な値を列挙します。 | 'Compact' 'Delete' |
retentionTimeInHours | このイベント ハブのイベントを保持する時間数。 この値は、cleanupPolicy が Delete の場合にのみ使用されます。 cleanupPolicy が Compact の場合、このプロパティの戻り値は Long.MaxValue です | int |
tombstoneRetentionTimeInHours | 圧縮されたイベント ハブの廃棄石マーカーを保持する時間数。 この値は、cleanupPolicy が Compact の場合にのみ使用されます。 コンシューマーは、圧縮されたイベント ハブ内の廃棄石マーカーによって記述された特定のキーの有効なスナップショットを取得するようにオフセットの開始から開始する場合、この指定された時間内に廃棄石マーカーの読み取りを完了する必要があります | int |