Microsoft.EventHub namespaces/eventhubs 2014-09-01
Bicep resource definition
The namespaces/eventhubs resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.EventHub/namespaces/eventhubs resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.EventHub/namespaces/eventhubs@2014-09-01' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
messageRetentionInDays: int
partitionCount: int
status: 'string'
}
}
Property values
EventHubProperties
| Name | Description | Value |
|---|---|---|
| messageRetentionInDays | Number of days to retain the events for this Event Hub. | int |
| partitionCount | Number of partitions created for the Event Hub. | int |
| status | Enumerates the possible values for the status of the Event Hub. | 'Active' 'Creating' 'Deleting' 'Disabled' 'ReceiveDisabled' 'Renaming' 'Restoring' 'SendDisabled' 'Unknown' |
Microsoft.EventHub/namespaces/eventhubs
| Name | Description | Value |
|---|---|---|
| location | Location of the resource. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 1 (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: namespaces |
| properties | Properties supplied to the Create Or Update Event Hub operation. | EventHubProperties |
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| Azure Digital Twins with Time Data History Connection | This template creates an Azure Digital Twins instance configured with a time series data history connection. In order to create a connection, other resources must be created such as an Event Hubs namespace, an event hub, Azure Data Explorer cluster, and a database. Data is sent to an event hub which eventually forwards the data to the Azure Data Explorer cluster. Data is stored in a database table in the cluster |
| Azure Function App with Event Hub and Managed Identity | his template provisions an Azure Function app on a Linux Consumption plan, along with an Event Hub, Azure Storage, and Application Insights. The function app is able to use managed identity to connect to the Event Hub and Storage account |
| Create an event hub | This template enables you to deploy a EventHubs namespace with an event hub. |
| Create an EventHubs namespace, Event Hub, & consumer group | This template enables you to deploy an Event Hubs Standard namespace, an Event Hub, and a consumer group. |
| Creates Eventhub cluster, namesapce & eventhub | This template enables you to create EventHubs Cluster, namespace and eventhub in cluster |
| Deploy Azure Data Explorer db with Event Grid connection | Deploy Azure Data Explorer db with Event Grid connection. |
| Deploy Azure Data Explorer db with Event Hub connection | Deploy Azure Data Explorer db with Event Hub connection. |
| Deploy the MedTech service | The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service. |
| Deploy the MedTech service including an Azure IoT Hub | The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service. |
| Deploy the Sports Analytics on Azure Architecture | Creates an Azure storage account with ADLS Gen 2 enabled, an Azure Data Factory instance with linked services for the storage account (an the Azure SQL Database if deployed), and an Azure Databricks instance. The AAD identity for the user deploying the template and the managed identity for the ADF instance will be granted the Storage Blob Data Contributor role on the storage account. There are also options to deploy an Azure Key Vault instance, an Azure SQL Database, and an Azure Event Hub (for streaming use cases). When an Azure Key Vault is deployed, the data factory managed identity and the AAD identity for the user deploying the template will be granted the Key Vault Secrets User role. |
| FrontDoor CDN with WAF, Domains and Logs to EventHub | This template creates a new Azure FrontDoor cdn profile. Create WAF with custom and managed rules, cdn routes, origin and groups with their association with WAF and routes, configures custom domains, create event hub and diagnostic settings for sending CDN access logs using event hub. |
| Moesif API Analytics and Monetization | The template will log API calls from Azure API Management to Moesif API analytics and monetization platform |
ARM template resource definition
The namespaces/eventhubs resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.EventHub/namespaces/eventhubs resource, add the following JSON to your template.
{
"type": "Microsoft.EventHub/namespaces/eventhubs",
"apiVersion": "2014-09-01",
"name": "string",
"location": "string",
"properties": {
"messageRetentionInDays": "int",
"partitionCount": "int",
"status": "string"
}
}
Property values
EventHubProperties
| Name | Description | Value |
|---|---|---|
| messageRetentionInDays | Number of days to retain the events for this Event Hub. | int |
| partitionCount | Number of partitions created for the Event Hub. | int |
| status | Enumerates the possible values for the status of the Event Hub. | 'Active' 'Creating' 'Deleting' 'Disabled' 'ReceiveDisabled' 'Renaming' 'Restoring' 'SendDisabled' 'Unknown' |
Microsoft.EventHub/namespaces/eventhubs
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2014-09-01' |
| location | Location of the resource. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 1 (required) |
| properties | Properties supplied to the Create Or Update Event Hub operation. | EventHubProperties |
| type | The resource type | 'Microsoft.EventHub/namespaces/eventhubs' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Azure Digital Twins with Time Data History Connection |
This template creates an Azure Digital Twins instance configured with a time series data history connection. In order to create a connection, other resources must be created such as an Event Hubs namespace, an event hub, Azure Data Explorer cluster, and a database. Data is sent to an event hub which eventually forwards the data to the Azure Data Explorer cluster. Data is stored in a database table in the cluster |
| Azure Function App with Event Hub and Managed Identity |
his template provisions an Azure Function app on a Linux Consumption plan, along with an Event Hub, Azure Storage, and Application Insights. The function app is able to use managed identity to connect to the Event Hub and Storage account |
| Create an event hub |
This template enables you to deploy a EventHubs namespace with an event hub. |
| Create an EventHubs namespace, Event Hub, & consumer group |
This template enables you to deploy an Event Hubs Standard namespace, an Event Hub, and a consumer group. |
| Creates Eventhub cluster, namesapce & eventhub |
This template enables you to create EventHubs Cluster, namespace and eventhub in cluster |
| Deploy Azure Data Explorer db with Event Grid connection |
Deploy Azure Data Explorer db with Event Grid connection. |
| Deploy Azure Data Explorer db with Event Hub connection |
Deploy Azure Data Explorer db with Event Hub connection. |
| Deploy the MedTech service |
The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service. |
| Deploy the MedTech service including an Azure IoT Hub |
The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service. |
| Deploy the Sports Analytics on Azure Architecture |
Creates an Azure storage account with ADLS Gen 2 enabled, an Azure Data Factory instance with linked services for the storage account (an the Azure SQL Database if deployed), and an Azure Databricks instance. The AAD identity for the user deploying the template and the managed identity for the ADF instance will be granted the Storage Blob Data Contributor role on the storage account. There are also options to deploy an Azure Key Vault instance, an Azure SQL Database, and an Azure Event Hub (for streaming use cases). When an Azure Key Vault is deployed, the data factory managed identity and the AAD identity for the user deploying the template will be granted the Key Vault Secrets User role. |
| FrontDoor CDN with WAF, Domains and Logs to EventHub |
This template creates a new Azure FrontDoor cdn profile. Create WAF with custom and managed rules, cdn routes, origin and groups with their association with WAF and routes, configures custom domains, create event hub and diagnostic settings for sending CDN access logs using event hub. |
| Moesif API Analytics and Monetization |
The template will log API calls from Azure API Management to Moesif API analytics and monetization platform |
Terraform (AzAPI provider) resource definition
The namespaces/eventhubs resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.EventHub/namespaces/eventhubs resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventHub/namespaces/eventhubs@2014-09-01"
name = "string"
location = "string"
body = jsonencode({
properties = {
messageRetentionInDays = int
partitionCount = int
status = "string"
}
})
}
Property values
EventHubProperties
| Name | Description | Value |
|---|---|---|
| messageRetentionInDays | Number of days to retain the events for this Event Hub. | int |
| partitionCount | Number of partitions created for the Event Hub. | int |
| status | Enumerates the possible values for the status of the Event Hub. | 'Active' 'Creating' 'Deleting' 'Disabled' 'ReceiveDisabled' 'Renaming' 'Restoring' 'SendDisabled' 'Unknown' |
Microsoft.EventHub/namespaces/eventhubs
| Name | Description | Value |
|---|---|---|
| location | Location of the resource. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 1 (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: namespaces |
| properties | Properties supplied to the Create Or Update Event Hub operation. | EventHubProperties |
| type | The resource type | "Microsoft.EventHub/namespaces/eventhubs@2014-09-01" |