EventHubNamespace

Manages an EventHub Namespace.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleEventHubNamespace = new Azure.EventHub.EventHubNamespace("exampleEventHubNamespace", new Azure.EventHub.EventHubNamespaceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = "Standard",
            Capacity = 2,
            Tags = 
            {
                { "environment", "Production" },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/eventhub"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West Europe"),
        })
        if err != nil {
            return err
        }
        _, err = eventhub.NewEventHubNamespace(ctx, "exampleEventHubNamespace", &eventhub.EventHubNamespaceArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
            Sku:               pulumi.String("Standard"),
            Capacity:          pulumi.Int(2),
            Tags: pulumi.Map{
                "environment": pulumi.String("Production"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_event_hub_namespace = azure.eventhub.EventHubNamespace("exampleEventHubNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    capacity=2,
    tags={
        "environment": "Production",
    })

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("exampleEventHubNamespace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "Standard",
    capacity: 2,
    tags: {
        environment: "Production",
    },
});

Create a EventHubNamespace Resource

new EventHubNamespace(name: string, args: EventHubNamespaceArgs, opts?: CustomResourceOptions);

def EventHubNamespace(resource_name, opts=None, auto_inflate_enabled=None, capacity=None, location=None, maximum_throughput_units=None, name=None, network_rulesets=None, resource_group_name=None, sku=None, tags=None, __props__=None);

func NewEventHubNamespace(ctx *Context, name string, args EventHubNamespaceArgs, opts ...ResourceOption) (*EventHubNamespace, error)

public EventHubNamespace(string name, EventHubNamespaceArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args EventHubNamespaceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EventHubNamespaceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EventHubNamespaceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

EventHubNamespace Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The EventHubNamespace resource accepts the following input properties:

ResourceGroupName string: The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.
Sku string: Defines which tier to use. Valid options are Basic and Standard.
AutoInflateEnabled bool: Is Auto Inflate enabled for the EventHub Namespace?
Capacity int: Specifies the Capacity / Throughput Units for a Standard SKU namespace. Valid values range from 1 - 20.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
MaximumThroughputUnits int: Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from 1 - 20.
Name string: Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.
NetworkRulesets EventHubNamespaceNetworkRulesetsArgs: A network_rulesets block as defined below.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

ResourceGroupName string: The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.
Sku string: Defines which tier to use. Valid options are Basic and Standard.
AutoInflateEnabled bool: Is Auto Inflate enabled for the EventHub Namespace?
Capacity int: Specifies the Capacity / Throughput Units for a Standard SKU namespace. Valid values range from 1 - 20.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
MaximumThroughputUnits int: Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from 1 - 20.
Name string: Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.
NetworkRulesets EventHubNamespaceNetworkRulesets: A network_rulesets block as defined below.
Tags map[string]string: A mapping of tags to assign to the resource.

resourceGroupName string: The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.
sku string: Defines which tier to use. Valid options are Basic and Standard.
autoInflateEnabled boolean: Is Auto Inflate enabled for the EventHub Namespace?
capacity number: Specifies the Capacity / Throughput Units for a Standard SKU namespace. Valid values range from 1 - 20.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
maximumThroughputUnits number: Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from 1 - 20.
name string: Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.
networkRulesets EventHubNamespaceNetworkRulesets: A network_rulesets block as defined below.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

resource_group_name str: The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.
sku str: Defines which tier to use. Valid options are Basic and Standard.
auto_inflate_enabled bool: Is Auto Inflate enabled for the EventHub Namespace?
capacity float: Specifies the Capacity / Throughput Units for a Standard SKU namespace. Valid values range from 1 - 20.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
maximum_throughput_units float: Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from 1 - 20.
name str: Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.
network_rulesets Dict[EventHubNamespaceNetworkRulesets]: A network_rulesets block as defined below.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the EventHubNamespace resource produces the following output properties:

DefaultPrimaryConnectionString string: The primary connection string for the authorization rule RootManageSharedAccessKey.
DefaultPrimaryConnectionStringAlias string: The alias of the primary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
DefaultPrimaryKey string: The primary access key for the authorization rule RootManageSharedAccessKey.
DefaultSecondaryConnectionString string: The secondary connection string for the authorization rule RootManageSharedAccessKey.
DefaultSecondaryConnectionStringAlias string: The alias of the secondary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
DefaultSecondaryKey string: The secondary access key for the authorization rule RootManageSharedAccessKey.
Id string: The provider-assigned unique ID for this managed resource.

DefaultPrimaryConnectionString string: The primary connection string for the authorization rule RootManageSharedAccessKey.
DefaultPrimaryConnectionStringAlias string: The alias of the primary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
DefaultPrimaryKey string: The primary access key for the authorization rule RootManageSharedAccessKey.
DefaultSecondaryConnectionString string: The secondary connection string for the authorization rule RootManageSharedAccessKey.
DefaultSecondaryConnectionStringAlias string: The alias of the secondary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
DefaultSecondaryKey string: The secondary access key for the authorization rule RootManageSharedAccessKey.
Id string: The provider-assigned unique ID for this managed resource.

defaultPrimaryConnectionString string: The primary connection string for the authorization rule RootManageSharedAccessKey.
defaultPrimaryConnectionStringAlias string: The alias of the primary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
defaultPrimaryKey string: The primary access key for the authorization rule RootManageSharedAccessKey.
defaultSecondaryConnectionString string: The secondary connection string for the authorization rule RootManageSharedAccessKey.
defaultSecondaryConnectionStringAlias string: The alias of the secondary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
defaultSecondaryKey string: The secondary access key for the authorization rule RootManageSharedAccessKey.
id string: The provider-assigned unique ID for this managed resource.

default_primary_connection_string str: The primary connection string for the authorization rule RootManageSharedAccessKey.
default_primary_connection_string_alias str: The alias of the primary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
default_primary_key str: The primary access key for the authorization rule RootManageSharedAccessKey.
default_secondary_connection_string str: The secondary connection string for the authorization rule RootManageSharedAccessKey.
default_secondary_connection_string_alias str: The alias of the secondary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
default_secondary_key str: The secondary access key for the authorization rule RootManageSharedAccessKey.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing EventHubNamespace Resource

Get an existing EventHubNamespace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EventHubNamespaceState, opts?: CustomResourceOptions): EventHubNamespace

static get(resource_name, id, opts=None, auto_inflate_enabled=None, capacity=None, default_primary_connection_string=None, default_primary_connection_string_alias=None, default_primary_key=None, default_secondary_connection_string=None, default_secondary_connection_string_alias=None, default_secondary_key=None, location=None, maximum_throughput_units=None, name=None, network_rulesets=None, resource_group_name=None, sku=None, tags=None, __props__=None);

func GetEventHubNamespace(ctx *Context, name string, id IDInput, state *EventHubNamespaceState, opts ...ResourceOption) (*EventHubNamespace, error)

public static EventHubNamespace Get(string name, Input<string> id, EventHubNamespaceState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutoInflateEnabled bool: Is Auto Inflate enabled for the EventHub Namespace?
Capacity int: Specifies the Capacity / Throughput Units for a Standard SKU namespace. Valid values range from 1 - 20.
DefaultPrimaryConnectionString string: The primary connection string for the authorization rule RootManageSharedAccessKey.
DefaultPrimaryConnectionStringAlias string: The alias of the primary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
DefaultPrimaryKey string: The primary access key for the authorization rule RootManageSharedAccessKey.
DefaultSecondaryConnectionString string: The secondary connection string for the authorization rule RootManageSharedAccessKey.
DefaultSecondaryConnectionStringAlias string: The alias of the secondary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
DefaultSecondaryKey string: The secondary access key for the authorization rule RootManageSharedAccessKey.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
MaximumThroughputUnits int: Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from 1 - 20.
Name string: Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.
NetworkRulesets EventHubNamespaceNetworkRulesetsArgs: A network_rulesets block as defined below.
ResourceGroupName string: The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.
Sku string: Defines which tier to use. Valid options are Basic and Standard.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

AutoInflateEnabled bool: Is Auto Inflate enabled for the EventHub Namespace?
Capacity int: Specifies the Capacity / Throughput Units for a Standard SKU namespace. Valid values range from 1 - 20.
DefaultPrimaryConnectionString string: The primary connection string for the authorization rule RootManageSharedAccessKey.
DefaultPrimaryConnectionStringAlias string: The alias of the primary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
DefaultPrimaryKey string: The primary access key for the authorization rule RootManageSharedAccessKey.
DefaultSecondaryConnectionString string: The secondary connection string for the authorization rule RootManageSharedAccessKey.
DefaultSecondaryConnectionStringAlias string: The alias of the secondary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
DefaultSecondaryKey string: The secondary access key for the authorization rule RootManageSharedAccessKey.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
MaximumThroughputUnits int: Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from 1 - 20.
Name string: Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.
NetworkRulesets EventHubNamespaceNetworkRulesets: A network_rulesets block as defined below.
ResourceGroupName string: The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.
Sku string: Defines which tier to use. Valid options are Basic and Standard.
Tags map[string]string: A mapping of tags to assign to the resource.

autoInflateEnabled boolean: Is Auto Inflate enabled for the EventHub Namespace?
capacity number: Specifies the Capacity / Throughput Units for a Standard SKU namespace. Valid values range from 1 - 20.
defaultPrimaryConnectionString string: The primary connection string for the authorization rule RootManageSharedAccessKey.
defaultPrimaryConnectionStringAlias string: The alias of the primary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
defaultPrimaryKey string: The primary access key for the authorization rule RootManageSharedAccessKey.
defaultSecondaryConnectionString string: The secondary connection string for the authorization rule RootManageSharedAccessKey.
defaultSecondaryConnectionStringAlias string: The alias of the secondary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
defaultSecondaryKey string: The secondary access key for the authorization rule RootManageSharedAccessKey.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
maximumThroughputUnits number: Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from 1 - 20.
name string: Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.
networkRulesets EventHubNamespaceNetworkRulesets: A network_rulesets block as defined below.
resourceGroupName string: The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.
sku string: Defines which tier to use. Valid options are Basic and Standard.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

auto_inflate_enabled bool: Is Auto Inflate enabled for the EventHub Namespace?
capacity float: Specifies the Capacity / Throughput Units for a Standard SKU namespace. Valid values range from 1 - 20.
default_primary_connection_string str: The primary connection string for the authorization rule RootManageSharedAccessKey.
default_primary_connection_string_alias str: The alias of the primary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
default_primary_key str: The primary access key for the authorization rule RootManageSharedAccessKey.
default_secondary_connection_string str: The secondary connection string for the authorization rule RootManageSharedAccessKey.
default_secondary_connection_string_alias str: The alias of the secondary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.
default_secondary_key str: The secondary access key for the authorization rule RootManageSharedAccessKey.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
maximum_throughput_units float: Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from 1 - 20.
name str: Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.
network_rulesets Dict[EventHubNamespaceNetworkRulesets]: A network_rulesets block as defined below.
resource_group_name str: The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.
sku str: Defines which tier to use. Valid options are Basic and Standard.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Supporting Types

EventHubNamespaceNetworkRulesets

See the input and output API doc for this type.

DefaultAction string: The default action to take when a rule is not matched. Possible values are Allow and Deny. Defaults to Deny.
IpRules List<EventHubNamespaceNetworkRulesetsIpRuleArgs>: One or more ip_rule blocks as defined below.
VirtualNetworkRules List<EventHubNamespaceNetworkRulesetsVirtualNetworkRuleArgs>: One or more virtual_network_rule blocks as defined below.

DefaultAction string: The default action to take when a rule is not matched. Possible values are Allow and Deny. Defaults to Deny.
IpRules []EventHubNamespaceNetworkRulesetsIpRule: One or more ip_rule blocks as defined below.
VirtualNetworkRules []EventHubNamespaceNetworkRulesetsVirtualNetworkRule: One or more virtual_network_rule blocks as defined below.

defaultAction string: The default action to take when a rule is not matched. Possible values are Allow and Deny. Defaults to Deny.
ipRules EventHubNamespaceNetworkRulesetsIpRule[]: One or more ip_rule blocks as defined below.
virtualNetworkRules EventHubNamespaceNetworkRulesetsVirtualNetworkRule[]: One or more virtual_network_rule blocks as defined below.

default_action str: The default action to take when a rule is not matched. Possible values are Allow and Deny. Defaults to Deny.
ip_rules List[EventHubNamespaceNetworkRulesetsIpRule]: One or more ip_rule blocks as defined below.
virtual_network_rules List[EventHubNamespaceNetworkRulesetsVirtualNetworkRule]: One or more virtual_network_rule blocks as defined below.

EventHubNamespaceNetworkRulesetsIpRule

See the input and output API doc for this type.

IpMask string: The ip mask to match on.
Action string: The action to take when the rule is matched. Possible values are Allow.

IpMask string: The ip mask to match on.
Action string: The action to take when the rule is matched. Possible values are Allow.

ipMask string: The ip mask to match on.
action string: The action to take when the rule is matched. Possible values are Allow.

ipMask str: The ip mask to match on.
action str: The action to take when the rule is matched. Possible values are Allow.

EventHubNamespaceNetworkRulesetsVirtualNetworkRule

See the input and output API doc for this type.

SubnetId string: The id of the subnet to match on.
IgnoreMissingVirtualNetworkServiceEndpoint bool: Are missing virtual network service endpoints ignored? Defaults to false.

SubnetId string: The id of the subnet to match on.
IgnoreMissingVirtualNetworkServiceEndpoint bool: Are missing virtual network service endpoints ignored? Defaults to false.

subnetId string: The id of the subnet to match on.
ignoreMissingVirtualNetworkServiceEndpoint boolean: Are missing virtual network service endpoints ignored? Defaults to false.

subnet_id str: The id of the subnet to match on.
ignoreMissingVirtualNetworkServiceEndpoint bool: Are missing virtual network service endpoints ignored? Defaults to false.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

EventHubNamespace

Example Usage

Create a EventHubNamespace Resource

EventHubNamespace Resource Properties

Inputs

Outputs

Look up an Existing EventHubNamespace Resource

Supporting Types

EventHubNamespaceNetworkRulesets

EventHubNamespaceNetworkRulesetsIpRule

EventHubNamespaceNetworkRulesetsVirtualNetworkRule

Package Details

On This Page