Microsoft.EventHub namespaces/eventhubs 2021-01-01-preview

[アーティクル]
10/19/2024

Bicep リソース定義

名前空間/eventhubs リソースの種類は、次をターゲットとする操作でデプロイできます。

リソースグループの - リソースグループのデプロイコマンド参照

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

リソースの形式

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

resource symbolicname 'Microsoft.EventHub/namespaces/eventhubs@2021-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

名前	形容	価値
名前	リソース名 Bicepで子リソースの名前と種類設定する方法を参照してください。	string (必須) 文字数制限: 1 から 256 有効な文字: 英数字、ピリオド、ハイフン、アンダースコア。開始と終了は、文字または数字で行います。
親	Bicep では、子リソースの親リソースを指定できます。このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。詳細については、「親リソースの外部子リソース」を参照してください。	種類のリソースのシンボリック名: 名前空間
プロパティ	イベントハブの作成または更新操作に指定されたプロパティ。	EventhubProperties の

EventhubProperties

名前	形容	価値
captureDescription	キャプチャの説明のプロパティ	CaptureDescription
messageRetentionInDays	このイベントハブのイベントを保持する日数。値は 1 ~ 7 日にする必要があります	int 制約：最小値 = 1
partitionCount	イベントハブ用に作成されたパーティションの数。使用できる値は 1 から 32 個のパーティションです。	int 制約：最小値 = 1
地位	イベントハブの状態に使用できる値を列挙します。	'Active' 'Creating' '削除中' 'Disabled' 'ReceiveDisabled' '名前の変更' '復元中' 'SendDisabled' 'Unknown'

CaptureDescription

名前	形容	価値
行き先	キャプチャが格納される Destination のプロパティ。 (ストレージアカウント、BLOB 名)	Destination
有効	キャプチャの説明が有効かどうかを示す値。	bool
エンコーディング	キャプチャの説明のエンコード形式に使用できる値を列挙します。注: 'AvroDeflate' は新しい API バージョンで非推奨になります	'Avro' 'AvroDeflate'
intervalInSeconds	時間枠を使用すると、Azure BLOB へのキャプチャの頻度を設定できます。値は 60 ~ 900 秒にする必要があります	int 制約：最小値 = 60 最大値 = 900
sizeLimitInBytes	サイズウィンドウは、キャプチャ操作の前にイベントハブに構築されたデータの量を定義します。値は10485760から524288000 バイトの間にする必要があります	int 制約：最小値 = 10485760 最大値 = 524288000
skipEmptyArchives	空のアーカイブをスキップするかどうかを示す値	bool

行き先

名前	形容	価値
名前	キャプチャ先の名前	糸
プロパティ	キャプチャ先のストレージアカウント、BLOB コンテナー、アーカイブ名の形式を記述するプロパティ	DestinationProperties をする

DestinationProperties

名前	形容	価値
archiveNameFormat	アーカイブの BLOB 名前付け規則 ({Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} など)。ここでは、順序に関係なく、すべてのパラメーター (Namespace、EventHub など) が必須です	糸
blobContainer	BLOB コンテナー名	糸
storageAccountResourceId	BLOB の作成に使用するストレージアカウントのリソース ID	糸

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

