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

}

Inheritance

System.Object

Resource

CustomResource

QueueAuthorizationRule

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 QueueAuthorizationRule : CustomResource

Constructors

QueueAuthorizationRule(String, QueueAuthorizationRuleArgs, CustomResourceOptions)

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

Declaration

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

Parameters

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

Properties

Listen

Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to false.

Declaration

public Output<bool?> Listen { get; }

Property Value

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

Manage

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.

Declaration

public Output<bool?> Manage { get; }

Property Value

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

Name

Specifies the name of the Authorization Rule. 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 in which the Queue exists. 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 Authorization Rule.

Declaration

public Output<string> PrimaryConnectionString { get; }

Property Value

Type	Description
Output<System.String>

PrimaryKey

The Primary Key for the Authorization Rule.

Declaration

public Output<string> PrimaryKey { get; }

Property Value

Type	Description
Output<System.String>

QueueName

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

Declaration

public Output<string> QueueName { 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 Authorization Rule.

Declaration

public Output<string> SecondaryConnectionString { get; }

Property Value

Type	Description
Output<System.String>

SecondaryKey

The Secondary Key for the Authorization Rule.

Declaration

public Output<string> SecondaryKey { get; }

Property Value

Type	Description
Output<System.String>

Send

Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to false.

Declaration

public Output<bool?> Send { get; }

Property Value

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

Methods

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

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

Declaration

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

Returns

Type	Description
QueueAuthorizationRule