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

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus"
    "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
        }
        exampleNamespace, err := servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
            Sku:               pulumi.String("Standard"),
            Tags: pulumi.Map{
                "source": pulumi.String("example"),
            },
        })
        if err != nil {
            return err
        }
        exampleTopic, err := servicebus.NewTopic(ctx, "exampleTopic", &servicebus.TopicArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            NamespaceName:     exampleNamespace.Name,
        })
        if err != nil {
            return err
        }
        _, err = servicebus.NewTopicAuthorizationRule(ctx, "exampleTopicAuthorizationRule", &servicebus.TopicAuthorizationRuleArgs{
            NamespaceName:     exampleNamespace.Name,
            TopicName:         exampleTopic.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_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    tags={
        "source": "example",
    })
example_topic = azure.servicebus.Topic("exampleTopic",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name)
example_topic_authorization_rule = azure.servicebus.TopicAuthorizationRule("exampleTopicAuthorizationRule",
    namespace_name=example_namespace.name,
    topic_name=example_topic.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 exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "Standard",
    tags: {
        source: "example",
    },
});
const exampleTopic = new azure.servicebus.Topic("exampleTopic", {
    resourceGroupName: exampleResourceGroup.name,
    namespaceName: exampleNamespace.name,
});
const exampleTopicAuthorizationRule = new azure.servicebus.TopicAuthorizationRule("exampleTopicAuthorizationRule", {
    namespaceName: exampleNamespace.name,
    topicName: exampleTopic.name,
    resourceGroupName: exampleResourceGroup.name,
    listen: true,
    send: false,
    manage: false,
});

Create a TopicAuthorizationRule Resource

new TopicAuthorizationRule(name: string, args: TopicAuthorizationRuleArgs, opts?: CustomResourceOptions);

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

func NewTopicAuthorizationRule(ctx *Context, name string, args TopicAuthorizationRuleArgs, opts ...ResourceOption) (*TopicAuthorizationRule, error)

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

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

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

TopicAuthorizationRule Resource Properties

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

Inputs

The TopicAuthorizationRule resource accepts the following input properties:

NamespaceName string: Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.
TopicName string: Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created.
Listen bool: Grants listen access to this this Authorization Rule. Defaults to false.
Manage bool: Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.
Name string: Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.
Send bool: Grants send access to this this Authorization Rule. Defaults to false.

NamespaceName string: Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.
TopicName string: Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created.
Listen bool: Grants listen access to this this Authorization Rule. Defaults to false.
Manage bool: Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.
Name string: Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.
Send bool: Grants send access to this this Authorization Rule. Defaults to false.

namespaceName string: Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.
topicName string: Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created.
listen boolean: Grants listen access to this this Authorization Rule. Defaults to false.
manage boolean: Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.
name string: Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.
send boolean: Grants send access to this this Authorization Rule. Defaults to false.

namespace_name str: Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.
topic_name str: Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created.
listen bool: Grants listen access to this this Authorization Rule. Defaults to false.
manage bool: Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.
name str: Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.
send bool: Grants send access to this this Authorization Rule. Defaults to false.

Outputs

All input properties are implicitly available as output properties. Additionally, the TopicAuthorizationRule 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 ServiceBus Topic authorization Rule.
PrimaryKey string: The Primary Key for the ServiceBus Topic authorization Rule.
SecondaryConnectionString string: The Secondary Connection String for the ServiceBus Topic authorization Rule.
SecondaryKey string: The Secondary Key for the ServiceBus Topic authorization Rule.

Id string: The provider-assigned unique ID for this managed resource.
PrimaryConnectionString string: The Primary Connection String for the ServiceBus Topic authorization Rule.
PrimaryKey string: The Primary Key for the ServiceBus Topic authorization Rule.
SecondaryConnectionString string: The Secondary Connection String for the ServiceBus Topic authorization Rule.
SecondaryKey string: The Secondary Key for the ServiceBus Topic authorization Rule.