テンプレート	形容
Azure Event Hubs の PubNub Realtime Gateway の Azure にデプロイする	Azure 用 PubNub Realtime Gateway は、PubNub データストリームネットワークと Azure Event Hubs の間のリアルタイムデータストリームブリッジを提供します。 -- PubNub と Azure の間の双方向ブリッジと考えてください。
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 シークレットユーザーロールが付与されます。
Moesif API Analytics と収益化の Azure にデプロイする	このテンプレートは、Azure API Management から Moesif API 分析および収益化プラットフォームへの API 呼び出しをログに記録します
時間データ履歴接続を使用した Azure Digital Twins の Azure にデプロイする	このテンプレートは、時系列データ履歴接続で構成された Azure Digital Twins インスタンスを作成します。接続を作成するには、Event Hubs 名前空間、イベントハブ、Azure Data Explorer クラスター、データベースなどの他のリソースを作成する必要があります。データはイベントハブに送信され、最終的にデータが Azure Data Explorer クラスターに転送されます。データはクラスター内のデータベーステーブルに格納されます
Event Grid カスタムトピックとイベントハブハンドラーの作成 Azure にデプロイする	イベントを処理する Azure Event Grid カスタムトピックとイベントハブを作成します。
EventHubs 名前空間、Event Hub、& コンシューマーグループを作成する Azure にデプロイする	このテンプレートを使用すると、Event Hubs Standard 名前空間、イベントハブ、およびコンシューマーグループをデプロイできます。
EventHubs authorizationRules を作成する Azure にデプロイする	このテンプレートを使用すると、EventHubs Standard 名前空間、イベントハブ、コンシューマーグループ、authorizationRules をデプロイできます。
Eventhub クラスター、namesapce & eventhub を作成します Azure にデプロイする	このテンプレートを使用すると、クラスター内に EventHubs クラスター、名前空間、および eventhub を作成できます
Capture を有効にして EventHubs を作成 Azure にデプロイする	このテンプレートを使用すると、イベントハブを使用して EventHubs 名前空間をデプロイし、その上で Capture を有効にできます。
Capture 対応 (ADLS) を使用して EventHubs を作成する Azure にデプロイする	このテンプレートを使用すると、イベントハブを使用して EventHubs 名前空間をデプロイし、その上で Capture を有効にできます。
EventHubs 名前空間を作成し、自動インフレを有効にする Azure にデプロイする	このテンプレートを使用すると、Event Hubs Standard 名前空間、イベントハブ、およびコンシューマーグループをデプロイできます。このテンプレートでは、名前空間の自動インフレ機能も有効になります。
イベントハブを作成する Azure にデプロイする	このテンプレートを使用すると、EventHubs 名前空間をイベントハブと共にデプロイできます。
プライベートエンドポイントを使用して Event Hubs 名前空間に接続 Azure にデプロイする	このサンプルでは、仮想ネットワークとプライベート DNS ゾーンを構成して、プライベートエンドポイント経由で Event Hubs 名前空間にアクセスする方法を示します。
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 つです。
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 をデプロイします。
Event Hub に書き込まれた監査を使用して Azure SQL Server をする Azure にデプロイする	このテンプレートを使用すると、監査が有効になっている Azure SQL サーバーをデプロイして、イベントハブに監査ログを書き込むことができます
ログとメトリックの送信を構成して SQL MI を作成する Azure にデプロイする	このテンプレートを使用すると、SQL MI と、ログとメトリック (診断ワークスペース、ストレージアカウント、イベントハブ) の格納に使用されるその他のリソースをデプロイできます。
Event Hub イベントソースを使用して環境を作成する Azure にデプロイする	このテンプレートを使用すると、イベントハブからのイベントを使用するように構成された Time Series Insights 環境をデプロイできます。
Event Hub とマネージド ID を使用して Azure Function App をする Azure にデプロイする	彼のテンプレートは、Linux 従量課金プランに Azure 関数アプリを、Event Hub、Azure Storage、Application Insights と共にプロビジョニングします。関数アプリは、マネージド ID を使用してイベントハブとストレージアカウントに接続できます

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

名前空間/eventhubs リソースの種類は、次をターゲットとする操作でデプロイできます。

リソースグループの - リソースグループのデプロイコマンド参照

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

リソースの形式

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

