azEventHubNamespace

Deploy an Azure Event Hub Namespace and Event Hubs to the relevant subscription.

Attributes

Attribute	Type	Mandatory	Values	Default	Notes
Name	String	Yes
ResourceGroupName	String	Yes
Location	String	Yes
Sku	String	No	Basic
			Standard (D)
SkuCapacity	String	No		1
MaxThroughputUnits	String	No			0-20 set if Autoinflate required
EnableZoneRedundancy	Boolean	No		False
EnableKafka	Boolean	No		True
SharedAccessPolicy	Object	No
Network	Object	No
Tag	Object	No
Lock	Object	No

SharedAccessPolicy

Attribute	Type	Mandatory	Values	Default	Notes
Name	String	Yes
Permission	Array	Yes	Manage, Send, Listen

Network

Attribute	Type	Mandatory	Values	Default	Notes
PrivateEndpoint	Object	No

Input by YAML

Object model for YAML deployment:

azEventHubNamespace:
    # Mandatory
  - Name: 'string'
    ResourceGroupName: 'string'
    Location: 'string'
    # Optional
    Sku: 'string'                                   # Basic, Standard (D), Premium
    SkuCapacity: number                             # 1 (D)
    MaximumThroughputUnits: number                  # 0-20 set if Autoinflate required
    EnableZoneRedundancy: boolean                   # True, False (D)
    EnableKafka: boolean                            # True (D), False
    SharedAccessPolicy:
      - Name: 'string'
        Permission: [array]                         # Manage, Send, Listen
    Network:
      PrivateEndPoint:
        Name: 'string'
        Location: 'string'
        PrivateLinkName: 'string'                   # Defaults to pl-resource
        NetworkInterfaceName: 'string'              # Defaults to pe-nic-resource
        ResourceGroupName: 'string'                 # Defaults to RG of the resource
        VirtualNetwork:
          VNetName: 'string'
          SubnetName: 'string'
          ResourceGroupName: 'string'               # Defaults to RG of the resource
          SubscriptionName: 'string'                # Defaults to Sub of the resource
    EventHub:
      - Name: 'string'
        MessageRetentionInDays: 'string'
        PartitionCount: number
    Tag: 
      'keyvalue-pairs'
    Lock:
      - Name: 'string'
        Level: 'string'                             # CanNotDelete, ReadOnly
        Notes: 'string'

Input by JSON

Object model for JSON deployment:

{
  "azEventHubNamespace": [
    {
      "Name": "string",
      "ResourceGroupName": "string",
      "Location": "string",
      "Sku": "string",
      "SkuCapacity": number,
      "MaximumThroughputUnits": number,
      "EnableZoneRedundancy": boolean,
      "EnableKafka": boolean,
      "SharedAccessPolicy": [
        {
          "Name": "string",
          "Permission": [array]
        }
      ],
      "Network": {
        "PrivateEndPoint": {
          "Name": "string",
          "Location": "string",
          "PrivateLinkName": "string",
          "NetworkInterfaceName": "string",
          "ResourceGroupName": "string",
          "VirtualNetwork": {
            "VNetName": "string",
            "SubnetName": "string",
            "ResourceGroupName": "string",
            "SubscriptionName": "string"
          }
        }
      },
      "EventHub": [
        {
          "Name": "string",
          "MessageRetentionInDays": "string",
          "PartitionCount": number
        }
      ],
      "Tag": {
        "key": "value"
      },
      "Lock": [
        {
          "Name": "string",
          "Level": "string",
          "Notes": "string"
        }
      ]
    }
  ]
}

Validation

The following validation is performed by Powershell function Confirm-JDResource.

Attribute: Name
Validation:
  Mandatory: cannot be null

Attribute: ResourceGroupName
Validation:
  Mandatory: cannot be null

Attribute: Location
Validation:
  Mandatory: cannot be null