Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. servicebus
  5. QueueAuthorizationRule

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

azure.servicebus.QueueAuthorizationRule

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an Authorization Rule for a ServiceBus Queue.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

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

    Create QueueAuthorizationRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new QueueAuthorizationRule(name: string, args: QueueAuthorizationRuleArgs, opts?: CustomResourceOptions);
    @overload
def QueueAuthorizationRule(resource_name: str,
                           args: QueueAuthorizationRuleArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def QueueAuthorizationRule(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           queue_id: Optional[str] = None,
                           listen: Optional[bool] = None,
                           manage: Optional[bool] = None,
                           name: Optional[str] = None,
                           send: Optional[bool] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var queueAuthorizationRuleResource = new Azure.ServiceBus.QueueAuthorizationRule("queueAuthorizationRuleResource", new()
{
    QueueId = "string",
    Listen = false,
    Manage = false,
    Name = "string",
    Send = false,
});

    example, err := servicebus.NewQueueAuthorizationRule(ctx, "queueAuthorizationRuleResource", &servicebus.QueueAuthorizationRuleArgs{
	QueueId: pulumi.String("string"),
	Listen:  pulumi.Bool(false),
	Manage:  pulumi.Bool(false),
	Name:    pulumi.String("string"),
	Send:    pulumi.Bool(false),
})

    var queueAuthorizationRuleResource = new QueueAuthorizationRule("queueAuthorizationRuleResource", QueueAuthorizationRuleArgs.builder()
    .queueId("string")
    .listen(false)
    .manage(false)
    .name("string")
    .send(false)
    .build());

    queue_authorization_rule_resource = azure.servicebus.QueueAuthorizationRule("queueAuthorizationRuleResource",
    queue_id="string",
    listen=False,
    manage=False,
    name="string",
    send=False)

    const queueAuthorizationRuleResource = new azure.servicebus.QueueAuthorizationRule("queueAuthorizationRuleResource", {
    queueId: "string",
    listen: false,
    manage: false,
    name: "string",
    send: false,
});

    type: azure:servicebus:QueueAuthorizationRule
properties:
    listen: false
    manage: false
    name: string
    queueId: string
    send: false

    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.

    NOTE At least one of the 3 permissions below needs to be set.

    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.

    NOTE At least one of the 3 permissions below needs to be set.

    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.

    NOTE At least one of the 3 permissions below needs to be set.

    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.

    NOTE At least one of the 3 permissions below needs to be set.

    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.

    NOTE At least one of the 3 permissions below needs to be set.

    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.

    NOTE At least one of the 3 permissions below needs to be set.

    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.

    NOTE At least one of the 3 permissions below needs to be set.

    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.

    NOTE At least one of the 3 permissions below needs to be set.

    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.

    NOTE At least one of the 3 permissions below needs to be set.

    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.

    NOTE At least one of the 3 permissions below needs to be set.

    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.

    NOTE At least one of the 3 permissions below needs to be set.

    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.

    NOTE At least one of the 3 permissions below needs to be set.

    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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

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

    We recommend using Azure Native.

    Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-azure