Azure Classic v5.38.0, Mar 21 23

azure.servicebus.TopicAuthorizationRule

Manages a ServiceBus Topic authorization Rule within a ServiceBus Topic.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

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

    var exampleNamespace = new Azure.ServiceBus.Namespace("exampleNamespace", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        Sku = "Standard",
        Tags = 
        {
            { "source", "example" },
        },
    });

    var exampleTopic = new Azure.ServiceBus.Topic("exampleTopic", new()
    {
        NamespaceId = exampleNamespace.Id,
    });

    var exampleTopicAuthorizationRule = new Azure.ServiceBus.TopicAuthorizationRule("exampleTopicAuthorizationRule", new()
    {
        TopicId = exampleTopic.Id,
        Listen = true,
        Send = false,
        Manage = false,
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/servicebus"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		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.StringMap{
				"source": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		exampleTopic, err := servicebus.NewTopic(ctx, "exampleTopic", &servicebus.TopicArgs{
			NamespaceId: exampleNamespace.ID(),
		})
		if err != nil {
			return err
		}
		_, err = servicebus.NewTopicAuthorizationRule(ctx, "exampleTopicAuthorizationRule", &servicebus.TopicAuthorizationRuleArgs{
			TopicId: exampleTopic.ID(),
			Listen:  pulumi.Bool(true),
			Send:    pulumi.Bool(false),
			Manage:  pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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.servicebus.Namespace;
import com.pulumi.azure.servicebus.NamespaceArgs;
import com.pulumi.azure.servicebus.Topic;
import com.pulumi.azure.servicebus.TopicArgs;
import com.pulumi.azure.servicebus.TopicAuthorizationRule;
import com.pulumi.azure.servicebus.TopicAuthorizationRuleArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .sku("Standard")
            .tags(Map.of("source", "example"))
            .build());

        var exampleTopic = new Topic("exampleTopic", TopicArgs.builder()        
            .namespaceId(exampleNamespace.id())
            .build());

        var exampleTopicAuthorizationRule = new TopicAuthorizationRule("exampleTopicAuthorizationRule", TopicAuthorizationRuleArgs.builder()        
            .topicId(exampleTopic.id())
            .listen(true)
            .send(false)
            .manage(false)
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
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", namespace_id=example_namespace.id)
example_topic_authorization_rule = azure.servicebus.TopicAuthorizationRule("exampleTopicAuthorizationRule",
    topic_id=example_topic.id,
    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 Europe"});
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", {namespaceId: exampleNamespace.id});
const exampleTopicAuthorizationRule = new azure.servicebus.TopicAuthorizationRule("exampleTopicAuthorizationRule", {
    topicId: exampleTopic.id,
    listen: true,
    send: false,
    manage: false,
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleNamespace:
    type: azure:servicebus:Namespace
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      sku: Standard
      tags:
        source: example
  exampleTopic:
    type: azure:servicebus:Topic
    properties:
      namespaceId: ${exampleNamespace.id}
  exampleTopicAuthorizationRule:
    type: azure:servicebus:TopicAuthorizationRule
    properties:
      topicId: ${exampleTopic.id}
      listen: true
      send: false
      manage: false

Create TopicAuthorizationRule Resource

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

@overload
def TopicAuthorizationRule(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           listen: Optional[bool] = None,
                           manage: Optional[bool] = None,
                           name: Optional[str] = None,
                           send: Optional[bool] = None,
                           topic_id: Optional[str] = None)
@overload
def TopicAuthorizationRule(resource_name: str,
                           args: TopicAuthorizationRuleArgs,
                           opts: Optional[ResourceOptions] = None)

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

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

public TopicAuthorizationRule(String name, TopicAuthorizationRuleArgs args)
public TopicAuthorizationRule(String name, TopicAuthorizationRuleArgs args, CustomResourceOptions options)

type: azure:servicebus:TopicAuthorizationRule
properties: # The arguments to resource properties.
options: # 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.

resource_name str: The unique name of the resource.
args TopicAuthorizationRuleArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control 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.

name String: The unique name of the resource.
args TopicAuthorizationRuleArgs: The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The TopicAuthorizationRule resource accepts the following input properties:

TopicId string: Specifies the ID 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.

TopicId string: Specifies the ID 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.

topicId String: Specifies the ID 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.

topicId string: Specifies the ID 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.

topic_id str: Specifies the ID 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.

topicId String: Specifies the ID 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.

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.
PrimaryConnectionStringAlias string: The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
PrimaryKey string: The Primary Key for the ServiceBus Topic authorization Rule.
SecondaryConnectionString string: The Secondary Connection String for the ServiceBus Topic authorization Rule.
SecondaryConnectionStringAlias string: The alias Secondary Connection String for the ServiceBus Namespace
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.
PrimaryConnectionStringAlias string: The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
PrimaryKey string: The Primary Key for the ServiceBus Topic authorization Rule.
SecondaryConnectionString string: The Secondary Connection String for the ServiceBus Topic authorization Rule.
SecondaryConnectionStringAlias string: The alias Secondary Connection String for the ServiceBus Namespace
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.
primaryConnectionStringAlias String: The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
primaryKey String: The Primary Key for the ServiceBus Topic authorization Rule.
secondaryConnectionString String: The Secondary Connection String for the ServiceBus Topic authorization Rule.
secondaryConnectionStringAlias String: The alias Secondary Connection String for the ServiceBus Namespace
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.
primaryConnectionStringAlias string: The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
primaryKey string: The Primary Key for the ServiceBus Topic authorization Rule.
secondaryConnectionString string: The Secondary Connection String for the ServiceBus Topic authorization Rule.
secondaryConnectionStringAlias string: The alias Secondary Connection String for the ServiceBus Namespace
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_connection_string_alias str: The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
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_connection_string_alias str: The alias Secondary Connection String for the ServiceBus Namespace
secondary_key str: 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.
primaryConnectionStringAlias String: The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
primaryKey String: The Primary Key for the ServiceBus Topic authorization Rule.
secondaryConnectionString String: The Secondary Connection String for the ServiceBus Topic authorization Rule.
secondaryConnectionStringAlias String: The alias Secondary Connection String for the ServiceBus Namespace
secondaryKey String: The Secondary Key for the ServiceBus Topic authorization Rule.

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        listen: Optional[bool] = None,
        manage: Optional[bool] = None,
        name: Optional[str] = None,
        primary_connection_string: Optional[str] = None,
        primary_connection_string_alias: Optional[str] = None,
        primary_key: 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,
        topic_id: Optional[str] = None) -> TopicAuthorizationRule

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)

public static TopicAuthorizationRule get(String name, Output<String> id, TopicAuthorizationRuleState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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.

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.
PrimaryConnectionString string: The Primary Connection String for the ServiceBus Topic authorization Rule.
PrimaryConnectionStringAlias string: The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
PrimaryKey string: The Primary Key for the ServiceBus Topic authorization Rule.
SecondaryConnectionString string: The Secondary Connection String for the ServiceBus Topic authorization Rule.
SecondaryConnectionStringAlias string: The alias Secondary Connection String for the ServiceBus Namespace
SecondaryKey string: The Secondary Key for the ServiceBus Topic authorization Rule.
Send bool: Grants send access to this this Authorization Rule. Defaults to false.
TopicId string: Specifies the ID 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.
PrimaryConnectionString string: The Primary Connection String for the ServiceBus Topic authorization Rule.
PrimaryConnectionStringAlias string: The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
PrimaryKey string: The Primary Key for the ServiceBus Topic authorization Rule.
SecondaryConnectionString string: The Secondary Connection String for the ServiceBus Topic authorization Rule.
SecondaryConnectionStringAlias string: The alias Secondary Connection String for the ServiceBus Namespace
SecondaryKey string: The Secondary Key for the ServiceBus Topic authorization Rule.
Send bool: Grants send access to this this Authorization Rule. Defaults to false.
TopicId string: Specifies the ID 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.
primaryConnectionString String: The Primary Connection String for the ServiceBus Topic authorization Rule.
primaryConnectionStringAlias String: The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
primaryKey String: The Primary Key for the ServiceBus Topic authorization Rule.
secondaryConnectionString String: The Secondary Connection String for the ServiceBus Topic authorization Rule.
secondaryConnectionStringAlias String: The alias Secondary Connection String for the ServiceBus Namespace
secondaryKey String: The Secondary Key for the ServiceBus Topic authorization Rule.
send Boolean: Grants send access to this this Authorization Rule. Defaults to false.
topicId String: Specifies the ID 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.
primaryConnectionString string: The Primary Connection String for the ServiceBus Topic authorization Rule.
primaryConnectionStringAlias string: The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
primaryKey string: The Primary Key for the ServiceBus Topic authorization Rule.
secondaryConnectionString string: The Secondary Connection String for the ServiceBus Topic authorization Rule.
secondaryConnectionStringAlias string: The alias Secondary Connection String for the ServiceBus Namespace
secondaryKey string: The Secondary Key for the ServiceBus Topic authorization Rule.
send boolean: Grants send access to this this Authorization Rule. Defaults to false.
topicId string: Specifies the ID 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.
primary_connection_string str: The Primary Connection String for the ServiceBus Topic authorization Rule.
primary_connection_string_alias str: The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
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_connection_string_alias str: The alias Secondary Connection String for the ServiceBus Namespace
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_id str: Specifies the ID 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.
primaryConnectionString String: The Primary Connection String for the ServiceBus Topic authorization Rule.
primaryConnectionStringAlias String: The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
primaryKey String: The Primary Key for the ServiceBus Topic authorization Rule.
secondaryConnectionString String: The Secondary Connection String for the ServiceBus Topic authorization Rule.
secondaryConnectionStringAlias String: The alias Secondary Connection String for the ServiceBus Namespace
secondaryKey String: The Secondary Key for the ServiceBus Topic authorization Rule.
send Boolean: Grants send access to this this Authorization Rule. Defaults to false.
topicId String: Specifies the ID of the ServiceBus Topic. Changing this forces a new resource to be created.

Import

ServiceBus Topic authorization rules can be imported using the resource id, e.g.

 $ pulumi import azure:servicebus/topicAuthorizationRule:TopicAuthorizationRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ServiceBus/namespaces/namespace1/topics/topic1/authorizationRules/rule1

Package Details

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