Class TopicAuthorizationRule

Manages a ServiceBus Topic authorization Rule within a ServiceBus Topic.

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 exampleNamespace = new Azure.ServiceBus.Namespace("exampleNamespace", new Azure.ServiceBus.NamespaceArgs
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        Sku = "Standard",
        Tags = 
        {
            { "source", "example" },
        },
    });
    var exampleTopic = new Azure.ServiceBus.Topic("exampleTopic", new Azure.ServiceBus.TopicArgs
    {
        ResourceGroupName = exampleResourceGroup.Name,
        NamespaceName = exampleNamespace.Name,
    });
    var exampleTopicAuthorizationRule = new Azure.ServiceBus.TopicAuthorizationRule("exampleTopicAuthorizationRule", new Azure.ServiceBus.TopicAuthorizationRuleArgs
    {
        NamespaceName = exampleNamespace.Name,
        TopicName = exampleTopic.Name,
        ResourceGroupName = exampleResourceGroup.Name,
        Listen = true,
        Send = false,
        Manage = false,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

TopicAuthorizationRule

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

Assembly: Pulumi.Azure.dll

Syntax

public class TopicAuthorizationRule : CustomResource

Constructors

TopicAuthorizationRule(String, TopicAuthorizationRuleArgs, CustomResourceOptions)

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

Declaration

public TopicAuthorizationRule(string name, TopicAuthorizationRuleArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

Listen

Grants listen access to this this Authorization Rule. Defaults to false.

Declaration

public Output<bool?> Listen { get; }

Property Value

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

Manage

Grants manage access to this this Authorization Rule. 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 ServiceBus Topic 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 ServiceBus 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 ServiceBus Topic authorization Rule.

Declaration

public Output<string> PrimaryConnectionString { get; }

Property Value

Type	Description
Output<System.String>

PrimaryKey

The Primary Key for the ServiceBus Topic 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 ServiceBus 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 ServiceBus Topic authorization Rule.

Declaration

public Output<string> SecondaryConnectionString { get; }

Property Value

Type	Description
Output<System.String>

SecondaryKey

The Secondary Key for the ServiceBus Topic authorization Rule.

Declaration

public Output<string> SecondaryKey { get; }

Property Value

Type	Description
Output<System.String>

Send

Grants send access to this this Authorization Rule. Defaults to false.

Declaration

public Output<bool?> Send { get; }

Property Value

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

TopicName

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

Declaration

public Output<string> TopicName { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

public static TopicAuthorizationRule Get(string name, Input<string> id, TopicAuthorizationRuleState 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.
TopicAuthorizationRuleState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
TopicAuthorizationRule