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:
- Queue
Id 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
- bothlisten
andsend
must be too. Defaults tofalse
.- 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
.
- Queue
Id 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
- bothlisten
andsend
must be too. Defaults tofalse
.- 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
.
- queue
Id 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
- bothlisten
andsend
must be too. Defaults tofalse
.- 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 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
- bothlisten
andsend
must be too. Defaults tofalse
.- 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
- bothlisten
andsend
must be too. Defaults tofalse
.- 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
.
- queue
Id 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
- bothlisten
andsend
must be too. Defaults tofalse
.- 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.
- Primary
Connection stringString The Primary Connection String for the Authorization Rule.
- Primary
Connection stringString Alias The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
- Primary
Key string The Primary Key for the Authorization Rule.
- Secondary
Connection stringString The Secondary Connection String for the Authorization Rule.
- Secondary
Connection stringString Alias The alias Secondary Connection String for the ServiceBus Namespace
- Secondary
Key string The Secondary Key for the Authorization Rule.
- Id string
The provider-assigned unique ID for this managed resource.
- Primary
Connection stringString The Primary Connection String for the Authorization Rule.
- Primary
Connection stringString Alias The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
- Primary
Key string The Primary Key for the Authorization Rule.
- Secondary
Connection stringString The Secondary Connection String for the Authorization Rule.
- Secondary
Connection stringString Alias The alias Secondary Connection String for the ServiceBus Namespace
- Secondary
Key string The Secondary Key for the Authorization Rule.
- id String
The provider-assigned unique ID for this managed resource.
- primary
Connection StringString The Primary Connection String for the Authorization Rule.
- primary
Connection StringString Alias The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
- primary
Key String The Primary Key for the Authorization Rule.
- secondary
Connection StringString The Secondary Connection String for the Authorization Rule.
- secondary
Connection StringString Alias The alias Secondary Connection String for the ServiceBus Namespace
- secondary
Key String The Secondary Key for the Authorization Rule.
- id string
The provider-assigned unique ID for this managed resource.
- primary
Connection stringString The Primary Connection String for the Authorization Rule.
- primary
Connection stringString Alias The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
- primary
Key string The Primary Key for the Authorization Rule.
- secondary
Connection stringString The Secondary Connection String for the Authorization Rule.
- secondary
Connection stringString Alias The alias Secondary Connection String for the ServiceBus Namespace
- secondary
Key string The Secondary Key for the Authorization Rule.
- id str
The provider-assigned unique ID for this managed resource.
- primary_
connection_ strstring The Primary Connection String for the Authorization Rule.
- primary_
connection_ strstring_ alias 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_ strstring The Secondary Connection String for the Authorization Rule.
- secondary_
connection_ strstring_ alias 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.
- primary
Connection StringString The Primary Connection String for the Authorization Rule.
- primary
Connection StringString Alias The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
- primary
Key String The Primary Key for the Authorization Rule.
- secondary
Connection StringString The Secondary Connection String for the Authorization Rule.
- secondary
Connection StringString Alias The alias Secondary Connection String for the ServiceBus Namespace
- secondary
Key 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.
- 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
- bothlisten
andsend
must be too. Defaults tofalse
.- Name string
Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.
- Primary
Connection stringString The Primary Connection String for the Authorization Rule.
- Primary
Connection stringString Alias The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
- Primary
Key string The Primary Key for the Authorization Rule.
- Queue
Id string Specifies the ID of the ServiceBus Queue. Changing this forces a new resource to be created.
- Secondary
Connection stringString The Secondary Connection String for the Authorization Rule.
- Secondary
Connection stringString Alias The alias Secondary Connection String for the ServiceBus Namespace
- Secondary
Key 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
- bothlisten
andsend
must be too. Defaults tofalse
.- Name string
Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.
- Primary
Connection stringString The Primary Connection String for the Authorization Rule.
- Primary
Connection stringString Alias The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
- Primary
Key string The Primary Key for the Authorization Rule.
- Queue
Id string Specifies the ID of the ServiceBus Queue. Changing this forces a new resource to be created.
- Secondary
Connection stringString The Secondary Connection String for the Authorization Rule.
- Secondary
Connection stringString Alias The alias Secondary Connection String for the ServiceBus Namespace
- Secondary
Key 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
- bothlisten
andsend
must be too. Defaults tofalse
.- name String
Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.
- primary
Connection StringString The Primary Connection String for the Authorization Rule.
- primary
Connection StringString Alias The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
- primary
Key String The Primary Key for the Authorization Rule.
- queue
Id String Specifies the ID of the ServiceBus Queue. Changing this forces a new resource to be created.
- secondary
Connection StringString The Secondary Connection String for the Authorization Rule.
- secondary
Connection StringString Alias The alias Secondary Connection String for the ServiceBus Namespace
- secondary
Key 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
- bothlisten
andsend
must be too. Defaults tofalse
.- name string
Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.
- primary
Connection stringString The Primary Connection String for the Authorization Rule.
- primary
Connection stringString Alias The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
- primary
Key string The Primary Key for the Authorization Rule.
- queue
Id string Specifies the ID of the ServiceBus Queue. Changing this forces a new resource to be created.
- secondary
Connection stringString The Secondary Connection String for the Authorization Rule.
- secondary
Connection stringString Alias The alias Secondary Connection String for the ServiceBus Namespace
- secondary
Key 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
- bothlisten
andsend
must be too. Defaults tofalse
.- name str
Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.
- primary_
connection_ strstring The Primary Connection String for the Authorization Rule.
- primary_
connection_ strstring_ alias 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_ strstring The Secondary Connection String for the Authorization Rule.
- secondary_
connection_ strstring_ alias 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
- bothlisten
andsend
must be too. Defaults tofalse
.- name String
Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.
- primary
Connection StringString The Primary Connection String for the Authorization Rule.
- primary
Connection StringString Alias The alias Primary Connection String for the ServiceBus Namespace, if the namespace is Geo DR paired.
- primary
Key String The Primary Key for the Authorization Rule.
- queue
Id String Specifies the ID of the ServiceBus Queue. Changing this forces a new resource to be created.
- secondary
Connection StringString The Secondary Connection String for the Authorization Rule.
- secondary
Connection StringString Alias The alias Secondary Connection String for the ServiceBus Namespace
- secondary
Key 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.