AuthorizationRule

Manages a Event Hubs authorization Rule within an Event Hub.

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 US",
        });
        var exampleEventHubNamespace = new Azure.EventHub.EventHubNamespace("exampleEventHubNamespace", new Azure.EventHub.EventHubNamespaceArgs
        {
            Location = "West US",
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = "Basic",
            Capacity = 2,
            Tags = 
            {
                { "environment", "Production" },
            },
        });
        var exampleEventHub = new Azure.EventHub.EventHub("exampleEventHub", new Azure.EventHub.EventHubArgs
        {
            NamespaceName = exampleEventHubNamespace.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            PartitionCount = 2,
            MessageRetention = 2,
        });
        var exampleAuthorizationRule = new Azure.EventHub.AuthorizationRule("exampleAuthorizationRule", new Azure.EventHub.AuthorizationRuleArgs
        {
            NamespaceName = exampleEventHubNamespace.Name,
            EventhubName = exampleEventHub.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            Listen = true,
            Send = false,
            Manage = false,
        });
    }

}

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 US"),
        })
        if err != nil {
            return err
        }
        exampleEventHubNamespace, err := eventhub.NewEventHubNamespace(ctx, "exampleEventHubNamespace", &eventhub.EventHubNamespaceArgs{
            Location:          pulumi.String("West US"),
            ResourceGroupName: exampleResourceGroup.Name,
            Sku:               pulumi.String("Basic"),
            Capacity:          pulumi.Int(2),
            Tags: pulumi.Map{
                "environment": pulumi.String("Production"),
            },
        })
        if err != nil {
            return err
        }
        exampleEventHub, err := eventhub.NewEventHub(ctx, "exampleEventHub", &eventhub.EventHubArgs{
            NamespaceName:     exampleEventHubNamespace.Name,
            ResourceGroupName: exampleResourceGroup.Name,
            PartitionCount:    pulumi.Int(2),
            MessageRetention:  pulumi.Int(2),
        })
        if err != nil {
            return err
        }
        _, err = eventhub.NewAuthorizationRule(ctx, "exampleAuthorizationRule", &eventhub.AuthorizationRuleArgs{
            NamespaceName:     exampleEventHubNamespace.Name,
            EventhubName:      exampleEventHub.Name,
            ResourceGroupName: exampleResourceGroup.Name,
            Listen:            pulumi.Bool(true),
            Send:              pulumi.Bool(false),
            Manage:            pulumi.Bool(false),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_event_hub_namespace = azure.eventhub.EventHubNamespace("exampleEventHubNamespace",
    location="West US",
    resource_group_name=example_resource_group.name,
    sku="Basic",
    capacity=2,
    tags={
        "environment": "Production",
    })
example_event_hub = azure.eventhub.EventHub("exampleEventHub",
    namespace_name=example_event_hub_namespace.name,
    resource_group_name=example_resource_group.name,
    partition_count=2,
    message_retention=2)
example_authorization_rule = azure.eventhub.AuthorizationRule("exampleAuthorizationRule",
    namespace_name=example_event_hub_namespace.name,
    eventhub_name=example_event_hub.name,
    resource_group_name=example_resource_group.name,
    listen=True,
    send=False,
    manage=False)

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("exampleEventHubNamespace", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    sku: "Basic",
    capacity: 2,
    tags: {
        environment: "Production",
    },
});
const exampleEventHub = new azure.eventhub.EventHub("exampleEventHub", {
    namespaceName: exampleEventHubNamespace.name,
    resourceGroupName: exampleResourceGroup.name,
    partitionCount: 2,
    messageRetention: 2,
});
const exampleAuthorizationRule = new azure.eventhub.AuthorizationRule("exampleAuthorizationRule", {
    namespaceName: exampleEventHubNamespace.name,
    eventhubName: exampleEventHub.name,
    resourceGroupName: exampleResourceGroup.name,
    listen: true,
    send: false,
    manage: false,
});

Create a AuthorizationRule Resource

new AuthorizationRule(name: string, args: AuthorizationRuleArgs, opts?: CustomResourceOptions);

def AuthorizationRule(resource_name, opts=None, eventhub_name=None, listen=None, manage=None, name=None, namespace_name=None, resource_group_name=None, send=None, __props__=None);

func NewAuthorizationRule(ctx *Context, name string, args AuthorizationRuleArgs, opts ...ResourceOption) (*AuthorizationRule, error)

public AuthorizationRule(string name, AuthorizationRuleArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args AuthorizationRuleArgs: 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 AuthorizationRuleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

AuthorizationRule Resource Properties

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

Inputs

The AuthorizationRule resource accepts the following input properties:

EventhubName string: Specifies the name of the EventHub. Changing this forces a new resource to be created.
NamespaceName string: Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the EventHub Namespace exists. 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 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 string: Specifies the name of the EventHub. Changing this forces a new resource to be created.
NamespaceName string: Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the EventHub Namespace exists. 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 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 string: Specifies the name of the EventHub. Changing this forces a new resource to be created.
namespaceName string: Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the EventHub Namespace exists. 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 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 str: Specifies the name of the EventHub. Changing this forces a new resource to be created.
namespace_name str: Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the EventHub Namespace exists. 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 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.

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 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.

Look up an 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

static get(resource_name, id, opts=None, eventhub_name=None, listen=None, manage=None, name=None, namespace_name=None, primary_connection_string=None, primary_connection_string_alias=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_connection_string_alias=None, secondary_key=None, send=None, __props__=None);

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)

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:

EventhubName 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 string: Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
NamespaceName 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 string: The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.
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 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 string: Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
NamespaceName 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 string: The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.
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 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 string: Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
namespaceName 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 string: The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.
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 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 str: Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.
namespace_name 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 str: The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.
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.

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