pulumi-azure-kotlin/com.pulumi.azure.iot.kotlin/EndpointServicebusQueueArgs

EndpointServicebusQueueArgs

data class EndpointServicebusQueueArgs(val authenticationType: Output<String>? = null, val connectionString: Output<String>? = null, val endpointUri: Output<String>? = null, val entityPath: Output<String>? = null, val identityId: Output<String>? = null, val iothubId: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null) : ConvertibleToJava<EndpointServicebusQueueArgs>

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

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

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

Constructors

EndpointServicebusQueueArgs

fun EndpointServicebusQueueArgs(authenticationType: Output<String>? = null, connectionString: Output<String>? = null, endpointUri: Output<String>? = null, entityPath: Output<String>? = null, identityId: Output<String>? = null, iothubId: Output<String>? = null, name: Output<String>? = null, resourceGroupName: Output<String>? = null)

Functions

toJava

open override fun toJava(): EndpointServicebusQueueArgs

Properties

authenticationType

val authenticationType: Output<String>? = null

Type used to authenticate against the Service Bus Queue endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.

connectionString

val connectionString: Output<String>? = null

The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.

endpointUri

val endpointUri: Output<String>? = null

URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.

entityPath

val entityPath: Output<String>? = null

Name of the Service Bus Queue. This attribute can only be specified and is mandatory when authentication_type is identityBased.

identityId

val identityId: Output<String>? = null

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

iothubId

val iothubId: Output<String>? = null

The IoTHub ID for the endpoint. Changing this forces a new resource to be created.

name

val name: Output<String>? = null

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

val resourceGroupName: Output<String>? = null

The name of the resource group under which the Service Bus Queue has been created. Changing this forces a new resource to be created.