Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. eventhub
  5. AuthorizationRule

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.eventhub.AuthorizationRule

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Event Hubs authorization Rule within an Event Hub.

Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("example", {
    name: "acceptanceTestEventHubNamespace",
    location: example.location,
    resourceGroupName: example.name,
    sku: "Basic",
    capacity: 2,
    tags: {
        environment: "Production",
    },
});
const exampleEventHub = new azure.eventhub.EventHub("example", {
    name: "acceptanceTestEventHub",
    namespaceName: exampleEventHubNamespace.name,
    resourceGroupName: example.name,
    partitionCount: 2,
    messageRetention: 2,
});
const exampleAuthorizationRule = new azure.eventhub.AuthorizationRule("example", {
    name: "navi",
    namespaceName: exampleEventHubNamespace.name,
    eventhubName: exampleEventHub.name,
    resourceGroupName: example.name,
    listen: true,
    send: false,
    manage: false,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_event_hub_namespace = azure.eventhub.EventHubNamespace("example",
    name="acceptanceTestEventHubNamespace",
    location=example.location,
    resource_group_name=example.name,
    sku="Basic",
    capacity=2,
    tags={
        "environment": "Production",
    })
example_event_hub = azure.eventhub.EventHub("example",
    name="acceptanceTestEventHub",
    namespace_name=example_event_hub_namespace.name,
    resource_group_name=example.name,
    partition_count=2,
    message_retention=2)
example_authorization_rule = azure.eventhub.AuthorizationRule("example",
    name="navi",
    namespace_name=example_event_hub_namespace.name,
    eventhub_name=example_event_hub.name,
    resource_group_name=example.name,
    listen=True,
    send=False,
    manage=False)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleEventHubNamespace, err := eventhub.NewEventHubNamespace(ctx, "example", &eventhub.EventHubNamespaceArgs{
			Name:              pulumi.String("acceptanceTestEventHubNamespace"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku:               pulumi.String("Basic"),
			Capacity:          pulumi.Int(2),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		exampleEventHub, err := eventhub.NewEventHub(ctx, "example", &eventhub.EventHubArgs{
			Name:              pulumi.String("acceptanceTestEventHub"),
			NamespaceName:     exampleEventHubNamespace.Name,
			ResourceGroupName: example.Name,
			PartitionCount:    pulumi.Int(2),
			MessageRetention:  pulumi.Int(2),
		})
		if err != nil {
			return err
		}
		_, err = eventhub.NewAuthorizationRule(ctx, "example", &eventhub.AuthorizationRuleArgs{
			Name:              pulumi.String("navi"),
			NamespaceName:     exampleEventHubNamespace.Name,
			EventhubName:      exampleEventHub.Name,
			ResourceGroupName: example.Name,
			Listen:            pulumi.Bool(true),
			Send:              pulumi.Bool(false),
			Manage:            pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleEventHubNamespace = new Azure.EventHub.EventHubNamespace("example", new()
    {
        Name = "acceptanceTestEventHubNamespace",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = "Basic",
        Capacity = 2,
        Tags = 
        {
            { "environment", "Production" },
        },
    });

    var exampleEventHub = new Azure.EventHub.EventHub("example", new()
    {
        Name = "acceptanceTestEventHub",
        NamespaceName = exampleEventHubNamespace.Name,
        ResourceGroupName = example.Name,
        PartitionCount = 2,
        MessageRetention = 2,
    });

    var exampleAuthorizationRule = new Azure.EventHub.AuthorizationRule("example", new()
    {
        Name = "navi",
        NamespaceName = exampleEventHubNamespace.Name,
        EventhubName = exampleEventHub.Name,
        ResourceGroupName = example.Name,
        Listen = true,
        Send = false,
        Manage = false,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.eventhub.EventHubNamespace;
import com.pulumi.azure.eventhub.EventHubNamespaceArgs;
import com.pulumi.azure.eventhub.EventHub;
import com.pulumi.azure.eventhub.EventHubArgs;
import com.pulumi.azure.eventhub.AuthorizationRule;
import com.pulumi.azure.eventhub.AuthorizationRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleEventHubNamespace = new EventHubNamespace("exampleEventHubNamespace", EventHubNamespaceArgs.builder()
            .name("acceptanceTestEventHubNamespace")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku("Basic")
            .capacity(2)
            .tags(Map.of("environment", "Production"))
            .build());

        var exampleEventHub = new EventHub("exampleEventHub", EventHubArgs.builder()
            .name("acceptanceTestEventHub")
            .namespaceName(exampleEventHubNamespace.name())
            .resourceGroupName(example.name())
            .partitionCount(2)
            .messageRetention(2)
            .build());

        var exampleAuthorizationRule = new AuthorizationRule("exampleAuthorizationRule", AuthorizationRuleArgs.builder()
            .name("navi")
            .namespaceName(exampleEventHubNamespace.name())
            .eventhubName(exampleEventHub.name())
            .resourceGroupName(example.name())
            .listen(true)
            .send(false)
            .manage(false)
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleEventHubNamespace:
    type: azure:eventhub:EventHubNamespace
    name: example
    properties:
      name: acceptanceTestEventHubNamespace
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku: Basic
      capacity: 2
      tags:
        environment: Production
  exampleEventHub:
    type: azure:eventhub:EventHub
    name: example
    properties:
      name: acceptanceTestEventHub
      namespaceName: ${exampleEventHubNamespace.name}
      resourceGroupName: ${example.name}
      partitionCount: 2
      messageRetention: 2
  exampleAuthorizationRule:
    type: azure:eventhub:AuthorizationRule
    name: example
    properties:
      name: navi
      namespaceName: ${exampleEventHubNamespace.name}
      eventhubName: ${exampleEventHub.name}
      resourceGroupName: ${example.name}
      listen: true
      send: false
      manage: false
Copy

Create AuthorizationRule Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AuthorizationRule(name: string, args: AuthorizationRuleArgs, opts?: CustomResourceOptions);
@overload
def AuthorizationRule(resource_name: str,
                      args: AuthorizationRuleArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def AuthorizationRule(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      eventhub_name: Optional[str] = None,
                      namespace_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      listen: Optional[bool] = None,
                      manage: Optional[bool] = None,
                      name: Optional[str] = None,
                      send: Optional[bool] = None)
func NewAuthorizationRule(ctx *Context, name string, args AuthorizationRuleArgs, opts ...ResourceOption) (*AuthorizationRule, error)
public AuthorizationRule(string name, AuthorizationRuleArgs args, CustomResourceOptions? opts = null)
public AuthorizationRule(String name, AuthorizationRuleArgs args)
public AuthorizationRule(String name, AuthorizationRuleArgs args, CustomResourceOptions options)

type: azure:eventhub:AuthorizationRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AuthorizationRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AuthorizationRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AuthorizationRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AuthorizationRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AuthorizationRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var authorizationRuleResource = new Azure.EventHub.AuthorizationRule("authorizationRuleResource", new()
{
    EventhubName = "string",
    NamespaceName = "string",
    ResourceGroupName = "string",
    Listen = false,
    Manage = false,
    Name = "string",
    Send = false,
});
Copy
example, err := eventhub.NewAuthorizationRule(ctx, "authorizationRuleResource", &eventhub.AuthorizationRuleArgs{
	EventhubName:      pulumi.String("string"),
	NamespaceName:     pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Listen:            pulumi.Bool(false),
	Manage:            pulumi.Bool(false),
	Name:              pulumi.String("string"),
	Send:              pulumi.Bool(false),
})
Copy
var authorizationRuleResource = new com.pulumi.azure.eventhub.AuthorizationRule("authorizationRuleResource", com.pulumi.azure.eventhub.AuthorizationRuleArgs.builder()
    .eventhubName("string")
    .namespaceName("string")
    .resourceGroupName("string")
    .listen(false)
    .manage(false)
    .name("string")
    .send(false)
    .build());
Copy
authorization_rule_resource = azure.eventhub.AuthorizationRule("authorizationRuleResource",
    eventhub_name="string",
    namespace_name="string",
    resource_group_name="string",
    listen=False,
    manage=False,
    name="string",
    send=False)
Copy
const authorizationRuleResource = new azure.eventhub.AuthorizationRule("authorizationRuleResource", {
    eventhubName: "string",
    namespaceName: "string",
    resourceGroupName: "string",
    listen: false,
    manage: false,
    name: "string",
    send: false,
});
Copy
type: azure:eventhub:AuthorizationRule
properties:
    eventhubName: string
    listen: false
    manage: false
    name: string
    namespaceName: string
    resourceGroupName: string
    send: false
Copy

AuthorizationRule Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AuthorizationRule resource accepts the following input properties:

EventhubName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the EventHub. Changing this forces a new resource to be created.
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string

The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

NOTE At least one of the 3 permissions below needs to be set.

Listen bool
Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.
Manage bool
Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.
Name Changes to this property will trigger replacement. string
Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
Send bool
Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.
EventhubName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the EventHub. Changing this forces a new resource to be created.
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string

The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

NOTE At least one of the 3 permissions below needs to be set.

Listen bool
Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.
Manage bool
Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.
Name Changes to this property will trigger replacement. string
Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
Send bool
Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.
eventhubName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the EventHub. Changing this forces a new resource to be created.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String

The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

NOTE At least one of the 3 permissions below needs to be set.

listen Boolean
Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.
manage Boolean
Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.
name Changes to this property will trigger replacement. String
Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
send Boolean
Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.
eventhubName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the EventHub. Changing this forces a new resource to be created.
namespaceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string

The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

NOTE At least one of the 3 permissions below needs to be set.

listen boolean
Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.
manage boolean
Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.
name Changes to this property will trigger replacement. string
Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
send boolean
Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.
eventhub_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the name of the EventHub. Changing this forces a new resource to be created.
namespace_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str

The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

NOTE At least one of the 3 permissions below needs to be set.

listen bool
Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.
manage bool
Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.
name Changes to this property will trigger replacement. str
Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
send bool
Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.
eventhubName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the EventHub. Changing this forces a new resource to be created.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String

The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

NOTE At least one of the 3 permissions below needs to be set.

listen Boolean
Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.
manage Boolean
Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.
name Changes to this property will trigger replacement. String
Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
send Boolean
Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
PrimaryConnectionString string
The Primary Connection String for the Event Hubs authorization Rule.
PrimaryConnectionStringAlias string
The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.
PrimaryKey string
The Primary Key for the Event Hubs authorization Rule.
SecondaryConnectionString string
The Secondary Connection String for the Event Hubs Authorization Rule.
SecondaryConnectionStringAlias string
The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.
SecondaryKey string
The Secondary Key for the Event Hubs Authorization Rule.
Id string
The provider-assigned unique ID for this managed resource.
PrimaryConnectionString string
The Primary Connection String for the Event Hubs authorization Rule.
PrimaryConnectionStringAlias string
The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.
PrimaryKey string
The Primary Key for the Event Hubs authorization Rule.
SecondaryConnectionString string
The Secondary Connection String for the Event Hubs Authorization Rule.
SecondaryConnectionStringAlias string
The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.
SecondaryKey string
The Secondary Key for the Event Hubs Authorization Rule.
id String
The provider-assigned unique ID for this managed resource.
primaryConnectionString String
The Primary Connection String for the Event Hubs authorization Rule.
primaryConnectionStringAlias String
The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.
primaryKey String
The Primary Key for the Event Hubs authorization Rule.
secondaryConnectionString String
The Secondary Connection String for the Event Hubs Authorization Rule.
secondaryConnectionStringAlias String
The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.
secondaryKey String
The Secondary Key for the Event Hubs Authorization Rule.
id string
The provider-assigned unique ID for this managed resource.
primaryConnectionString string
The Primary Connection String for the Event Hubs authorization Rule.
primaryConnectionStringAlias string
The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.
primaryKey string
The Primary Key for the Event Hubs authorization Rule.
secondaryConnectionString string
The Secondary Connection String for the Event Hubs Authorization Rule.
secondaryConnectionStringAlias string
The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.
secondaryKey string
The Secondary Key for the Event Hubs Authorization Rule.
id str
The provider-assigned unique ID for this managed resource.
primary_connection_string str
The Primary Connection String for the Event Hubs authorization Rule.
primary_connection_string_alias str
The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.
primary_key str
The Primary Key for the Event Hubs authorization Rule.
secondary_connection_string str
The Secondary Connection String for the Event Hubs Authorization Rule.
secondary_connection_string_alias str
The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.
secondary_key str
The Secondary Key for the Event Hubs Authorization Rule.
id String
The provider-assigned unique ID for this managed resource.
primaryConnectionString String
The Primary Connection String for the Event Hubs authorization Rule.
primaryConnectionStringAlias String
The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.
primaryKey String
The Primary Key for the Event Hubs authorization Rule.
secondaryConnectionString String
The Secondary Connection String for the Event Hubs Authorization Rule.
secondaryConnectionStringAlias String
The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.
secondaryKey String
The Secondary Key for the Event Hubs Authorization Rule.

Look up Existing AuthorizationRule Resource

Get an existing AuthorizationRule 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?: AuthorizationRuleState, opts?: CustomResourceOptions): AuthorizationRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        eventhub_name: Optional[str] = None,
        listen: Optional[bool] = None,
        manage: Optional[bool] = None,
        name: Optional[str] = None,
        namespace_name: Optional[str] = None,
        primary_connection_string: Optional[str] = None,
        primary_connection_string_alias: Optional[str] = None,
        primary_key: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        secondary_connection_string: Optional[str] = None,
        secondary_connection_string_alias: Optional[str] = None,
        secondary_key: Optional[str] = None,
        send: Optional[bool] = None) -> AuthorizationRule
func GetAuthorizationRule(ctx *Context, name string, id IDInput, state *AuthorizationRuleState, opts ...ResourceOption) (*AuthorizationRule, error)
public static AuthorizationRule Get(string name, Input<string> id, AuthorizationRuleState? state, CustomResourceOptions? opts = null)
public static AuthorizationRule get(String name, Output<String> id, AuthorizationRuleState state, CustomResourceOptions options)
resources:  _:    type: azure:eventhub:AuthorizationRule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
EventhubName Changes to this property will trigger replacement. string
Specifies the name of the EventHub. Changing this forces a new resource to be created.
Listen bool
Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.
Manage bool
Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.
Name Changes to this property will trigger replacement. string
Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
NamespaceName Changes to this property will trigger replacement. string
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
PrimaryConnectionString string
The Primary Connection String for the Event Hubs authorization Rule.
PrimaryConnectionStringAlias string
The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.
PrimaryKey string
The Primary Key for the Event Hubs authorization Rule.
ResourceGroupName Changes to this property will trigger replacement. string

The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

NOTE At least one of the 3 permissions below needs to be set.

SecondaryConnectionString string
The Secondary Connection String for the Event Hubs Authorization Rule.
SecondaryConnectionStringAlias string
The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.
SecondaryKey string
The Secondary Key for the Event Hubs Authorization Rule.
Send bool
Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.
EventhubName Changes to this property will trigger replacement. string
Specifies the name of the EventHub. Changing this forces a new resource to be created.
Listen bool
Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.
Manage bool
Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.
Name Changes to this property will trigger replacement. string
Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
NamespaceName Changes to this property will trigger replacement. string
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
PrimaryConnectionString string
The Primary Connection String for the Event Hubs authorization Rule.
PrimaryConnectionStringAlias string
The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.
PrimaryKey string
The Primary Key for the Event Hubs authorization Rule.
ResourceGroupName Changes to this property will trigger replacement. string

The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

NOTE At least one of the 3 permissions below needs to be set.

SecondaryConnectionString string
The Secondary Connection String for the Event Hubs Authorization Rule.
SecondaryConnectionStringAlias string
The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.
SecondaryKey string
The Secondary Key for the Event Hubs Authorization Rule.
Send bool
Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.
eventhubName Changes to this property will trigger replacement. String
Specifies the name of the EventHub. Changing this forces a new resource to be created.
listen Boolean
Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.
manage Boolean
Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.
name Changes to this property will trigger replacement. String
Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
namespaceName Changes to this property will trigger replacement. String
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
primaryConnectionString String
The Primary Connection String for the Event Hubs authorization Rule.
primaryConnectionStringAlias String
The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.
primaryKey String
The Primary Key for the Event Hubs authorization Rule.
resourceGroupName Changes to this property will trigger replacement. String

The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

NOTE At least one of the 3 permissions below needs to be set.

secondaryConnectionString String
The Secondary Connection String for the Event Hubs Authorization Rule.
secondaryConnectionStringAlias String
The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.
secondaryKey String
The Secondary Key for the Event Hubs Authorization Rule.
send Boolean
Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.
eventhubName Changes to this property will trigger replacement. string
Specifies the name of the EventHub. Changing this forces a new resource to be created.
listen boolean
Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.
manage boolean
Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.
name Changes to this property will trigger replacement. string
Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
namespaceName Changes to this property will trigger replacement. string
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
primaryConnectionString string
The Primary Connection String for the Event Hubs authorization Rule.
primaryConnectionStringAlias string
The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.
primaryKey string
The Primary Key for the Event Hubs authorization Rule.
resourceGroupName Changes to this property will trigger replacement. string

The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

NOTE At least one of the 3 permissions below needs to be set.

secondaryConnectionString string
The Secondary Connection String for the Event Hubs Authorization Rule.
secondaryConnectionStringAlias string
The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.
secondaryKey string
The Secondary Key for the Event Hubs Authorization Rule.
send boolean
Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.
eventhub_name Changes to this property will trigger replacement. str
Specifies the name of the EventHub. Changing this forces a new resource to be created.
listen bool
Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.
manage bool
Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.
name Changes to this property will trigger replacement. str
Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
namespace_name Changes to this property will trigger replacement. str
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
primary_connection_string str
The Primary Connection String for the Event Hubs authorization Rule.
primary_connection_string_alias str
The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.
primary_key str
The Primary Key for the Event Hubs authorization Rule.
resource_group_name Changes to this property will trigger replacement. str

The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

NOTE At least one of the 3 permissions below needs to be set.

secondary_connection_string str
The Secondary Connection String for the Event Hubs Authorization Rule.
secondary_connection_string_alias str
The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.
secondary_key str
The Secondary Key for the Event Hubs Authorization Rule.
send bool
Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.
eventhubName Changes to this property will trigger replacement. String
Specifies the name of the EventHub. Changing this forces a new resource to be created.
listen Boolean
Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.
manage Boolean
Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.
name Changes to this property will trigger replacement. String
Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
namespaceName Changes to this property will trigger replacement. String
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
primaryConnectionString String
The Primary Connection String for the Event Hubs authorization Rule.
primaryConnectionStringAlias String
The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.
primaryKey String
The Primary Key for the Event Hubs authorization Rule.
resourceGroupName Changes to this property will trigger replacement. String

The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

NOTE At least one of the 3 permissions below needs to be set.

secondaryConnectionString String
The Secondary Connection String for the Event Hubs Authorization Rule.
secondaryConnectionStringAlias String
The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.
secondaryKey String
The Secondary Key for the Event Hubs Authorization Rule.
send Boolean
Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.

Import

EventHub Authorization Rules can be imported using the resource id, e.g.

$ pulumi import azure:eventhub/authorizationRule:AuthorizationRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.EventHub/namespaces/namespace1/eventhubs/eventhub1/authorizationRules/rule1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure