Class 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,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

AuthorizationRule

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.EventHub

Assembly: Pulumi.Azure.dll

Syntax

public class AuthorizationRule : CustomResource

Constructors

AuthorizationRule(String, AuthorizationRuleArgs, CustomResourceOptions)

Create a AuthorizationRule resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
AuthorizationRuleArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

EventhubName

Specifies the name of the EventHub. Changing this forces a new resource to be created.

Declaration

public Output<string> EventhubName { get; }

Property Value

Type	Description
Output<System.String>

Listen

Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.

Declaration

public Output<bool?> Listen { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Manage

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.

Declaration

public Output<bool?> Manage { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Name

Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NamespaceName

Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

Declaration

public Output<string> NamespaceName { get; }

Property Value

Type	Description
Output<System.String>

PrimaryConnectionString

The Primary Connection String for the Event Hubs authorization Rule.

Declaration

public Output<string> PrimaryConnectionString { get; }

Property Value

Type	Description
Output<System.String>

PrimaryConnectionStringAlias

The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.

Declaration

public Output<string> PrimaryConnectionStringAlias { get; }

Property Value

Type	Description
Output<System.String>

PrimaryKey

The Primary Key for the Event Hubs authorization Rule.

Declaration

public Output<string> PrimaryKey { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

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

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

SecondaryConnectionString

The Secondary Connection String for the Event Hubs Authorization Rule.

Declaration

public Output<string> SecondaryConnectionString { get; }

Property Value

Type	Description
Output<System.String>

SecondaryConnectionStringAlias

The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.

Declaration

public Output<string> SecondaryConnectionStringAlias { get; }

Property Value

Type	Description
Output<System.String>

SecondaryKey

The Secondary Key for the Event Hubs Authorization Rule.

Declaration

public Output<string> SecondaryKey { get; }

Property Value

Type	Description
Output<System.String>

Send

Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.

Declaration

public Output<bool?> Send { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Methods

Get(String, Input<String>, AuthorizationRuleState, CustomResourceOptions)

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

Declaration

public static AuthorizationRule Get(string name, Input<string> id, AuthorizationRuleState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
AuthorizationRuleState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
AuthorizationRule