id string: The provider-assigned unique ID for this managed resource.
primaryConnectionString string: The Primary Connection String for the ServiceBus Topic authorization Rule.
primaryKey string: The Primary Key for the ServiceBus Topic authorization Rule.
secondaryConnectionString string: The Secondary Connection String for the ServiceBus Topic authorization Rule.
secondaryKey string: The Secondary Key for the ServiceBus Topic authorization Rule.

id str: The provider-assigned unique ID for this managed resource.
primary_connection_string str: The Primary Connection String for the ServiceBus Topic authorization Rule.
primary_key str: The Primary Key for the ServiceBus Topic authorization Rule.
secondary_connection_string str: The Secondary Connection String for the ServiceBus Topic authorization Rule.
secondary_key str: The Secondary Key for the ServiceBus Topic authorization Rule.

Look up an Existing TopicAuthorizationRule Resource

Get an existing TopicAuthorizationRule 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?: TopicAuthorizationRuleState, opts?: CustomResourceOptions): TopicAuthorizationRule

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

func GetTopicAuthorizationRule(ctx *Context, name string, id IDInput, state *TopicAuthorizationRuleState, opts ...ResourceOption) (*TopicAuthorizationRule, error)

public static TopicAuthorizationRule Get(string name, Input<string> id, TopicAuthorizationRuleState? 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:

Listen bool: Grants listen access to this this Authorization Rule. Defaults to false.
Manage bool: Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.
Name string: Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.
NamespaceName string: Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.
PrimaryConnectionString string: The Primary Connection String for the ServiceBus Topic authorization Rule.
PrimaryKey string: The Primary Key for the ServiceBus Topic authorization Rule.
ResourceGroupName string: The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.
SecondaryConnectionString string: The Secondary Connection String for the ServiceBus Topic authorization Rule.
SecondaryKey string: The Secondary Key for the ServiceBus Topic authorization Rule.
Send bool: Grants send access to this this Authorization Rule. Defaults to false.
TopicName string: Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created.

Listen bool: Grants listen access to this this Authorization Rule. Defaults to false.
Manage bool: Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.
Name string: Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.
NamespaceName string: Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.
PrimaryConnectionString string: The Primary Connection String for the ServiceBus Topic authorization Rule.
PrimaryKey string: The Primary Key for the ServiceBus Topic authorization Rule.
ResourceGroupName string: The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.
SecondaryConnectionString string: The Secondary Connection String for the ServiceBus Topic authorization Rule.
SecondaryKey string: The Secondary Key for the ServiceBus Topic authorization Rule.
Send bool: Grants send access to this this Authorization Rule. Defaults to false.
TopicName string: Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created.

listen boolean: Grants listen access to this this Authorization Rule. Defaults to false.
manage boolean: Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.
name string: Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.
namespaceName string: Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.
primaryConnectionString string: The Primary Connection String for the ServiceBus Topic authorization Rule.
primaryKey string: The Primary Key for the ServiceBus Topic authorization Rule.
resourceGroupName string: The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.
secondaryConnectionString string: The Secondary Connection String for the ServiceBus Topic authorization Rule.
secondaryKey string: The Secondary Key for the ServiceBus Topic authorization Rule.
send boolean: Grants send access to this this Authorization Rule. Defaults to false.
topicName string: Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created.

listen bool: Grants listen access to this this Authorization Rule. Defaults to false.
manage bool: Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.
name str: Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.
namespace_name str: Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.
primary_connection_string str: The Primary Connection String for the ServiceBus Topic authorization Rule.
primary_key str: The Primary Key for the ServiceBus Topic authorization Rule.
resource_group_name str: The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.
secondary_connection_string str: The Secondary Connection String for the ServiceBus Topic authorization Rule.
secondary_key str: The Secondary Key for the ServiceBus Topic authorization Rule.
send bool: Grants send access to this this Authorization Rule. Defaults to false.
topic_name str: Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created.

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