Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.15.0 published on Wednesday, Aug 17, 2022 by Pulumi

EndpointServicebus

Manages a Digital Twins Service Bus Endpoint.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleInstance = new Azure.DigitalTwins.Instance("exampleInstance", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
    });

    var exampleNamespace = new Azure.ServiceBus.Namespace("exampleNamespace", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        Sku = "Standard",
    });

    var exampleTopic = new Azure.ServiceBus.Topic("exampleTopic", new()
    {
        NamespaceId = exampleNamespace.Id,
    });

    var exampleTopicAuthorizationRule = new Azure.ServiceBus.TopicAuthorizationRule("exampleTopicAuthorizationRule", new()
    {
        TopicId = exampleTopic.Id,
        Listen = false,
        Send = true,
        Manage = false,
    });

    var exampleEndpointServicebus = new Azure.DigitalTwins.EndpointServicebus("exampleEndpointServicebus", new()
    {
        DigitalTwinsId = exampleInstance.Id,
        ServicebusPrimaryConnectionString = exampleTopicAuthorizationRule.PrimaryConnectionString,
        ServicebusSecondaryConnectionString = exampleTopicAuthorizationRule.SecondaryConnectionString,
    });

});
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/digitaltwins"
	"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
		}
		exampleInstance, err := digitaltwins.NewInstance(ctx, "exampleInstance", &digitaltwins.InstanceArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
		})
		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
		}
		exampleTopic, err := servicebus.NewTopic(ctx, "exampleTopic", &servicebus.TopicArgs{
			NamespaceId: exampleNamespace.ID(),
		})
		if err != nil {
			return err
		}
		exampleTopicAuthorizationRule, err := servicebus.NewTopicAuthorizationRule(ctx, "exampleTopicAuthorizationRule", &servicebus.TopicAuthorizationRuleArgs{
			TopicId: exampleTopic.ID(),
			Listen:  pulumi.Bool(false),
			Send:    pulumi.Bool(true),
			Manage:  pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = digitaltwins.NewEndpointServicebus(ctx, "exampleEndpointServicebus", &digitaltwins.EndpointServicebusArgs{
			DigitalTwinsId:                      exampleInstance.ID(),
			ServicebusPrimaryConnectionString:   exampleTopicAuthorizationRule.PrimaryConnectionString,
			ServicebusSecondaryConnectionString: exampleTopicAuthorizationRule.SecondaryConnectionString,
		})
		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.digitaltwins.Instance;
import com.pulumi.azure.digitaltwins.InstanceArgs;
import com.pulumi.azure.servicebus.Namespace;
import com.pulumi.azure.servicebus.NamespaceArgs;
import com.pulumi.azure.servicebus.Topic;
import com.pulumi.azure.servicebus.TopicArgs;
import com.pulumi.azure.servicebus.TopicAuthorizationRule;
import com.pulumi.azure.servicebus.TopicAuthorizationRuleArgs;
import com.pulumi.azure.digitaltwins.EndpointServicebus;
import com.pulumi.azure.digitaltwins.EndpointServicebusArgs;
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 exampleInstance = new Instance("exampleInstance", InstanceArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .build());

        var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .sku("Standard")
            .build());

        var exampleTopic = new Topic("exampleTopic", TopicArgs.builder()        
            .namespaceId(exampleNamespace.id())
            .build());

        var exampleTopicAuthorizationRule = new TopicAuthorizationRule("exampleTopicAuthorizationRule", TopicAuthorizationRuleArgs.builder()        
            .topicId(exampleTopic.id())
            .listen(false)
            .send(true)
            .manage(false)
            .build());

        var exampleEndpointServicebus = new EndpointServicebus("exampleEndpointServicebus", EndpointServicebusArgs.builder()        
            .digitalTwinsId(exampleInstance.id())
            .servicebusPrimaryConnectionString(exampleTopicAuthorizationRule.primaryConnectionString())
            .servicebusSecondaryConnectionString(exampleTopicAuthorizationRule.secondaryConnectionString())
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_instance = azure.digitaltwins.Instance("exampleInstance",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard")
example_topic = azure.servicebus.Topic("exampleTopic", namespace_id=example_namespace.id)
example_topic_authorization_rule = azure.servicebus.TopicAuthorizationRule("exampleTopicAuthorizationRule",
    topic_id=example_topic.id,
    listen=False,
    send=True,
    manage=False)
example_endpoint_servicebus = azure.digitaltwins.EndpointServicebus("exampleEndpointServicebus",
    digital_twins_id=example_instance.id,
    servicebus_primary_connection_string=example_topic_authorization_rule.primary_connection_string,
    servicebus_secondary_connection_string=example_topic_authorization_rule.secondary_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 exampleInstance = new azure.digitaltwins.Instance("exampleInstance", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "Standard",
});
const exampleTopic = new azure.servicebus.Topic("exampleTopic", {namespaceId: exampleNamespace.id});
const exampleTopicAuthorizationRule = new azure.servicebus.TopicAuthorizationRule("exampleTopicAuthorizationRule", {
    topicId: exampleTopic.id,
    listen: false,
    send: true,
    manage: false,
});
const exampleEndpointServicebus = new azure.digitaltwins.EndpointServicebus("exampleEndpointServicebus", {
    digitalTwinsId: exampleInstance.id,
    servicebusPrimaryConnectionString: exampleTopicAuthorizationRule.primaryConnectionString,
    servicebusSecondaryConnectionString: exampleTopicAuthorizationRule.secondaryConnectionString,
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleInstance:
    type: azure:digitaltwins:Instance
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
  exampleNamespace:
    type: azure:servicebus:Namespace
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      sku: Standard
  exampleTopic:
    type: azure:servicebus:Topic
    properties:
      namespaceId: ${exampleNamespace.id}
  exampleTopicAuthorizationRule:
    type: azure:servicebus:TopicAuthorizationRule
    properties:
      topicId: ${exampleTopic.id}
      listen: false
      send: true
      manage: false
  exampleEndpointServicebus:
    type: azure:digitaltwins:EndpointServicebus
    properties:
      digitalTwinsId: ${exampleInstance.id}
      servicebusPrimaryConnectionString: ${exampleTopicAuthorizationRule.primaryConnectionString}
      servicebusSecondaryConnectionString: ${exampleTopicAuthorizationRule.secondaryConnectionString}

Create a EndpointServicebus Resource

new EndpointServicebus(name: string, args: EndpointServicebusArgs, opts?: CustomResourceOptions);
@overload
def EndpointServicebus(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       dead_letter_storage_secret: Optional[str] = None,
                       digital_twins_id: Optional[str] = None,
                       name: Optional[str] = None,
                       servicebus_primary_connection_string: Optional[str] = None,
                       servicebus_secondary_connection_string: Optional[str] = None)
@overload
def EndpointServicebus(resource_name: str,
                       args: EndpointServicebusArgs,
                       opts: Optional[ResourceOptions] = None)
func NewEndpointServicebus(ctx *Context, name string, args EndpointServicebusArgs, opts ...ResourceOption) (*EndpointServicebus, error)
public EndpointServicebus(string name, EndpointServicebusArgs args, CustomResourceOptions? opts = null)
public EndpointServicebus(String name, EndpointServicebusArgs args)
public EndpointServicebus(String name, EndpointServicebusArgs args, CustomResourceOptions options)
type: azure:digitaltwins:EndpointServicebus
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args EndpointServicebusArgs
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 EndpointServicebusArgs
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 EndpointServicebusArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EndpointServicebusArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EndpointServicebusArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

DigitalTwinsId string

The ID of the Digital Twins Instance. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

ServicebusPrimaryConnectionString string

The primary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission. .

ServicebusSecondaryConnectionString string

The secondary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission.

DeadLetterStorageSecret string

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

Name string

The name which should be used for this Digital Twins Service Bus Endpoint. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

DigitalTwinsId string

The ID of the Digital Twins Instance. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

ServicebusPrimaryConnectionString string

The primary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission. .

ServicebusSecondaryConnectionString string

The secondary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission.

DeadLetterStorageSecret string

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

Name string

The name which should be used for this Digital Twins Service Bus Endpoint. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

digitalTwinsId String

The ID of the Digital Twins Instance. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

servicebusPrimaryConnectionString String

The primary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission. .

servicebusSecondaryConnectionString String

The secondary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission.

deadLetterStorageSecret String

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

name String

The name which should be used for this Digital Twins Service Bus Endpoint. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

digitalTwinsId string

The ID of the Digital Twins Instance. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

servicebusPrimaryConnectionString string

The primary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission. .

servicebusSecondaryConnectionString string

The secondary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission.

deadLetterStorageSecret string

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

name string

The name which should be used for this Digital Twins Service Bus Endpoint. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

digital_twins_id str

The ID of the Digital Twins Instance. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

servicebus_primary_connection_string str

The primary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission. .

servicebus_secondary_connection_string str

The secondary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission.

dead_letter_storage_secret str

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

name str

The name which should be used for this Digital Twins Service Bus Endpoint. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

digitalTwinsId String

The ID of the Digital Twins Instance. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

servicebusPrimaryConnectionString String

The primary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission. .

servicebusSecondaryConnectionString String

The secondary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission.

deadLetterStorageSecret String

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

name String

The name which should be used for this Digital Twins Service Bus Endpoint. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the EndpointServicebus 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 an Existing EndpointServicebus Resource

Get an existing EndpointServicebus 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?: EndpointServicebusState, opts?: CustomResourceOptions): EndpointServicebus
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dead_letter_storage_secret: Optional[str] = None,
        digital_twins_id: Optional[str] = None,
        name: Optional[str] = None,
        servicebus_primary_connection_string: Optional[str] = None,
        servicebus_secondary_connection_string: Optional[str] = None) -> EndpointServicebus
func GetEndpointServicebus(ctx *Context, name string, id IDInput, state *EndpointServicebusState, opts ...ResourceOption) (*EndpointServicebus, error)
public static EndpointServicebus Get(string name, Input<string> id, EndpointServicebusState? state, CustomResourceOptions? opts = null)
public static EndpointServicebus get(String name, Output<String> id, EndpointServicebusState 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:
DeadLetterStorageSecret string

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

DigitalTwinsId string

The ID of the Digital Twins Instance. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

Name string

The name which should be used for this Digital Twins Service Bus Endpoint. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

ServicebusPrimaryConnectionString string

The primary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission. .

ServicebusSecondaryConnectionString string

The secondary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission.

DeadLetterStorageSecret string

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

DigitalTwinsId string

The ID of the Digital Twins Instance. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

Name string

The name which should be used for this Digital Twins Service Bus Endpoint. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

ServicebusPrimaryConnectionString string

The primary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission. .

ServicebusSecondaryConnectionString string

The secondary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission.

deadLetterStorageSecret String

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

digitalTwinsId String

The ID of the Digital Twins Instance. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

name String

The name which should be used for this Digital Twins Service Bus Endpoint. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

servicebusPrimaryConnectionString String

The primary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission. .

servicebusSecondaryConnectionString String

The secondary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission.

deadLetterStorageSecret string

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

digitalTwinsId string

The ID of the Digital Twins Instance. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

name string

The name which should be used for this Digital Twins Service Bus Endpoint. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

servicebusPrimaryConnectionString string

The primary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission. .

servicebusSecondaryConnectionString string

The secondary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission.

dead_letter_storage_secret str

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

digital_twins_id str

The ID of the Digital Twins Instance. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

name str

The name which should be used for this Digital Twins Service Bus Endpoint. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

servicebus_primary_connection_string str

The primary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission. .

servicebus_secondary_connection_string str

The secondary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission.

deadLetterStorageSecret String

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

digitalTwinsId String

The ID of the Digital Twins Instance. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

name String

The name which should be used for this Digital Twins Service Bus Endpoint. Changing this forces a new Digital Twins Service Bus Endpoint to be created.

servicebusPrimaryConnectionString String

The primary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission. .

servicebusSecondaryConnectionString String

The secondary connection string of the Service Bus Topic Authorization Rule with a minimum of send permission.

Import

Digital Twins Service Bus Endpoints can be imported using the resource id, e.g.

 $ pulumi import azure:digitaltwins/endpointServicebus:EndpointServicebus example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DigitalTwins/digitalTwinsInstances/dt1/endpoints/ep1

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.