Azure Classic v5.38.0, Mar 21 23

azure.servicebus.QueueAuthorizationRule

Manages an Authorization Rule for a ServiceBus Queue.

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

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

    var exampleQueue = new Azure.ServiceBus.Queue("exampleQueue", new()
    {
        NamespaceId = exampleNamespace.Id,
        EnablePartitioning = true,
    });

    var exampleQueueAuthorizationRule = new Azure.ServiceBus.QueueAuthorizationRule("exampleQueueAuthorizationRule", new()
    {
        QueueId = exampleQueue.Id,
        Listen = true,
        Send = true,
        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 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.StringMap{
				"source": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		exampleQueue, err := servicebus.NewQueue(ctx, "exampleQueue", &servicebus.QueueArgs{
			NamespaceId:        exampleNamespace.ID(),
			EnablePartitioning: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = servicebus.NewQueueAuthorizationRule(ctx, "exampleQueueAuthorizationRule", &servicebus.QueueAuthorizationRuleArgs{
			QueueId: exampleQueue.ID(),
			Listen:  pulumi.Bool(true),
			Send:    pulumi.Bool(true),
			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.Queue;
import com.pulumi.azure.servicebus.QueueArgs;
import com.pulumi.azure.servicebus.QueueAuthorizationRule;
import com.pulumi.azure.servicebus.QueueAuthorizationRuleArgs;
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 US")
            .build());

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

        var exampleQueue = new Queue("exampleQueue", QueueArgs.builder()        
            .namespaceId(exampleNamespace.id())
            .enablePartitioning(true)
            .build());

        var exampleQueueAuthorizationRule = new QueueAuthorizationRule("exampleQueueAuthorizationRule", QueueAuthorizationRuleArgs.builder()        
            .queueId(exampleQueue.id())
            .listen(true)
            .send(true)
            .manage(false)
            .build());

    }
}

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",
    namespace_id=example_namespace.id,
    enable_partitioning=True)
example_queue_authorization_rule = azure.servicebus.QueueAuthorizationRule("exampleQueueAuthorizationRule",
    queue_id=example_queue.id,
    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", {
    namespaceId: exampleNamespace.id,
    enablePartitioning: true,
});
const exampleQueueAuthorizationRule = new azure.servicebus.QueueAuthorizationRule("exampleQueueAuthorizationRule", {
    queueId: exampleQueue.id,
    listen: true,
    send: true,
    manage: false,
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West US
  exampleNamespace:
    type: azure:servicebus:Namespace
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      sku: Standard
      tags:
        source: example
  exampleQueue:
    type: azure:servicebus:Queue
    properties:
      namespaceId: ${exampleNamespace.id}
      enablePartitioning: true
  exampleQueueAuthorizationRule:
    type: azure:servicebus:QueueAuthorizationRule
    properties:
      queueId: ${exampleQueue.id}
      listen: true
      send: true
      manage: false

Create QueueAuthorizationRule Resource

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

@overload
def QueueAuthorizationRule(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           listen: Optional[bool] = None,
                           manage: Optional[bool] = None,
                           name: Optional[str] = None,
                           queue_id: Optional[str] = None,
                           send: Optional[bool] = None)
@overload
def QueueAuthorizationRule(resource_name: str,
                           args: QueueAuthorizationRuleArgs,
                           opts: Optional[ResourceOptions] = None)

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

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

public QueueAuthorizationRule(String name, QueueAuthorizationRuleArgs args)
public QueueAuthorizationRule(String name, QueueAuthorizationRuleArgs args, CustomResourceOptions options)

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

resource_name str: The unique name of the resource.
args QueueAuthorizationRuleArgs: 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 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.

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

Inputs

The QueueAuthorizationRule resource accepts the following input properties:

QueueId string: Specifies the ID of the ServiceBus Queue. 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.

QueueId string: Specifies the ID of the ServiceBus Queue. 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.

queueId String: Specifies the ID of the ServiceBus Queue. 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.

queueId string: Specifies the ID of the ServiceBus Queue. 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.

queue_id str: Specifies the ID of the ServiceBus Queue. 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.

queueId String: Specifies the ID of the ServiceBus Queue. 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.

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.
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 Authorization Rule.
SecondaryConnectionString string: The Secondary Connection String for the Authorization Rule.
SecondaryConnectionStringAlias string: The alias Secondary Connection String for the ServiceBus Namespace
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.
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 Authorization Rule.
SecondaryConnectionString string: The Secondary Connection String for the Authorization Rule.
SecondaryConnectionStringAlias string: The alias Secondary Connection String for the ServiceBus Namespace
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.
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 Authorization Rule.
secondaryConnectionString String: The Secondary Connection String for the Authorization Rule.
secondaryConnectionStringAlias String: The alias Secondary Connection String for the ServiceBus Namespace
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.
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 Authorization Rule.
secondaryConnectionString string: The Secondary Connection String for the Authorization Rule.
secondaryConnectionStringAlias string: The alias Secondary Connection String for the ServiceBus Namespace
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_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 Authorization Rule.
secondary_connection_string str: The Secondary Connection String for the Authorization Rule.
secondary_connection_string_alias str: The alias Secondary Connection String for the ServiceBus Namespace
secondary_key str: 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.
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 Authorization Rule.
secondaryConnectionString String: The Secondary Connection String for the Authorization Rule.
secondaryConnectionStringAlias String: The alias Secondary Connection String for the ServiceBus Namespace
secondaryKey String: The Secondary Key for the Authorization Rule.

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

@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,
        queue_id: 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) -> QueueAuthorizationRule

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)

public static QueueAuthorizationRule get(String name, Output<String> id, QueueAuthorizationRuleState 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: 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.
PrimaryConnectionString string: The Primary Connection String for the 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 Authorization Rule.
QueueId string: Specifies the ID of the ServiceBus Queue. Changing this forces a new resource to be created.
SecondaryConnectionString string: The Secondary Connection String for the Authorization Rule.
SecondaryConnectionStringAlias string: The alias Secondary Connection String for the ServiceBus Namespace
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.
PrimaryConnectionString string: The Primary Connection String for the 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 Authorization Rule.
QueueId string: Specifies the ID of the ServiceBus Queue. Changing this forces a new resource to be created.
SecondaryConnectionString string: The Secondary Connection String for the Authorization Rule.
SecondaryConnectionStringAlias string: The alias Secondary Connection String for the ServiceBus Namespace
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.
primaryConnectionString String: The Primary Connection String for the 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 Authorization Rule.
queueId String: Specifies the ID of the ServiceBus Queue. Changing this forces a new resource to be created.
secondaryConnectionString String: The Secondary Connection String for the Authorization Rule.
secondaryConnectionStringAlias String: The alias Secondary Connection String for the ServiceBus Namespace
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 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.
primaryConnectionString string: The Primary Connection String for the 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 Authorization Rule.
queueId string: Specifies the ID of the ServiceBus Queue. Changing this forces a new resource to be created.
secondaryConnectionString string: The Secondary Connection String for the Authorization Rule.
secondaryConnectionStringAlias string: The alias Secondary Connection String for the ServiceBus Namespace
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.
primary_connection_string str: The Primary Connection String for the 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 Authorization Rule.
queue_id str: Specifies the ID of the ServiceBus Queue. Changing this forces a new resource to be created.
secondary_connection_string str: The Secondary Connection String for the Authorization Rule.
secondary_connection_string_alias str: The alias Secondary Connection String for the ServiceBus Namespace
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.

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.
primaryConnectionString String: The Primary Connection String for the 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 Authorization Rule.
queueId String: Specifies the ID of the ServiceBus Queue. Changing this forces a new resource to be created.
secondaryConnectionString String: The Secondary Connection String for the Authorization Rule.
secondaryConnectionStringAlias String: The alias Secondary Connection String for the ServiceBus Namespace
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.

Import

ServiceBus Queue Authorization Rules can be imported using the resource id, e.g.

 $ pulumi import azure:servicebus/queueAuthorizationRule:QueueAuthorizationRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ServiceBus/namespaces/namespace1/queues/queue1/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.