Docs
PackagesWe recommend using Azure Native.
azure.iot.EndpointServicebusQueue
Explore with Pulumi AI
Manages an IotHub ServiceBus Queue Endpoint
NOTE: Endpoints can be defined either directly on the
azure.iot.IoTHubresource, or using theazurerm_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 aazurerm_iothub_endpoint_*resource and another endpoint of a different type directly on theazure.iot.IoTHubresource is not supported.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleNamespace = new Azure.ServiceBus.Namespace("exampleNamespace", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
Sku = "Standard",
});
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 = false,
Send = true,
Manage = false,
});
var exampleIoTHub = new Azure.Iot.IoTHub("exampleIoTHub", new()
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
{
Name = "B1",
Capacity = 1,
},
Tags =
{
{ "purpose", "example" },
},
});
var exampleEndpointServicebusQueue = new Azure.Iot.EndpointServicebusQueue("exampleEndpointServicebusQueue", new()
{
ResourceGroupName = exampleResourceGroup.Name,
IothubId = exampleIoTHub.Id,
ConnectionString = exampleQueueAuthorizationRule.PrimaryConnectionString,
});
});
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 {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleNamespace, err := servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
Sku: pulumi.String("Standard"),
})
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
}
exampleQueueAuthorizationRule, err := servicebus.NewQueueAuthorizationRule(ctx, "exampleQueueAuthorizationRule", &servicebus.QueueAuthorizationRuleArgs{
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, "exampleIoTHub", &iot.IoTHubArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.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, "exampleEndpointServicebusQueue", &iot.EndpointServicebusQueueArgs{
ResourceGroupName: exampleResourceGroup.Name,
IothubId: exampleIoTHub.ID(),
ConnectionString: exampleQueueAuthorizationRule.PrimaryConnectionString,
})
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 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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.sku("Standard")
.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(false)
.send(true)
.manage(false)
.build());
var exampleIoTHub = new IoTHub("exampleIoTHub", IoTHubArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.location(exampleResourceGroup.location())
.sku(IoTHubSkuArgs.builder()
.name("B1")
.capacity("1")
.build())
.tags(Map.of("purpose", "example"))
.build());
var exampleEndpointServicebusQueue = new EndpointServicebusQueue("exampleEndpointServicebusQueue", EndpointServicebusQueueArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.iothubId(exampleIoTHub.id())
.connectionString(exampleQueueAuthorizationRule.primaryConnectionString())
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
sku="Standard")
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=False,
send=True,
manage=False)
example_io_t_hub = azure.iot.IoTHub("exampleIoTHub",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
sku=azure.iot.IoTHubSkuArgs(
name="B1",
capacity=1,
),
tags={
"purpose": "example",
})
example_endpoint_servicebus_queue = azure.iot.EndpointServicebusQueue("exampleEndpointServicebusQueue",
resource_group_name=example_resource_group.name,
iothub_id=example_io_t_hub.id,
connection_string=example_queue_authorization_rule.primary_connection_string)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
sku: "Standard",
});
const exampleQueue = new azure.servicebus.Queue("exampleQueue", {
namespaceId: exampleNamespace.id,
enablePartitioning: true,
});
const exampleQueueAuthorizationRule = new azure.servicebus.QueueAuthorizationRule("exampleQueueAuthorizationRule", {
queueId: exampleQueue.id,
listen: false,
send: true,
manage: false,
});
const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
sku: {
name: "B1",
capacity: 1,
},
tags: {
purpose: "example",
},
});
const exampleEndpointServicebusQueue = new azure.iot.EndpointServicebusQueue("exampleEndpointServicebusQueue", {
resourceGroupName: exampleResourceGroup.name,
iothubId: exampleIoTHub.id,
connectionString: exampleQueueAuthorizationRule.primaryConnectionString,
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleNamespace:
type: azure:servicebus:Namespace
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
sku: Standard
exampleQueue:
type: azure:servicebus:Queue
properties:
namespaceId: ${exampleNamespace.id}
enablePartitioning: true
exampleQueueAuthorizationRule:
type: azure:servicebus:QueueAuthorizationRule
properties:
queueId: ${exampleQueue.id}
listen: false
send: true
manage: false
exampleIoTHub:
type: azure:iot:IoTHub
properties:
resourceGroupName: ${exampleResourceGroup.name}
location: ${exampleResourceGroup.location}
sku:
name: B1
capacity: '1'
tags:
purpose: example
exampleEndpointServicebusQueue:
type: azure:iot:EndpointServicebusQueue
properties:
resourceGroupName: ${exampleResourceGroup.name}
iothubId: ${exampleIoTHub.id}
connectionString: ${exampleQueueAuthorizationRule.primaryConnectionString}
Create EndpointServicebusQueue Resource
new EndpointServicebusQueue(name: string, args: EndpointServicebusQueueArgs, opts?: CustomResourceOptions);@overload
def EndpointServicebusQueue(resource_name: 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)
@overload
def EndpointServicebusQueue(resource_name: str,
args: EndpointServicebusQueueArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Iothub
Id string The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
- Resource
Group stringName 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 string Type used to authenticate against the Service Bus Queue endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased.- Connection
String string The connection string for the endpoint. This attribute can only be specified and is mandatory when
authentication_typeiskeyBased.- Endpoint
Uri string URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- Entity
Path string Name of the Service Bus Queue. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- Identity
Id string ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.
NOTE:
identity_idcan only be specified whenauthentication_typeisidentityBased. It must be one of theidentity_idsof the Iot Hub. If not specified whenauthentication_typeisidentityBased, 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,fileNotificationsand$default. Changing this forces a new resource to be created.
- Iothub
Id string The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
- Resource
Group stringName 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 string Type used to authenticate against the Service Bus Queue endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased.- Connection
String string The connection string for the endpoint. This attribute can only be specified and is mandatory when
authentication_typeiskeyBased.- Endpoint
Uri string URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- Entity
Path string Name of the Service Bus Queue. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- Identity
Id string ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.
NOTE:
identity_idcan only be specified whenauthentication_typeisidentityBased. It must be one of theidentity_idsof the Iot Hub. If not specified whenauthentication_typeisidentityBased, 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,fileNotificationsand$default. Changing this forces a new resource to be created.
- iothub
Id String The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
- resource
Group StringName 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 String Type used to authenticate against the Service Bus Queue endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased.- connection
String String The connection string for the endpoint. This attribute can only be specified and is mandatory when
authentication_typeiskeyBased.- endpoint
Uri String URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- entity
Path String Name of the Service Bus Queue. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- identity
Id String ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.
NOTE:
identity_idcan only be specified whenauthentication_typeisidentityBased. It must be one of theidentity_idsof the Iot Hub. If not specified whenauthentication_typeisidentityBased, 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,fileNotificationsand$default. Changing this forces a new resource to be created.
- iothub
Id string The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
- resource
Group stringName 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 string Type used to authenticate against the Service Bus Queue endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased.- connection
String string The connection string for the endpoint. This attribute can only be specified and is mandatory when
authentication_typeiskeyBased.- endpoint
Uri string URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- entity
Path string Name of the Service Bus Queue. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- identity
Id string ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.
NOTE:
identity_idcan only be specified whenauthentication_typeisidentityBased. It must be one of theidentity_idsof the Iot Hub. If not specified whenauthentication_typeisidentityBased, 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,fileNotificationsand$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_ strname 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
keyBasedandidentityBased. Defaults tokeyBased.- connection_
string str The connection string for the endpoint. This attribute can only be specified and is mandatory when
authentication_typeiskeyBased.- endpoint_
uri str URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- entity_
path str Name of the Service Bus Queue. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- identity_
id str ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.
NOTE:
identity_idcan only be specified whenauthentication_typeisidentityBased. It must be one of theidentity_idsof the Iot Hub. If not specified whenauthentication_typeisidentityBased, 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,fileNotificationsand$default. Changing this forces a new resource to be created.
- iothub
Id String The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
- resource
Group StringName 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 String Type used to authenticate against the Service Bus Queue endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased.- connection
String String The connection string for the endpoint. This attribute can only be specified and is mandatory when
authentication_typeiskeyBased.- endpoint
Uri String URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- entity
Path String Name of the Service Bus Queue. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- identity
Id String ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.
NOTE:
identity_idcan only be specified whenauthentication_typeisidentityBased. It must be one of theidentity_idsof the Iot Hub. If not specified whenauthentication_typeisidentityBased, 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,fileNotificationsand$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) -> EndpointServicebusQueuefunc 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.
- Authentication
Type string Type used to authenticate against the Service Bus Queue endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased.- Connection
String string The connection string for the endpoint. This attribute can only be specified and is mandatory when
authentication_typeiskeyBased.- Endpoint
Uri string URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- Entity
Path string Name of the Service Bus Queue. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- Identity
Id string ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.
NOTE:
identity_idcan only be specified whenauthentication_typeisidentityBased. It must be one of theidentity_idsof the Iot Hub. If not specified whenauthentication_typeisidentityBased, System Assigned Managed Identity of the Iot Hub will be used.- Iothub
Id 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,fileNotificationsand$default. Changing this forces a new resource to be created.- Resource
Group stringName 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 string Type used to authenticate against the Service Bus Queue endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased.- Connection
String string The connection string for the endpoint. This attribute can only be specified and is mandatory when
authentication_typeiskeyBased.- Endpoint
Uri string URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- Entity
Path string Name of the Service Bus Queue. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- Identity
Id string ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.
NOTE:
identity_idcan only be specified whenauthentication_typeisidentityBased. It must be one of theidentity_idsof the Iot Hub. If not specified whenauthentication_typeisidentityBased, System Assigned Managed Identity of the Iot Hub will be used.- Iothub
Id 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,fileNotificationsand$default. Changing this forces a new resource to be created.- Resource
Group stringName 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 String Type used to authenticate against the Service Bus Queue endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased.- connection
String String The connection string for the endpoint. This attribute can only be specified and is mandatory when
authentication_typeiskeyBased.- endpoint
Uri String URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- entity
Path String Name of the Service Bus Queue. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- identity
Id String ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.
NOTE:
identity_idcan only be specified whenauthentication_typeisidentityBased. It must be one of theidentity_idsof the Iot Hub. If not specified whenauthentication_typeisidentityBased, System Assigned Managed Identity of the Iot Hub will be used.- iothub
Id 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,fileNotificationsand$default. Changing this forces a new resource to be created.- resource
Group StringName 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 string Type used to authenticate against the Service Bus Queue endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased.- connection
String string The connection string for the endpoint. This attribute can only be specified and is mandatory when
authentication_typeiskeyBased.- endpoint
Uri string URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- entity
Path string Name of the Service Bus Queue. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- identity
Id string ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.
NOTE:
identity_idcan only be specified whenauthentication_typeisidentityBased. It must be one of theidentity_idsof the Iot Hub. If not specified whenauthentication_typeisidentityBased, System Assigned Managed Identity of the Iot Hub will be used.- iothub
Id 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,fileNotificationsand$default. Changing this forces a new resource to be created.- resource
Group stringName 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
keyBasedandidentityBased. Defaults tokeyBased.- connection_
string str The connection string for the endpoint. This attribute can only be specified and is mandatory when
authentication_typeiskeyBased.- endpoint_
uri str URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- entity_
path str Name of the Service Bus Queue. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- identity_
id str ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.
NOTE:
identity_idcan only be specified whenauthentication_typeisidentityBased. It must be one of theidentity_idsof the Iot Hub. If not specified whenauthentication_typeisidentityBased, 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,fileNotificationsand$default. Changing this forces a new resource to be created.- resource_
group_ strname 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 String Type used to authenticate against the Service Bus Queue endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased.- connection
String String The connection string for the endpoint. This attribute can only be specified and is mandatory when
authentication_typeiskeyBased.- endpoint
Uri String URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- entity
Path String Name of the Service Bus Queue. This attribute can only be specified and is mandatory when
authentication_typeisidentityBased.- identity
Id String ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.
NOTE:
identity_idcan only be specified whenauthentication_typeisidentityBased. It must be one of theidentity_idsof the Iot Hub. If not specified whenauthentication_typeisidentityBased, System Assigned Managed Identity of the Iot Hub will be used.- iothub
Id 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,fileNotificationsand$default. Changing this forces a new resource to be created.- resource
Group StringName 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
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurermTerraform Provider.