1. Packages
  2. Azure Classic
  3. API Docs
  4. iot
  5. EndpointServicebusQueue

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi

azure.iot.EndpointServicebusQueue

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi

    Manages an IotHub ServiceBus Queue Endpoint

    NOTE: Endpoints can be defined either directly on the azure.iot.IoTHub resource, or using the azurerm_iothub_endpoint_* resources - but the two ways of defining the endpoints cannot be used together. If both are used against the same IoTHub, spurious changes will occur. Also, defining a azurerm_iothub_endpoint_* resource and another endpoint of a different type directly on the azure.iot.IoTHub resource is not supported.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleNamespace = new azure.servicebus.Namespace("example", {
        name: "exampleNamespace",
        location: example.location,
        resourceGroupName: example.name,
        sku: "Standard",
    });
    const exampleQueue = new azure.servicebus.Queue("example", {
        name: "exampleQueue",
        namespaceId: exampleNamespace.id,
        enablePartitioning: true,
    });
    const exampleQueueAuthorizationRule = new azure.servicebus.QueueAuthorizationRule("example", {
        name: "exampleRule",
        queueId: exampleQueue.id,
        listen: false,
        send: true,
        manage: false,
    });
    const exampleIoTHub = new azure.iot.IoTHub("example", {
        name: "exampleIothub",
        resourceGroupName: example.name,
        location: example.location,
        sku: {
            name: "B1",
            capacity: 1,
        },
        tags: {
            purpose: "example",
        },
    });
    const exampleEndpointServicebusQueue = new azure.iot.EndpointServicebusQueue("example", {
        resourceGroupName: example.name,
        iothubId: exampleIoTHub.id,
        name: "example",
        connectionString: exampleQueueAuthorizationRule.primaryConnectionString,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_namespace = azure.servicebus.Namespace("example",
        name="exampleNamespace",
        location=example.location,
        resource_group_name=example.name,
        sku="Standard")
    example_queue = azure.servicebus.Queue("example",
        name="exampleQueue",
        namespace_id=example_namespace.id,
        enable_partitioning=True)
    example_queue_authorization_rule = azure.servicebus.QueueAuthorizationRule("example",
        name="exampleRule",
        queue_id=example_queue.id,
        listen=False,
        send=True,
        manage=False)
    example_io_t_hub = azure.iot.IoTHub("example",
        name="exampleIothub",
        resource_group_name=example.name,
        location=example.location,
        sku=azure.iot.IoTHubSkuArgs(
            name="B1",
            capacity=1,
        ),
        tags={
            "purpose": "example",
        })
    example_endpoint_servicebus_queue = azure.iot.EndpointServicebusQueue("example",
        resource_group_name=example.name,
        iothub_id=example_io_t_hub.id,
        name="example",
        connection_string=example_queue_authorization_rule.primary_connection_string)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/iot"
    	"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 {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleNamespace, err := servicebus.NewNamespace(ctx, "example", &servicebus.NamespaceArgs{
    			Name:              pulumi.String("exampleNamespace"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			Sku:               pulumi.String("Standard"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleQueue, err := servicebus.NewQueue(ctx, "example", &servicebus.QueueArgs{
    			Name:               pulumi.String("exampleQueue"),
    			NamespaceId:        exampleNamespace.ID(),
    			EnablePartitioning: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		exampleQueueAuthorizationRule, err := servicebus.NewQueueAuthorizationRule(ctx, "example", &servicebus.QueueAuthorizationRuleArgs{
    			Name:    pulumi.String("exampleRule"),
    			QueueId: exampleQueue.ID(),
    			Listen:  pulumi.Bool(false),
    			Send:    pulumi.Bool(true),
    			Manage:  pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		exampleIoTHub, err := iot.NewIoTHub(ctx, "example", &iot.IoTHubArgs{
    			Name:              pulumi.String("exampleIothub"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			Sku: &iot.IoTHubSkuArgs{
    				Name:     pulumi.String("B1"),
    				Capacity: pulumi.Int(1),
    			},
    			Tags: pulumi.StringMap{
    				"purpose": pulumi.String("example"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = iot.NewEndpointServicebusQueue(ctx, "example", &iot.EndpointServicebusQueueArgs{
    			ResourceGroupName: example.Name,
    			IothubId:          exampleIoTHub.ID(),
    			Name:              pulumi.String("example"),
    			ConnectionString:  exampleQueueAuthorizationRule.PrimaryConnectionString,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleNamespace = new Azure.ServiceBus.Namespace("example", new()
        {
            Name = "exampleNamespace",
            Location = example.Location,
            ResourceGroupName = example.Name,
            Sku = "Standard",
        });
    
        var exampleQueue = new Azure.ServiceBus.Queue("example", new()
        {
            Name = "exampleQueue",
            NamespaceId = exampleNamespace.Id,
            EnablePartitioning = true,
        });
    
        var exampleQueueAuthorizationRule = new Azure.ServiceBus.QueueAuthorizationRule("example", new()
        {
            Name = "exampleRule",
            QueueId = exampleQueue.Id,
            Listen = false,
            Send = true,
            Manage = false,
        });
    
        var exampleIoTHub = new Azure.Iot.IoTHub("example", new()
        {
            Name = "exampleIothub",
            ResourceGroupName = example.Name,
            Location = example.Location,
            Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
            {
                Name = "B1",
                Capacity = 1,
            },
            Tags = 
            {
                { "purpose", "example" },
            },
        });
    
        var exampleEndpointServicebusQueue = new Azure.Iot.EndpointServicebusQueue("example", new()
        {
            ResourceGroupName = example.Name,
            IothubId = exampleIoTHub.Id,
            Name = "example",
            ConnectionString = exampleQueueAuthorizationRule.PrimaryConnectionString,
        });
    
    });
    
    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 com.pulumi.azure.iot.IoTHub;
    import com.pulumi.azure.iot.IoTHubArgs;
    import com.pulumi.azure.iot.inputs.IoTHubSkuArgs;
    import com.pulumi.azure.iot.EndpointServicebusQueue;
    import com.pulumi.azure.iot.EndpointServicebusQueueArgs;
    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 example = new ResourceGroup("example", ResourceGroupArgs.builder()        
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()        
                .name("exampleNamespace")
                .location(example.location())
                .resourceGroupName(example.name())
                .sku("Standard")
                .build());
    
            var exampleQueue = new Queue("exampleQueue", QueueArgs.builder()        
                .name("exampleQueue")
                .namespaceId(exampleNamespace.id())
                .enablePartitioning(true)
                .build());
    
            var exampleQueueAuthorizationRule = new QueueAuthorizationRule("exampleQueueAuthorizationRule", QueueAuthorizationRuleArgs.builder()        
                .name("exampleRule")
                .queueId(exampleQueue.id())
                .listen(false)
                .send(true)
                .manage(false)
                .build());
    
            var exampleIoTHub = new IoTHub("exampleIoTHub", IoTHubArgs.builder()        
                .name("exampleIothub")
                .resourceGroupName(example.name())
                .location(example.location())
                .sku(IoTHubSkuArgs.builder()
                    .name("B1")
                    .capacity("1")
                    .build())
                .tags(Map.of("purpose", "example"))
                .build());
    
            var exampleEndpointServicebusQueue = new EndpointServicebusQueue("exampleEndpointServicebusQueue", EndpointServicebusQueueArgs.builder()        
                .resourceGroupName(example.name())
                .iothubId(exampleIoTHub.id())
                .name("example")
                .connectionString(exampleQueueAuthorizationRule.primaryConnectionString())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleNamespace:
        type: azure:servicebus:Namespace
        name: example
        properties:
          name: exampleNamespace
          location: ${example.location}
          resourceGroupName: ${example.name}
          sku: Standard
      exampleQueue:
        type: azure:servicebus:Queue
        name: example
        properties:
          name: exampleQueue
          namespaceId: ${exampleNamespace.id}
          enablePartitioning: true
      exampleQueueAuthorizationRule:
        type: azure:servicebus:QueueAuthorizationRule
        name: example
        properties:
          name: exampleRule
          queueId: ${exampleQueue.id}
          listen: false
          send: true
          manage: false
      exampleIoTHub:
        type: azure:iot:IoTHub
        name: example
        properties:
          name: exampleIothub
          resourceGroupName: ${example.name}
          location: ${example.location}
          sku:
            name: B1
            capacity: '1'
          tags:
            purpose: example
      exampleEndpointServicebusQueue:
        type: azure:iot:EndpointServicebusQueue
        name: example
        properties:
          resourceGroupName: ${example.name}
          iothubId: ${exampleIoTHub.id}
          name: example
          connectionString: ${exampleQueueAuthorizationRule.primaryConnectionString}
    

    Create EndpointServicebusQueue Resource

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

    Constructor syntax

    new EndpointServicebusQueue(name: string, args: EndpointServicebusQueueArgs, opts?: CustomResourceOptions);
    @overload
    def EndpointServicebusQueue(resource_name: str,
                                args: EndpointServicebusQueueArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def EndpointServicebusQueue(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                iothub_id: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                authentication_type: Optional[str] = None,
                                connection_string: Optional[str] = None,
                                endpoint_uri: Optional[str] = None,
                                entity_path: Optional[str] = None,
                                identity_id: Optional[str] = None,
                                name: Optional[str] = None)
    func NewEndpointServicebusQueue(ctx *Context, name string, args EndpointServicebusQueueArgs, opts ...ResourceOption) (*EndpointServicebusQueue, error)
    public EndpointServicebusQueue(string name, EndpointServicebusQueueArgs args, CustomResourceOptions? opts = null)
    public EndpointServicebusQueue(String name, EndpointServicebusQueueArgs args)
    public EndpointServicebusQueue(String name, EndpointServicebusQueueArgs args, CustomResourceOptions options)
    
    type: azure:iot:EndpointServicebusQueue
    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 EndpointServicebusQueueArgs
    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 EndpointServicebusQueueArgs
    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 EndpointServicebusQueueArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EndpointServicebusQueueArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EndpointServicebusQueueArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var endpointServicebusQueueResource = new Azure.Iot.EndpointServicebusQueue("endpointServicebusQueueResource", new()
    {
        IothubId = "string",
        ResourceGroupName = "string",
        AuthenticationType = "string",
        ConnectionString = "string",
        EndpointUri = "string",
        EntityPath = "string",
        IdentityId = "string",
        Name = "string",
    });
    
    example, err := iot.NewEndpointServicebusQueue(ctx, "endpointServicebusQueueResource", &iot.EndpointServicebusQueueArgs{
    	IothubId:           pulumi.String("string"),
    	ResourceGroupName:  pulumi.String("string"),
    	AuthenticationType: pulumi.String("string"),
    	ConnectionString:   pulumi.String("string"),
    	EndpointUri:        pulumi.String("string"),
    	EntityPath:         pulumi.String("string"),
    	IdentityId:         pulumi.String("string"),
    	Name:               pulumi.String("string"),
    })
    
    var endpointServicebusQueueResource = new EndpointServicebusQueue("endpointServicebusQueueResource", EndpointServicebusQueueArgs.builder()        
        .iothubId("string")
        .resourceGroupName("string")
        .authenticationType("string")
        .connectionString("string")
        .endpointUri("string")
        .entityPath("string")
        .identityId("string")
        .name("string")
        .build());
    
    endpoint_servicebus_queue_resource = azure.iot.EndpointServicebusQueue("endpointServicebusQueueResource",
        iothub_id="string",
        resource_group_name="string",
        authentication_type="string",
        connection_string="string",
        endpoint_uri="string",
        entity_path="string",
        identity_id="string",
        name="string")
    
    const endpointServicebusQueueResource = new azure.iot.EndpointServicebusQueue("endpointServicebusQueueResource", {
        iothubId: "string",
        resourceGroupName: "string",
        authenticationType: "string",
        connectionString: "string",
        endpointUri: "string",
        entityPath: "string",
        identityId: "string",
        name: "string",
    });
    
    type: azure:iot:EndpointServicebusQueue
    properties:
        authenticationType: string
        connectionString: string
        endpointUri: string
        entityPath: string
        identityId: string
        iothubId: string
        name: string
        resourceGroupName: string
    

    EndpointServicebusQueue 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 EndpointServicebusQueue resource accepts the following input properties:

    IothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the Service Bus Queue has been created. Changing this forces a new resource to be created.
    AuthenticationType string
    Type used to authenticate against the Service Bus Queue endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    ConnectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    EndpointUri string
    URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    EntityPath string
    Name of the Service Bus Queue. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    IdentityId string

    ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    Name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    IothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the Service Bus Queue has been created. Changing this forces a new resource to be created.
    AuthenticationType string
    Type used to authenticate against the Service Bus Queue endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    ConnectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    EndpointUri string
    URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    EntityPath string
    Name of the Service Bus Queue. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    IdentityId string

    ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    Name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    iothubId String
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the Service Bus Queue has been created. Changing this forces a new resource to be created.
    authenticationType String
    Type used to authenticate against the Service Bus Queue endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString String
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpointUri String
    URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entityPath String
    Name of the Service Bus Queue. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identityId String

    ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    name String
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    iothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group under which the Service Bus Queue has been created. Changing this forces a new resource to be created.
    authenticationType string
    Type used to authenticate against the Service Bus Queue endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpointUri string
    URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entityPath string
    Name of the Service Bus Queue. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identityId string

    ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    iothub_id str
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group under which the Service Bus Queue has been created. Changing this forces a new resource to be created.
    authentication_type str
    Type used to authenticate against the Service Bus Queue endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connection_string str
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpoint_uri str
    URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entity_path str
    Name of the Service Bus Queue. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identity_id str

    ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    name str
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    iothubId String
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the Service Bus Queue has been created. Changing this forces a new resource to be created.
    authenticationType String
    Type used to authenticate against the Service Bus Queue endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString String
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpointUri String
    URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entityPath String
    Name of the Service Bus Queue. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identityId String

    ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    name String
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EndpointServicebusQueue resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EndpointServicebusQueue Resource

    Get an existing EndpointServicebusQueue 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?: EndpointServicebusQueueState, opts?: CustomResourceOptions): EndpointServicebusQueue
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authentication_type: Optional[str] = None,
            connection_string: Optional[str] = None,
            endpoint_uri: Optional[str] = None,
            entity_path: Optional[str] = None,
            identity_id: Optional[str] = None,
            iothub_id: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None) -> EndpointServicebusQueue
    func GetEndpointServicebusQueue(ctx *Context, name string, id IDInput, state *EndpointServicebusQueueState, opts ...ResourceOption) (*EndpointServicebusQueue, error)
    public static EndpointServicebusQueue Get(string name, Input<string> id, EndpointServicebusQueueState? state, CustomResourceOptions? opts = null)
    public static EndpointServicebusQueue get(String name, Output<String> id, EndpointServicebusQueueState 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:
    AuthenticationType string
    Type used to authenticate against the Service Bus Queue endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    ConnectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    EndpointUri string
    URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    EntityPath string
    Name of the Service Bus Queue. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    IdentityId string

    ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    IothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    Name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the Service Bus Queue has been created. Changing this forces a new resource to be created.
    AuthenticationType string
    Type used to authenticate against the Service Bus Queue endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    ConnectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    EndpointUri string
    URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    EntityPath string
    Name of the Service Bus Queue. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    IdentityId string

    ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    IothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    Name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the Service Bus Queue has been created. Changing this forces a new resource to be created.
    authenticationType String
    Type used to authenticate against the Service Bus Queue endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString String
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpointUri String
    URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entityPath String
    Name of the Service Bus Queue. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identityId String

    ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    iothubId String
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    name String
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the Service Bus Queue has been created. Changing this forces a new resource to be created.
    authenticationType string
    Type used to authenticate against the Service Bus Queue endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpointUri string
    URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entityPath string
    Name of the Service Bus Queue. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identityId string

    ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    iothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group under which the Service Bus Queue has been created. Changing this forces a new resource to be created.
    authentication_type str
    Type used to authenticate against the Service Bus Queue endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connection_string str
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpoint_uri str
    URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entity_path str
    Name of the Service Bus Queue. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identity_id str

    ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    iothub_id str
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    name str
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group under which the Service Bus Queue has been created. Changing this forces a new resource to be created.
    authenticationType String
    Type used to authenticate against the Service Bus Queue endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString String
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpointUri String
    URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entityPath String
    Name of the Service Bus Queue. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identityId String

    ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    iothubId String
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    name String
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the Service Bus Queue has been created. Changing this forces a new resource to be created.

    Import

    IoTHub ServiceBus Queue Endpoint can be imported using the resource id, e.g.

    g

    $ pulumi import azure:iot/endpointServicebusQueue:EndpointServicebusQueue servicebus_queue1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Devices/iotHubs/hub1/endpoints/servicebusqueue_endpoint1
    

    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 v5.72.0 published on Monday, Apr 15, 2024 by Pulumi