Microsoft.EventHub namespaces/eventhubs 2017-04-01

Template format

To create a Microsoft.EventHub/namespaces/eventhubs resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.EventHub/namespaces/eventhubs",
  "apiVersion": "2017-04-01",
  "properties": {
    "messageRetentionInDays": "integer",
    "partitionCount": "integer",
    "status": "string",
    "captureDescription": {
      "enabled": "boolean",
      "encoding": "string",
      "intervalInSeconds": "integer",
      "sizeLimitInBytes": "integer",
      "destination": {
        "name": "string",
        "properties": {
          "storageAccountResourceId": "string",
          "blobContainer": "string",
          "archiveNameFormat": "string"
        }
      },
      "skipEmptyArchives": "boolean"
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.EventHub/namespaces/eventhubs object

Name Type Required Value
name string Yes The Event Hub name
type enum Yes eventhubs
-or-
Microsoft.EventHub/namespaces/eventhubs

See Set name and type for child resources.
apiVersion enum Yes 2017-04-01
properties object Yes Properties supplied to the Create Or Update Event Hub operation. - EventhubProperties object

EventhubProperties object

Name Type Required Value
messageRetentionInDays integer No Number of days to retain the events for this Event Hub, value should be 1 to 7 days
partitionCount integer No Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.
status enum No Enumerates the possible values for the status of the Event Hub. - Active, Disabled, Restoring, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming, Unknown
captureDescription object No Properties of capture description - CaptureDescription object

CaptureDescription object

Name Type Required Value
enabled boolean No A value that indicates whether capture description is enabled.
encoding enum No Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version. - Avro or AvroDeflate
intervalInSeconds integer No The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds
sizeLimitInBytes integer No The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes
destination object No Properties of Destination where capture will be stored. (Storage Account, Blob Names) - Destination object
skipEmptyArchives boolean No A value that indicates whether to Skip Empty Archives

Destination object

Name Type Required Value
name string No Name for capture destination
properties object No Properties describing the storage account, blob container and archive name format for capture destination - DestinationProperties object

DestinationProperties object

Name Type Required Value
storageAccountResourceId string No Resource id of the storage account to be used to create the blobs
blobContainer string No Blob container Name
archiveNameFormat string No Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Event Grid custom topic and event hub handler.

Deploy to Azure
Creates an Azure Event Grid custom topic and event hub to handle the events.
Create an event hub

Deploy to Azure
This template enables you to deploy a EventHubs namespace with an event hub.
Creates Eventhub cluster, namesapce & eventhub

Deploy to Azure
This template enables you to create EventHubs Cluster, namespace and eventhub in cluster
Create an EventHubs namespace, Event Hub, & consumer group

Deploy to Azure
This template enables you to deploy an Event Hubs Standard namespace, an Event Hub, and a consumer group.
Create EventHubs with Capture enabled

Deploy to Azure
This template enables you to deploy a EventHubs namespace with an event hub and enabling Capture on it
Create EventHubs with Capture enabled

Deploy to Azure
This template enables you to deploy a EventHubs namespace with an event hub and enabling Capture on it
Create an EventHubs namespace and enable auto-inflate

Deploy to Azure
This template enables you to deploy an Event Hubs Standard namespace, an Event Hub, and a consumer group.This template also turns on the auto-inflate feature on your namespace.
Connect to a Event Hubs namespace via private endpoint

Deploy to Azure
This sample shows how to use configure a virtual network and private DNS zone to access a Event Hubs namespace via a private endpoint.
Azure SQL Server with Auditing written to Event Hub

Deploy to Azure
This template allows you to deploy an Azure SQL server with Auditing enabled to write audit logs to Event Hub
Create an Environment with an Event Hub Event Source

Deploy to Azure
This template enables you to deploy a Time Series Insights environment that is configured to consume events from an Event Hub.
Create EventHubs authorizationRules

Deploy to Azure
This template enables you to deploy a EventHubs Standard namespace, an Event Hub, a consumer group and authorizationRules
PubNub Realtime Gateway for Azure Event Hubs

Deploy to Azure
The PubNub Realtime Gateway for Azure provides a realtime data stream bridge between the PubNub Data Stream Network and Azure Event Hubs. -- consider it a bi-directional bridge between PubNub and Azure!