{
  "type": "Microsoft.EventHub/namespaces/eventhubs",
  "apiVersion": "2021-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

名前	形容	価値
種類	リソースの種類	'Microsoft.EventHub/namespaces/eventhubs'
apiVersion	リソース API のバージョン	'2021-01-01-preview'
名前	リソース名 JSON ARM テンプレートで子リソースの名前と型設定する方法を参照してください。	string (必須) 文字数制限: 1 から 256 有効な文字: 英数字、ピリオド、ハイフン、アンダースコア。開始と終了は、文字または数字で行います。
プロパティ	イベントハブの作成または更新操作に指定されたプロパティ。	EventhubProperties の

EventhubProperties

名前	形容	価値
captureDescription	キャプチャの説明のプロパティ	CaptureDescription
messageRetentionInDays	このイベントハブのイベントを保持する日数。値は 1 ~ 7 日にする必要があります	int 制約：最小値 = 1
partitionCount	イベントハブ用に作成されたパーティションの数。使用できる値は 1 から 32 個のパーティションです。	int 制約：最小値 = 1
地位	イベントハブの状態に使用できる値を列挙します。	'Active' 'Creating' '削除中' 'Disabled' 'ReceiveDisabled' '名前の変更' '復元中' 'SendDisabled' 'Unknown'

CaptureDescription

名前	形容	価値
行き先	キャプチャが格納される Destination のプロパティ。 (ストレージアカウント、BLOB 名)	Destination
有効	キャプチャの説明が有効かどうかを示す値。	bool
エンコーディング	キャプチャの説明のエンコード形式に使用できる値を列挙します。注: 'AvroDeflate' は新しい API バージョンで非推奨になります	'Avro' 'AvroDeflate'
intervalInSeconds	時間枠を使用すると、Azure BLOB へのキャプチャの頻度を設定できます。値は 60 ~ 900 秒にする必要があります	int 制約：最小値 = 60 最大値 = 900
sizeLimitInBytes	サイズウィンドウは、キャプチャ操作の前にイベントハブに構築されたデータの量を定義します。値は10485760から524288000 バイトの間にする必要があります	int 制約：最小値 = 10485760 最大値 = 524288000
skipEmptyArchives	空のアーカイブをスキップするかどうかを示す値	bool

行き先

名前	形容	価値
名前	キャプチャ先の名前	糸
プロパティ	キャプチャ先のストレージアカウント、BLOB コンテナー、アーカイブ名の形式を記述するプロパティ	DestinationProperties をする

DestinationProperties

名前	形容	価値
archiveNameFormat	アーカイブの BLOB 名前付け規則 ({Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} など)。ここでは、順序に関係なく、すべてのパラメーター (Namespace、EventHub など) が必須です	糸
blobContainer	BLOB コンテナー名	糸
storageAccountResourceId	BLOB の作成に使用するストレージアカウントのリソース ID	糸

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

テンプレート	形容
Azure Event Hubs の PubNub Realtime Gateway の Azure にデプロイする	Azure 用 PubNub Realtime Gateway は、PubNub データストリームネットワークと Azure Event Hubs の間のリアルタイムデータストリームブリッジを提供します。 -- PubNub と Azure の間の双方向ブリッジと考えてください。
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 シークレットユーザーロールが付与されます。
Moesif API Analytics と収益化の Azure にデプロイする	このテンプレートは、Azure API Management から Moesif API 分析および収益化プラットフォームへの API 呼び出しをログに記録します
時間データ履歴接続を使用した Azure Digital Twins の Azure にデプロイする	このテンプレートは、時系列データ履歴接続で構成された Azure Digital Twins インスタンスを作成します。接続を作成するには、Event Hubs 名前空間、イベントハブ、Azure Data Explorer クラスター、データベースなどの他のリソースを作成する必要があります。データはイベントハブに送信され、最終的にデータが Azure Data Explorer クラスターに転送されます。データはクラスター内のデータベーステーブルに格納されます
Event Grid カスタムトピックとイベントハブハンドラーの作成 Azure にデプロイする	イベントを処理する Azure Event Grid カスタムトピックとイベントハブを作成します。
EventHubs 名前空間、Event Hub、& コンシューマーグループを作成する Azure にデプロイする	このテンプレートを使用すると、Event Hubs Standard 名前空間、イベントハブ、およびコンシューマーグループをデプロイできます。
EventHubs authorizationRules を作成する Azure にデプロイする	このテンプレートを使用すると、EventHubs Standard 名前空間、イベントハブ、コンシューマーグループ、authorizationRules をデプロイできます。
Eventhub クラスター、namesapce & eventhub を作成します Azure にデプロイする	このテンプレートを使用すると、クラスター内に EventHubs クラスター、名前空間、および eventhub を作成できます
Capture を有効にして EventHubs を作成 Azure にデプロイする	このテンプレートを使用すると、イベントハブを使用して EventHubs 名前空間をデプロイし、その上で Capture を有効にできます。
Capture 対応 (ADLS) を使用して EventHubs を作成する Azure にデプロイする	このテンプレートを使用すると、イベントハブを使用して EventHubs 名前空間をデプロイし、その上で Capture を有効にできます。
EventHubs 名前空間を作成し、自動インフレを有効にする Azure にデプロイする	このテンプレートを使用すると、Event Hubs Standard 名前空間、イベントハブ、およびコンシューマーグループをデプロイできます。このテンプレートでは、名前空間の自動インフレ機能も有効になります。
イベントハブを作成する Azure にデプロイする	このテンプレートを使用すると、EventHubs 名前空間をイベントハブと共にデプロイできます。
プライベートエンドポイントを使用して Event Hubs 名前空間に接続 Azure にデプロイする	このサンプルでは、仮想ネットワークとプライベート DNS ゾーンを構成して、プライベートエンドポイント経由で Event Hubs 名前空間にアクセスする方法を示します。
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 つです。
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 をデプロイします。
Event Hub に書き込まれた監査を使用して Azure SQL Server をする Azure にデプロイする	このテンプレートを使用すると、監査が有効になっている Azure SQL サーバーをデプロイして、イベントハブに監査ログを書き込むことができます
ログとメトリックの送信を構成して SQL MI を作成する Azure にデプロイする	このテンプレートを使用すると、SQL MI と、ログとメトリック (診断ワークスペース、ストレージアカウント、イベントハブ) の格納に使用されるその他のリソースをデプロイできます。
Event Hub イベントソースを使用して環境を作成する Azure にデプロイする	このテンプレートを使用すると、イベントハブからのイベントを使用するように構成された Time Series Insights 環境をデプロイできます。
Event Hub とマネージド ID を使用して Azure Function App をする Azure にデプロイする	彼のテンプレートは、Linux 従量課金プランに Azure 関数アプリを、Event Hub、Azure Storage、Application Insights と共にプロビジョニングします。関数アプリは、マネージド ID を使用してイベントハブとストレージアカウントに接続できます

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

名前空間/eventhubs リソースの種類は、次をターゲットとする操作でデプロイできます。

リソースグループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventHub/namespaces/eventhubs@2021-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

名前	形容	価値
種類	リソースの種類	"Microsoft.EventHub/namespaces/eventhubs@2021-01-01-preview"
名前	リソース名	string (必須) 文字数制限: 1 から 256 有効な文字: 英数字、ピリオド、ハイフン、アンダースコア。開始と終了は、文字または数字で行います。
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: 名前空間
プロパティ	イベントハブの作成または更新操作に指定されたプロパティ。	EventhubProperties の

EventhubProperties

名前	形容	価値
captureDescription	キャプチャの説明のプロパティ	CaptureDescription
messageRetentionInDays	このイベントハブのイベントを保持する日数。値は 1 ~ 7 日にする必要があります	int 制約：最小値 = 1
partitionCount	イベントハブ用に作成されたパーティションの数。使用できる値は 1 から 32 個のパーティションです。	int 制約：最小値 = 1
地位	イベントハブの状態に使用できる値を列挙します。	"アクティブ" "作成中" "削除中" "無効" "ReceiveDisabled" "名前の変更" "復元中" "SendDisabled" "不明"

CaptureDescription

名前	形容	価値
行き先	キャプチャが格納される Destination のプロパティ。 (ストレージアカウント、BLOB 名)	Destination
有効	キャプチャの説明が有効かどうかを示す値。	bool
エンコーディング	キャプチャの説明のエンコード形式に使用できる値を列挙します。注: 'AvroDeflate' は新しい API バージョンで非推奨になります	"Avro" "AvroDeflate"
intervalInSeconds	時間枠を使用すると、Azure BLOB へのキャプチャの頻度を設定できます。値は 60 ~ 900 秒にする必要があります	int 制約：最小値 = 60 最大値 = 900
sizeLimitInBytes	サイズウィンドウは、キャプチャ操作の前にイベントハブに構築されたデータの量を定義します。値は10485760から524288000 バイトの間にする必要があります	int 制約：最小値 = 10485760 最大値 = 524288000
skipEmptyArchives	空のアーカイブをスキップするかどうかを示す値	bool

行き先

名前	形容	価値
名前	キャプチャ先の名前	糸
プロパティ	キャプチャ先のストレージアカウント、BLOB コンテナー、アーカイブ名の形式を記述するプロパティ	DestinationProperties をする

DestinationProperties

名前	形容	価値
archiveNameFormat	アーカイブの BLOB 名前付け規則 ({Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} など)。ここでは、順序に関係なく、すべてのパラメーター (Namespace、EventHub など) が必須です	糸
blobContainer	BLOB コンテナー名	糸
storageAccountResourceId	BLOB の作成に使用するストレージアカウントのリソース ID	糸

次の方法で共有

Microsoft.EventHub namespaces/eventhubs 2021-01-01-preview

Bicep リソース定義

リソースの形式

プロパティ値

namespaces/eventhubs

EventhubProperties

CaptureDescription

行き先

DestinationProperties

クイックスタートテンプレート

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

リソースの形式

プロパティ値

namespaces/eventhubs

EventhubProperties

CaptureDescription

行き先

DestinationProperties

クイックスタートテンプレート

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

リソースの形式

プロパティ値

namespaces/eventhubs

EventhubProperties

CaptureDescription

行き先

DestinationProperties

フィードバック

その他のリソース

次の方法で共有

Microsoft.EventHub namespaces/eventhubs 2021-01-01-preview

Bicep リソース定義

リソースの形式

プロパティ値

namespaces/eventhubs

EventhubProperties

CaptureDescription

行き先

DestinationProperties

クイック スタート テンプレート

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

リソースの形式

プロパティ値

namespaces/eventhubs

EventhubProperties

CaptureDescription

行き先

DestinationProperties

クイック スタート テンプレート

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

リソースの形式

プロパティ値

namespaces/eventhubs

EventhubProperties

CaptureDescription

行き先

DestinationProperties

フィードバック

その他のリソース

クイックスタートテンプレート

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

クイックスタートテンプレート