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

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}

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

constructor(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)

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.

Functions

toJava

open override fun toJava(): EndpointServicebusQueueArgs