QueueAuthorizationRule

Manages an Authorization Rule for a ServiceBus Queue.

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 exampleQueue = new Azure.ServiceBus.Queue("exampleQueue", new Azure.ServiceBus.QueueArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            NamespaceName = exampleNamespace.Name,
            EnablePartitioning = true,
        });
        var exampleQueueAuthorizationRule = new Azure.ServiceBus.QueueAuthorizationRule("exampleQueueAuthorizationRule", new Azure.ServiceBus.QueueAuthorizationRuleArgs
        {
            NamespaceName = exampleNamespace.Name,
            QueueName = exampleQueue.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            Listen = true,
            Send = true,
            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
        }
        exampleQueue, err := servicebus.NewQueue(ctx, "exampleQueue", &servicebus.QueueArgs{
            ResourceGroupName:  exampleResourceGroup.Name,
            NamespaceName:      exampleNamespace.Name,
            EnablePartitioning: pulumi.Bool(true),
        })
        if err != nil {
            return err
        }
        _, err = servicebus.NewQueueAuthorizationRule(ctx, "exampleQueueAuthorizationRule", &servicebus.QueueAuthorizationRuleArgs{
            NamespaceName:     exampleNamespace.Name,
            QueueName:         exampleQueue.Name,
            ResourceGroupName: exampleResourceGroup.Name,
            Listen:            pulumi.Bool(true),
            Send:              pulumi.Bool(true),
            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_queue = azure.servicebus.Queue("exampleQueue",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name,
    enable_partitioning=True)
example_queue_authorization_rule = azure.servicebus.QueueAuthorizationRule("exampleQueueAuthorizationRule",
    namespace_name=example_namespace.name,
    queue_name=example_queue.name,
    resource_group_name=example_resource_group.name,
    listen=True,
    send=True,
    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 exampleQueue = new azure.servicebus.Queue("exampleQueue", {
    resourceGroupName: exampleResourceGroup.name,
    namespaceName: exampleNamespace.name,
    enablePartitioning: true,
});
const exampleQueueAuthorizationRule = new azure.servicebus.QueueAuthorizationRule("exampleQueueAuthorizationRule", {
    namespaceName: exampleNamespace.name,
    queueName: exampleQueue.name,
    resourceGroupName: exampleResourceGroup.name,
    listen: true,
    send: true,
    manage: false,
});

Deprecated: azure.eventhub.QueueAuthorizationRule has been deprecated in favor of azure.servicebus.QueueAuthorizationRule

Create a QueueAuthorizationRule Resource

new QueueAuthorizationRule(name: string, args: QueueAuthorizationRuleArgs, opts?: CustomResourceOptions);

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

func NewQueueAuthorizationRule(ctx *Context, name string, args QueueAuthorizationRuleArgs, opts ...ResourceOption) (*QueueAuthorizationRule, error)

public QueueAuthorizationRule(string name, QueueAuthorizationRuleArgs args, CustomResourceOptions? opts = null)

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

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

QueueAuthorizationRule Resource Properties

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

Inputs

The QueueAuthorizationRule resource accepts the following input properties:

NamespaceName string: Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created.
QueueName string: Specifies the name of the ServiceBus Queue. 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.
Listen bool: Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to false.
Manage bool: Does this Authorization Rule have Manage permissions to the ServiceBus Queue? When this property is true - both listen and send must be too. Defaults to false.
Name string: Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.
Send bool: Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to false.

NamespaceName string: Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created.
QueueName string: Specifies the name of the ServiceBus Queue. 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.
Listen bool: Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to false.
Manage bool: Does this Authorization Rule have Manage permissions to the ServiceBus Queue? When this property is true - both listen and send must be too. Defaults to false.
Name string: Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.
Send bool: Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to false.

namespaceName string: Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created.
queueName string: Specifies the name of the ServiceBus Queue. 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.
listen boolean: Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to false.
manage boolean: Does this Authorization Rule have Manage permissions to the ServiceBus Queue? When this property is true - both listen and send must be too. Defaults to false.
name string: Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.
send boolean: Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to false.

namespace_name str: Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created.
queue_name str: Specifies the name of the ServiceBus Queue. 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.
listen bool: Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to false.
manage bool: Does this Authorization Rule have Manage permissions to the ServiceBus Queue? When this property is true - both listen and send must be too. Defaults to false.
name str: Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.
send bool: Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to false.

Outputs

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

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

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

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

Look up an Existing QueueAuthorizationRule Resource

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

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

func GetQueueAuthorizationRule(ctx *Context, name string, id IDInput, state *QueueAuthorizationRuleState, opts ...ResourceOption) (*QueueAuthorizationRule, error)

public static QueueAuthorizationRule Get(string name, Input<string> id, QueueAuthorizationRuleState? 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: Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to false.
Manage bool: Does this Authorization Rule have Manage permissions to the ServiceBus Queue? When this property is true - both listen and send must be too. Defaults to false.
Name string: Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.
NamespaceName string: Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created.
PrimaryConnectionString string: The Primary Connection String for the Authorization Rule.
PrimaryKey string: The Primary Key for the Authorization Rule.
QueueName string: Specifies the name of the ServiceBus Queue. 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.
SecondaryConnectionString string: The Secondary Connection String for the Authorization Rule.
SecondaryKey string: The Secondary Key for the Authorization Rule.
Send bool: Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to false.

Listen bool: Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to false.
Manage bool: Does this Authorization Rule have Manage permissions to the ServiceBus Queue? When this property is true - both listen and send must be too. Defaults to false.
Name string: Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.
NamespaceName string: Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created.
PrimaryConnectionString string: The Primary Connection String for the Authorization Rule.
PrimaryKey string: The Primary Key for the Authorization Rule.
QueueName string: Specifies the name of the ServiceBus Queue. 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.
SecondaryConnectionString string: The Secondary Connection String for the Authorization Rule.
SecondaryKey string: The Secondary Key for the Authorization Rule.
Send bool: Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to false.

listen boolean: Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to false.
manage boolean: Does this Authorization Rule have Manage permissions to the ServiceBus Queue? When this property is true - both listen and send must be too. Defaults to false.
name string: Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.
namespaceName string: Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created.
primaryConnectionString string: The Primary Connection String for the Authorization Rule.
primaryKey string: The Primary Key for the Authorization Rule.
queueName string: Specifies the name of the ServiceBus Queue. 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.
secondaryConnectionString string: The Secondary Connection String for the Authorization Rule.
secondaryKey string: The Secondary Key for the Authorization Rule.
send boolean: Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to false.

listen bool: Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to false.
manage bool: Does this Authorization Rule have Manage permissions to the ServiceBus Queue? When this property is true - both listen and send must be too. Defaults to false.
name str: Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.
namespace_name str: Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created.
primary_connection_string str: The Primary Connection String for the Authorization Rule.
primary_key str: The Primary Key for the Authorization Rule.
queue_name str: Specifies the name of the ServiceBus Queue. 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.
secondary_connection_string str: The Secondary Connection String for the Authorization Rule.
secondary_key str: The Secondary Key for the Authorization Rule.
send bool: Does this Authorization Rule have Send permissions to the ServiceBus Queue? 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