1. Packages
  2. Azure Native
  3. API Docs
  4. servicebus
  5. QueueAuthorizationRule
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

azure-native.servicebus.QueueAuthorizationRule

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

    Description of a namespace authorization rule. Azure REST API version: 2022-01-01-preview. Prior API version in Azure Native 1.x: 2017-04-01.

    Other available API versions: 2014-09-01, 2015-08-01, 2022-10-01-preview, 2023-01-01-preview.

    Example Usage

    QueueAuthorizationRuleCreate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var queueAuthorizationRule = new AzureNative.ServiceBus.QueueAuthorizationRule("queueAuthorizationRule", new()
        {
            AuthorizationRuleName = "sdk-AuthRules-5800",
            NamespaceName = "sdk-Namespace-7982",
            QueueName = "sdk-Queues-2317",
            ResourceGroupName = "ArunMonocle",
            Rights = new[]
            {
                AzureNative.ServiceBus.AccessRights.Listen,
                AzureNative.ServiceBus.AccessRights.Send,
            },
        });
    
    });
    
    package main
    
    import (
    	servicebus "github.com/pulumi/pulumi-azure-native-sdk/servicebus/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := servicebus.NewQueueAuthorizationRule(ctx, "queueAuthorizationRule", &servicebus.QueueAuthorizationRuleArgs{
    			AuthorizationRuleName: pulumi.String("sdk-AuthRules-5800"),
    			NamespaceName:         pulumi.String("sdk-Namespace-7982"),
    			QueueName:             pulumi.String("sdk-Queues-2317"),
    			ResourceGroupName:     pulumi.String("ArunMonocle"),
    			Rights: pulumi.StringArray{
    				pulumi.String(servicebus.AccessRightsListen),
    				pulumi.String(servicebus.AccessRightsSend),
    			},
    		})
    		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.azurenative.servicebus.QueueAuthorizationRule;
    import com.pulumi.azurenative.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 queueAuthorizationRule = new QueueAuthorizationRule("queueAuthorizationRule", QueueAuthorizationRuleArgs.builder()
                .authorizationRuleName("sdk-AuthRules-5800")
                .namespaceName("sdk-Namespace-7982")
                .queueName("sdk-Queues-2317")
                .resourceGroupName("ArunMonocle")
                .rights(            
                    "Listen",
                    "Send")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    queue_authorization_rule = azure_native.servicebus.QueueAuthorizationRule("queueAuthorizationRule",
        authorization_rule_name="sdk-AuthRules-5800",
        namespace_name="sdk-Namespace-7982",
        queue_name="sdk-Queues-2317",
        resource_group_name="ArunMonocle",
        rights=[
            azure_native.servicebus.AccessRights.LISTEN,
            azure_native.servicebus.AccessRights.SEND,
        ])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const queueAuthorizationRule = new azure_native.servicebus.QueueAuthorizationRule("queueAuthorizationRule", {
        authorizationRuleName: "sdk-AuthRules-5800",
        namespaceName: "sdk-Namespace-7982",
        queueName: "sdk-Queues-2317",
        resourceGroupName: "ArunMonocle",
        rights: [
            azure_native.servicebus.AccessRights.Listen,
            azure_native.servicebus.AccessRights.Send,
        ],
    });
    
    resources:
      queueAuthorizationRule:
        type: azure-native:servicebus:QueueAuthorizationRule
        properties:
          authorizationRuleName: sdk-AuthRules-5800
          namespaceName: sdk-Namespace-7982
          queueName: sdk-Queues-2317
          resourceGroupName: ArunMonocle
          rights:
            - Listen
            - Send
    

    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,
                               namespace_name: Optional[str] = None,
                               queue_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               rights: Optional[Sequence[Union[str, AccessRights]]] = None,
                               authorization_rule_name: Optional[str] = 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-native: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 AzureNative.ServiceBus.QueueAuthorizationRule("queueAuthorizationRuleResource", new()
    {
        NamespaceName = "string",
        QueueName = "string",
        ResourceGroupName = "string",
        Rights = new[]
        {
            "string",
        },
        AuthorizationRuleName = "string",
    });
    
    example, err := servicebus.NewQueueAuthorizationRule(ctx, "queueAuthorizationRuleResource", &servicebus.QueueAuthorizationRuleArgs{
    	NamespaceName:     pulumi.String("string"),
    	QueueName:         pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	Rights: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AuthorizationRuleName: pulumi.String("string"),
    })
    
    var queueAuthorizationRuleResource = new QueueAuthorizationRule("queueAuthorizationRuleResource", QueueAuthorizationRuleArgs.builder()
        .namespaceName("string")
        .queueName("string")
        .resourceGroupName("string")
        .rights("string")
        .authorizationRuleName("string")
        .build());
    
    queue_authorization_rule_resource = azure_native.servicebus.QueueAuthorizationRule("queueAuthorizationRuleResource",
        namespace_name="string",
        queue_name="string",
        resource_group_name="string",
        rights=["string"],
        authorization_rule_name="string")
    
    const queueAuthorizationRuleResource = new azure_native.servicebus.QueueAuthorizationRule("queueAuthorizationRuleResource", {
        namespaceName: "string",
        queueName: "string",
        resourceGroupName: "string",
        rights: ["string"],
        authorizationRuleName: "string",
    });
    
    type: azure-native:servicebus:QueueAuthorizationRule
    properties:
        authorizationRuleName: string
        namespaceName: string
        queueName: string
        resourceGroupName: string
        rights:
            - string
    

    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:

    NamespaceName string
    The namespace name
    QueueName string
    The queue name.
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    Rights List<Union<string, Pulumi.AzureNative.ServiceBus.AccessRights>>
    The rights associated with the rule.
    AuthorizationRuleName string
    The authorization rule name.
    NamespaceName string
    The namespace name
    QueueName string
    The queue name.
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    Rights []string
    The rights associated with the rule.
    AuthorizationRuleName string
    The authorization rule name.
    namespaceName String
    The namespace name
    queueName String
    The queue name.
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    rights List<Either<String,AccessRights>>
    The rights associated with the rule.
    authorizationRuleName String
    The authorization rule name.
    namespaceName string
    The namespace name
    queueName string
    The queue name.
    resourceGroupName string
    Name of the Resource group within the Azure subscription.
    rights (string | AccessRights)[]
    The rights associated with the rule.
    authorizationRuleName string
    The authorization rule name.
    namespace_name str
    The namespace name
    queue_name str
    The queue name.
    resource_group_name str
    Name of the Resource group within the Azure subscription.
    rights Sequence[Union[str, AccessRights]]
    The rights associated with the rule.
    authorization_rule_name str
    The authorization rule name.
    namespaceName String
    The namespace name
    queueName String
    The queue name.
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    rights List<String | "Manage" | "Send" | "Listen">
    The rights associated with the rule.
    authorizationRuleName String
    The authorization rule name.

    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.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.ServiceBus.Outputs.SystemDataResponse
    The system meta data relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    SystemData SystemDataResponse
    The system meta data relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    id str
    The provider-assigned unique ID for this managed resource.
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    system_data SystemDataResponse
    The system meta data relating to this resource.
    type str
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    systemData Property Map
    The system meta data relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

    Supporting Types

    AccessRights, AccessRightsArgs

    Manage
    Manage
    Send
    Send
    Listen
    Listen
    AccessRightsManage
    Manage
    AccessRightsSend
    Send
    AccessRightsListen
    Listen
    Manage
    Manage
    Send
    Send
    Listen
    Listen
    Manage
    Manage
    Send
    Send
    Listen
    Listen
    MANAGE
    Manage
    SEND
    Send
    LISTEN
    Listen
    "Manage"
    Manage
    "Send"
    Send
    "Listen"
    Listen

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The type of identity that last modified the resource.
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The type of identity that last modified the resource.
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The type of identity that last modified the resource.
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The type of identity that last modified the resource.
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:servicebus:QueueAuthorizationRule sdk-AuthRules-5800 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi