Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. digitaltwins
  5. DigitalTwinsEndpoint
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.digitaltwins.DigitalTwinsEndpoint

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

DigitalTwinsInstance endpoint resource.

Uses Azure REST API version 2023-01-31. In version 2.x of the Azure Native provider, it used API version 2023-01-31.

Example Usage

Put a DigitalTwinsEndpoint resource

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var digitalTwinsEndpoint = new AzureNative.DigitalTwins.DigitalTwinsEndpoint("digitalTwinsEndpoint", new()
    {
        EndpointName = "myServiceBus",
        Properties = new AzureNative.DigitalTwins.Inputs.ServiceBusArgs
        {
            AuthenticationType = AzureNative.DigitalTwins.AuthenticationType.KeyBased,
            EndpointType = "ServiceBus",
            PrimaryConnectionString = "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc",
            SecondaryConnectionString = "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc",
        },
        ResourceGroupName = "resRg",
        ResourceName = "myDigitalTwinsService",
    });

});
Copy
package main

import (
	digitaltwins "github.com/pulumi/pulumi-azure-native-sdk/digitaltwins/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitaltwins.NewDigitalTwinsEndpoint(ctx, "digitalTwinsEndpoint", &digitaltwins.DigitalTwinsEndpointArgs{
			EndpointName: pulumi.String("myServiceBus"),
			Properties: &digitaltwins.ServiceBusArgs{
				AuthenticationType:        pulumi.String(digitaltwins.AuthenticationTypeKeyBased),
				EndpointType:              pulumi.String("ServiceBus"),
				PrimaryConnectionString:   pulumi.String("Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc"),
				SecondaryConnectionString: pulumi.String("Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc"),
			},
			ResourceGroupName: pulumi.String("resRg"),
			ResourceName:      pulumi.String("myDigitalTwinsService"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.digitaltwins.DigitalTwinsEndpoint;
import com.pulumi.azurenative.digitaltwins.DigitalTwinsEndpointArgs;
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 digitalTwinsEndpoint = new DigitalTwinsEndpoint("digitalTwinsEndpoint", DigitalTwinsEndpointArgs.builder()
            .endpointName("myServiceBus")
            .properties(ServiceBusArgs.builder()
                .authenticationType("KeyBased")
                .endpointType("ServiceBus")
                .primaryConnectionString("Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc")
                .secondaryConnectionString("Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc")
                .build())
            .resourceGroupName("resRg")
            .resourceName("myDigitalTwinsService")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const digitalTwinsEndpoint = new azure_native.digitaltwins.DigitalTwinsEndpoint("digitalTwinsEndpoint", {
    endpointName: "myServiceBus",
    properties: {
        authenticationType: azure_native.digitaltwins.AuthenticationType.KeyBased,
        endpointType: "ServiceBus",
        primaryConnectionString: "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc",
        secondaryConnectionString: "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc",
    },
    resourceGroupName: "resRg",
    resourceName: "myDigitalTwinsService",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

digital_twins_endpoint = azure_native.digitaltwins.DigitalTwinsEndpoint("digitalTwinsEndpoint",
    endpoint_name="myServiceBus",
    properties={
        "authentication_type": azure_native.digitaltwins.AuthenticationType.KEY_BASED,
        "endpoint_type": "ServiceBus",
        "primary_connection_string": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc",
        "secondary_connection_string": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc",
    },
    resource_group_name="resRg",
    resource_name_="myDigitalTwinsService")
Copy
resources:
  digitalTwinsEndpoint:
    type: azure-native:digitaltwins:DigitalTwinsEndpoint
    properties:
      endpointName: myServiceBus
      properties:
        authenticationType: KeyBased
        endpointType: ServiceBus
        primaryConnectionString: Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc
        secondaryConnectionString: Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc
      resourceGroupName: resRg
      resourceName: myDigitalTwinsService
Copy

Put a DigitalTwinsEndpoint resource with identity

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var digitalTwinsEndpoint = new AzureNative.DigitalTwins.DigitalTwinsEndpoint("digitalTwinsEndpoint", new()
    {
        EndpointName = "myServiceBus",
        Properties = new AzureNative.DigitalTwins.Inputs.ServiceBusArgs
        {
            AuthenticationType = AzureNative.DigitalTwins.AuthenticationType.IdentityBased,
            EndpointType = "ServiceBus",
            EndpointUri = "sb://mysb.servicebus.windows.net/",
            EntityPath = "mysbtopic",
        },
        ResourceGroupName = "resRg",
        ResourceName = "myDigitalTwinsService",
    });

});
Copy
package main

import (
	digitaltwins "github.com/pulumi/pulumi-azure-native-sdk/digitaltwins/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitaltwins.NewDigitalTwinsEndpoint(ctx, "digitalTwinsEndpoint", &digitaltwins.DigitalTwinsEndpointArgs{
			EndpointName: pulumi.String("myServiceBus"),
			Properties: &digitaltwins.ServiceBusArgs{
				AuthenticationType: pulumi.String(digitaltwins.AuthenticationTypeIdentityBased),
				EndpointType:       pulumi.String("ServiceBus"),
				EndpointUri:        pulumi.String("sb://mysb.servicebus.windows.net/"),
				EntityPath:         pulumi.String("mysbtopic"),
			},
			ResourceGroupName: pulumi.String("resRg"),
			ResourceName:      pulumi.String("myDigitalTwinsService"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.digitaltwins.DigitalTwinsEndpoint;
import com.pulumi.azurenative.digitaltwins.DigitalTwinsEndpointArgs;
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 digitalTwinsEndpoint = new DigitalTwinsEndpoint("digitalTwinsEndpoint", DigitalTwinsEndpointArgs.builder()
            .endpointName("myServiceBus")
            .properties(ServiceBusArgs.builder()
                .authenticationType("IdentityBased")
                .endpointType("ServiceBus")
                .endpointUri("sb://mysb.servicebus.windows.net/")
                .entityPath("mysbtopic")
                .build())
            .resourceGroupName("resRg")
            .resourceName("myDigitalTwinsService")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const digitalTwinsEndpoint = new azure_native.digitaltwins.DigitalTwinsEndpoint("digitalTwinsEndpoint", {
    endpointName: "myServiceBus",
    properties: {
        authenticationType: azure_native.digitaltwins.AuthenticationType.IdentityBased,
        endpointType: "ServiceBus",
        endpointUri: "sb://mysb.servicebus.windows.net/",
        entityPath: "mysbtopic",
    },
    resourceGroupName: "resRg",
    resourceName: "myDigitalTwinsService",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

digital_twins_endpoint = azure_native.digitaltwins.DigitalTwinsEndpoint("digitalTwinsEndpoint",
    endpoint_name="myServiceBus",
    properties={
        "authentication_type": azure_native.digitaltwins.AuthenticationType.IDENTITY_BASED,
        "endpoint_type": "ServiceBus",
        "endpoint_uri": "sb://mysb.servicebus.windows.net/",
        "entity_path": "mysbtopic",
    },
    resource_group_name="resRg",
    resource_name_="myDigitalTwinsService")
Copy
resources:
  digitalTwinsEndpoint:
    type: azure-native:digitaltwins:DigitalTwinsEndpoint
    properties:
      endpointName: myServiceBus
      properties:
        authenticationType: IdentityBased
        endpointType: ServiceBus
        endpointUri: sb://mysb.servicebus.windows.net/
        entityPath: mysbtopic
      resourceGroupName: resRg
      resourceName: myDigitalTwinsService
Copy

Put a DigitalTwinsEndpoint resource with user assigned identity

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var digitalTwinsEndpoint = new AzureNative.DigitalTwins.DigitalTwinsEndpoint("digitalTwinsEndpoint", new()
    {
        EndpointName = "myServiceBus",
        Properties = new AzureNative.DigitalTwins.Inputs.ServiceBusArgs
        {
            AuthenticationType = AzureNative.DigitalTwins.AuthenticationType.IdentityBased,
            EndpointType = "ServiceBus",
            EndpointUri = "sb://mysb.servicebus.windows.net/",
            EntityPath = "mysbtopic",
            Identity = new AzureNative.DigitalTwins.Inputs.ManagedIdentityReferenceArgs
            {
                Type = AzureNative.DigitalTwins.IdentityType.UserAssigned,
                UserAssignedIdentity = "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity",
            },
        },
        ResourceGroupName = "resRg",
        ResourceName = "myDigitalTwinsService",
    });

});
Copy
package main

import (
	digitaltwins "github.com/pulumi/pulumi-azure-native-sdk/digitaltwins/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitaltwins.NewDigitalTwinsEndpoint(ctx, "digitalTwinsEndpoint", &digitaltwins.DigitalTwinsEndpointArgs{
			EndpointName: pulumi.String("myServiceBus"),
			Properties: &digitaltwins.ServiceBusArgs{
				AuthenticationType: pulumi.String(digitaltwins.AuthenticationTypeIdentityBased),
				EndpointType:       pulumi.String("ServiceBus"),
				EndpointUri:        pulumi.String("sb://mysb.servicebus.windows.net/"),
				EntityPath:         pulumi.String("mysbtopic"),
				Identity: &digitaltwins.ManagedIdentityReferenceArgs{
					Type:                 pulumi.String(digitaltwins.IdentityTypeUserAssigned),
					UserAssignedIdentity: pulumi.String("/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity"),
				},
			},
			ResourceGroupName: pulumi.String("resRg"),
			ResourceName:      pulumi.String("myDigitalTwinsService"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.digitaltwins.DigitalTwinsEndpoint;
import com.pulumi.azurenative.digitaltwins.DigitalTwinsEndpointArgs;
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 digitalTwinsEndpoint = new DigitalTwinsEndpoint("digitalTwinsEndpoint", DigitalTwinsEndpointArgs.builder()
            .endpointName("myServiceBus")
            .properties(ServiceBusArgs.builder()
                .authenticationType("IdentityBased")
                .endpointType("ServiceBus")
                .endpointUri("sb://mysb.servicebus.windows.net/")
                .entityPath("mysbtopic")
                .identity(ManagedIdentityReferenceArgs.builder()
                    .type("UserAssigned")
                    .userAssignedIdentity("/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity")
                    .build())
                .build())
            .resourceGroupName("resRg")
            .resourceName("myDigitalTwinsService")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const digitalTwinsEndpoint = new azure_native.digitaltwins.DigitalTwinsEndpoint("digitalTwinsEndpoint", {
    endpointName: "myServiceBus",
    properties: {
        authenticationType: azure_native.digitaltwins.AuthenticationType.IdentityBased,
        endpointType: "ServiceBus",
        endpointUri: "sb://mysb.servicebus.windows.net/",
        entityPath: "mysbtopic",
        identity: {
            type: azure_native.digitaltwins.IdentityType.UserAssigned,
            userAssignedIdentity: "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity",
        },
    },
    resourceGroupName: "resRg",
    resourceName: "myDigitalTwinsService",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

digital_twins_endpoint = azure_native.digitaltwins.DigitalTwinsEndpoint("digitalTwinsEndpoint",
    endpoint_name="myServiceBus",
    properties={
        "authentication_type": azure_native.digitaltwins.AuthenticationType.IDENTITY_BASED,
        "endpoint_type": "ServiceBus",
        "endpoint_uri": "sb://mysb.servicebus.windows.net/",
        "entity_path": "mysbtopic",
        "identity": {
            "type": azure_native.digitaltwins.IdentityType.USER_ASSIGNED,
            "user_assigned_identity": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity",
        },
    },
    resource_group_name="resRg",
    resource_name_="myDigitalTwinsService")
Copy
resources:
  digitalTwinsEndpoint:
    type: azure-native:digitaltwins:DigitalTwinsEndpoint
    properties:
      endpointName: myServiceBus
      properties:
        authenticationType: IdentityBased
        endpointType: ServiceBus
        endpointUri: sb://mysb.servicebus.windows.net/
        entityPath: mysbtopic
        identity:
          type: UserAssigned
          userAssignedIdentity: /subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity
      resourceGroupName: resRg
      resourceName: myDigitalTwinsService
Copy

Create DigitalTwinsEndpoint Resource

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

Constructor syntax

new DigitalTwinsEndpoint(name: string, args: DigitalTwinsEndpointArgs, opts?: CustomResourceOptions);
@overload
def DigitalTwinsEndpoint(resource_name: str,
                         args: DigitalTwinsEndpointArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def DigitalTwinsEndpoint(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         properties: Optional[Union[EventGridArgs, EventHubArgs, ServiceBusArgs]] = None,
                         resource_group_name: Optional[str] = None,
                         resource_name_: Optional[str] = None,
                         endpoint_name: Optional[str] = None)
func NewDigitalTwinsEndpoint(ctx *Context, name string, args DigitalTwinsEndpointArgs, opts ...ResourceOption) (*DigitalTwinsEndpoint, error)
public DigitalTwinsEndpoint(string name, DigitalTwinsEndpointArgs args, CustomResourceOptions? opts = null)
public DigitalTwinsEndpoint(String name, DigitalTwinsEndpointArgs args)
public DigitalTwinsEndpoint(String name, DigitalTwinsEndpointArgs args, CustomResourceOptions options)

type: azure-native:digitaltwins:DigitalTwinsEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DigitalTwinsEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DigitalTwinsEndpointArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DigitalTwinsEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DigitalTwinsEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DigitalTwinsEndpointArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var digitalTwinsEndpointResource = new AzureNative.DigitalTwins.DigitalTwinsEndpoint("digitalTwinsEndpointResource", new()
{
    Properties = new AzureNative.DigitalTwins.Inputs.EventGridArgs
    {
        AccessKey1 = "string",
        EndpointType = "EventGrid",
        TopicEndpoint = "string",
        AccessKey2 = "string",
        AuthenticationType = "string",
        DeadLetterSecret = "string",
        DeadLetterUri = "string",
        Identity = new AzureNative.DigitalTwins.Inputs.ManagedIdentityReferenceArgs
        {
            Type = "string",
            UserAssignedIdentity = "string",
        },
    },
    ResourceGroupName = "string",
    ResourceName = "string",
    EndpointName = "string",
});
Copy
example, err := digitaltwins.NewDigitalTwinsEndpoint(ctx, "digitalTwinsEndpointResource", &digitaltwins.DigitalTwinsEndpointArgs{
	Properties: &digitaltwins.EventGridArgs{
		AccessKey1:         pulumi.String("string"),
		EndpointType:       pulumi.String("EventGrid"),
		TopicEndpoint:      pulumi.String("string"),
		AccessKey2:         pulumi.String("string"),
		AuthenticationType: pulumi.String("string"),
		DeadLetterSecret:   pulumi.String("string"),
		DeadLetterUri:      pulumi.String("string"),
		Identity: &digitaltwins.ManagedIdentityReferenceArgs{
			Type:                 pulumi.String("string"),
			UserAssignedIdentity: pulumi.String("string"),
		},
	},
	ResourceGroupName: pulumi.String("string"),
	ResourceName:      pulumi.String("string"),
	EndpointName:      pulumi.String("string"),
})
Copy
var digitalTwinsEndpointResource = new DigitalTwinsEndpoint("digitalTwinsEndpointResource", DigitalTwinsEndpointArgs.builder()
    .properties(EventGridArgs.builder()
        .accessKey1("string")
        .endpointType("EventGrid")
        .topicEndpoint("string")
        .accessKey2("string")
        .authenticationType("string")
        .deadLetterSecret("string")
        .deadLetterUri("string")
        .identity(ManagedIdentityReferenceArgs.builder()
            .type("string")
            .userAssignedIdentity("string")
            .build())
        .build())
    .resourceGroupName("string")
    .resourceName("string")
    .endpointName("string")
    .build());
Copy
digital_twins_endpoint_resource = azure_native.digitaltwins.DigitalTwinsEndpoint("digitalTwinsEndpointResource",
    properties={
        "access_key1": "string",
        "endpoint_type": "EventGrid",
        "topic_endpoint": "string",
        "access_key2": "string",
        "authentication_type": "string",
        "dead_letter_secret": "string",
        "dead_letter_uri": "string",
        "identity": {
            "type": "string",
            "user_assigned_identity": "string",
        },
    },
    resource_group_name="string",
    resource_name_="string",
    endpoint_name="string")
Copy
const digitalTwinsEndpointResource = new azure_native.digitaltwins.DigitalTwinsEndpoint("digitalTwinsEndpointResource", {
    properties: {
        accessKey1: "string",
        endpointType: "EventGrid",
        topicEndpoint: "string",
        accessKey2: "string",
        authenticationType: "string",
        deadLetterSecret: "string",
        deadLetterUri: "string",
        identity: {
            type: "string",
            userAssignedIdentity: "string",
        },
    },
    resourceGroupName: "string",
    resourceName: "string",
    endpointName: "string",
});
Copy
type: azure-native:digitaltwins:DigitalTwinsEndpoint
properties:
    endpointName: string
    properties:
        accessKey1: string
        accessKey2: string
        authenticationType: string
        deadLetterSecret: string
        deadLetterUri: string
        endpointType: EventGrid
        identity:
            type: string
            userAssignedIdentity: string
        topicEndpoint: string
    resourceGroupName: string
    resourceName: string
Copy

DigitalTwinsEndpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DigitalTwinsEndpoint resource accepts the following input properties:

Properties This property is required. Pulumi.AzureNative.DigitalTwins.Inputs.EventGrid | Pulumi.AzureNative.DigitalTwins.Inputs.EventHub | Pulumi.AzureNative.DigitalTwins.Inputs.ServiceBus
DigitalTwinsInstance endpoint resource properties.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the DigitalTwinsInstance.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DigitalTwinsInstance.
EndpointName Changes to this property will trigger replacement. string
Name of Endpoint Resource.
Properties This property is required. EventGridArgs | EventHubArgs | ServiceBusArgs
DigitalTwinsInstance endpoint resource properties.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the DigitalTwinsInstance.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DigitalTwinsInstance.
EndpointName Changes to this property will trigger replacement. string
Name of Endpoint Resource.
properties This property is required. EventGrid | EventHub | ServiceBus
DigitalTwinsInstance endpoint resource properties.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the DigitalTwinsInstance.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the DigitalTwinsInstance.
endpointName Changes to this property will trigger replacement. String
Name of Endpoint Resource.
properties This property is required. EventGrid | EventHub | ServiceBus
DigitalTwinsInstance endpoint resource properties.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the DigitalTwinsInstance.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DigitalTwinsInstance.
endpointName Changes to this property will trigger replacement. string
Name of Endpoint Resource.
properties This property is required. EventGridArgs | EventHubArgs | ServiceBusArgs
DigitalTwinsInstance endpoint resource properties.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the DigitalTwinsInstance.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the DigitalTwinsInstance.
endpoint_name Changes to this property will trigger replacement. str
Name of Endpoint Resource.
properties This property is required. Property Map | Property Map | Property Map
DigitalTwinsInstance endpoint resource properties.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the DigitalTwinsInstance.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the DigitalTwinsInstance.
endpointName Changes to this property will trigger replacement. String
Name of Endpoint Resource.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Extension resource name.
SystemData Pulumi.AzureNative.DigitalTwins.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The resource type.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Extension resource name.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The resource type.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Extension resource name.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The resource type.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
Extension resource name.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The resource type.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
Extension resource name.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The resource type.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Extension resource name.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The resource type.

Supporting Types

AuthenticationType
, AuthenticationTypeArgs

KeyBased
KeyBased
IdentityBased
IdentityBased
AuthenticationTypeKeyBased
KeyBased
AuthenticationTypeIdentityBased
IdentityBased
KeyBased
KeyBased
IdentityBased
IdentityBased
KeyBased
KeyBased
IdentityBased
IdentityBased
KEY_BASED
KeyBased
IDENTITY_BASED
IdentityBased
"KeyBased"
KeyBased
"IdentityBased"
IdentityBased

EventGrid
, EventGridArgs

AccessKey1 This property is required. string
EventGrid secondary accesskey. Will be obfuscated during read.
TopicEndpoint This property is required. string
EventGrid Topic Endpoint.
AccessKey2 string
EventGrid secondary accesskey. Will be obfuscated during read.
AuthenticationType string | Pulumi.AzureNative.DigitalTwins.AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
DeadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
DeadLetterUri string
Dead letter storage URL for identity-based authentication.
Identity Pulumi.AzureNative.DigitalTwins.Inputs.ManagedIdentityReference
Managed identity properties for the endpoint.
AccessKey1 This property is required. string
EventGrid secondary accesskey. Will be obfuscated during read.
TopicEndpoint This property is required. string
EventGrid Topic Endpoint.
AccessKey2 string
EventGrid secondary accesskey. Will be obfuscated during read.
AuthenticationType string | AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
DeadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
DeadLetterUri string
Dead letter storage URL for identity-based authentication.
Identity ManagedIdentityReference
Managed identity properties for the endpoint.
accessKey1 This property is required. String
EventGrid secondary accesskey. Will be obfuscated during read.
topicEndpoint This property is required. String
EventGrid Topic Endpoint.
accessKey2 String
EventGrid secondary accesskey. Will be obfuscated during read.
authenticationType String | AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
deadLetterSecret String
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri String
Dead letter storage URL for identity-based authentication.
identity ManagedIdentityReference
Managed identity properties for the endpoint.
accessKey1 This property is required. string
EventGrid secondary accesskey. Will be obfuscated during read.
topicEndpoint This property is required. string
EventGrid Topic Endpoint.
accessKey2 string
EventGrid secondary accesskey. Will be obfuscated during read.
authenticationType string | AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
deadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri string
Dead letter storage URL for identity-based authentication.
identity ManagedIdentityReference
Managed identity properties for the endpoint.
access_key1 This property is required. str
EventGrid secondary accesskey. Will be obfuscated during read.
topic_endpoint This property is required. str
EventGrid Topic Endpoint.
access_key2 str
EventGrid secondary accesskey. Will be obfuscated during read.
authentication_type str | AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
dead_letter_secret str
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
dead_letter_uri str
Dead letter storage URL for identity-based authentication.
identity ManagedIdentityReference
Managed identity properties for the endpoint.
accessKey1 This property is required. String
EventGrid secondary accesskey. Will be obfuscated during read.
topicEndpoint This property is required. String
EventGrid Topic Endpoint.
accessKey2 String
EventGrid secondary accesskey. Will be obfuscated during read.
authenticationType String | "KeyBased" | "IdentityBased"
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
deadLetterSecret String
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri String
Dead letter storage URL for identity-based authentication.
identity Property Map
Managed identity properties for the endpoint.

EventGridResponse
, EventGridResponseArgs

AccessKey1 This property is required. string
EventGrid secondary accesskey. Will be obfuscated during read.
CreatedTime This property is required. string
Time when the Endpoint was added to DigitalTwinsInstance.
ProvisioningState This property is required. string
The provisioning state.
TopicEndpoint This property is required. string
EventGrid Topic Endpoint.
AccessKey2 string
EventGrid secondary accesskey. Will be obfuscated during read.
AuthenticationType string
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
DeadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
DeadLetterUri string
Dead letter storage URL for identity-based authentication.
Identity Pulumi.AzureNative.DigitalTwins.Inputs.ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
AccessKey1 This property is required. string
EventGrid secondary accesskey. Will be obfuscated during read.
CreatedTime This property is required. string
Time when the Endpoint was added to DigitalTwinsInstance.
ProvisioningState This property is required. string
The provisioning state.
TopicEndpoint This property is required. string
EventGrid Topic Endpoint.
AccessKey2 string
EventGrid secondary accesskey. Will be obfuscated during read.
AuthenticationType string
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
DeadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
DeadLetterUri string
Dead letter storage URL for identity-based authentication.
Identity ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
accessKey1 This property is required. String
EventGrid secondary accesskey. Will be obfuscated during read.
createdTime This property is required. String
Time when the Endpoint was added to DigitalTwinsInstance.
provisioningState This property is required. String
The provisioning state.
topicEndpoint This property is required. String
EventGrid Topic Endpoint.
accessKey2 String
EventGrid secondary accesskey. Will be obfuscated during read.
authenticationType String
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
deadLetterSecret String
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri String
Dead letter storage URL for identity-based authentication.
identity ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
accessKey1 This property is required. string
EventGrid secondary accesskey. Will be obfuscated during read.
createdTime This property is required. string
Time when the Endpoint was added to DigitalTwinsInstance.
provisioningState This property is required. string
The provisioning state.
topicEndpoint This property is required. string
EventGrid Topic Endpoint.
accessKey2 string
EventGrid secondary accesskey. Will be obfuscated during read.
authenticationType string
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
deadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri string
Dead letter storage URL for identity-based authentication.
identity ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
access_key1 This property is required. str
EventGrid secondary accesskey. Will be obfuscated during read.
created_time This property is required. str
Time when the Endpoint was added to DigitalTwinsInstance.
provisioning_state This property is required. str
The provisioning state.
topic_endpoint This property is required. str
EventGrid Topic Endpoint.
access_key2 str
EventGrid secondary accesskey. Will be obfuscated during read.
authentication_type str
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
dead_letter_secret str
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
dead_letter_uri str
Dead letter storage URL for identity-based authentication.
identity ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
accessKey1 This property is required. String
EventGrid secondary accesskey. Will be obfuscated during read.
createdTime This property is required. String
Time when the Endpoint was added to DigitalTwinsInstance.
provisioningState This property is required. String
The provisioning state.
topicEndpoint This property is required. String
EventGrid Topic Endpoint.
accessKey2 String
EventGrid secondary accesskey. Will be obfuscated during read.
authenticationType String
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
deadLetterSecret String
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri String
Dead letter storage URL for identity-based authentication.
identity Property Map
Managed identity properties for the endpoint.

EventHub
, EventHubArgs

AuthenticationType string | Pulumi.AzureNative.DigitalTwins.AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
ConnectionStringPrimaryKey string
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
ConnectionStringSecondaryKey string
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
DeadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
DeadLetterUri string
Dead letter storage URL for identity-based authentication.
EndpointUri string
The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
EntityPath string
The EventHub name in the EventHub namespace for identity-based authentication.
Identity Pulumi.AzureNative.DigitalTwins.Inputs.ManagedIdentityReference
Managed identity properties for the endpoint.
AuthenticationType string | AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
ConnectionStringPrimaryKey string
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
ConnectionStringSecondaryKey string
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
DeadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
DeadLetterUri string
Dead letter storage URL for identity-based authentication.
EndpointUri string
The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
EntityPath string
The EventHub name in the EventHub namespace for identity-based authentication.
Identity ManagedIdentityReference
Managed identity properties for the endpoint.
authenticationType String | AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
connectionStringPrimaryKey String
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
connectionStringSecondaryKey String
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
deadLetterSecret String
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri String
Dead letter storage URL for identity-based authentication.
endpointUri String
The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath String
The EventHub name in the EventHub namespace for identity-based authentication.
identity ManagedIdentityReference
Managed identity properties for the endpoint.
authenticationType string | AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
connectionStringPrimaryKey string
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
connectionStringSecondaryKey string
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
deadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri string
Dead letter storage URL for identity-based authentication.
endpointUri string
The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath string
The EventHub name in the EventHub namespace for identity-based authentication.
identity ManagedIdentityReference
Managed identity properties for the endpoint.
authentication_type str | AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
connection_string_primary_key str
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
connection_string_secondary_key str
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
dead_letter_secret str
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
dead_letter_uri str
Dead letter storage URL for identity-based authentication.
endpoint_uri str
The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
entity_path str
The EventHub name in the EventHub namespace for identity-based authentication.
identity ManagedIdentityReference
Managed identity properties for the endpoint.
authenticationType String | "KeyBased" | "IdentityBased"
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
connectionStringPrimaryKey String
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
connectionStringSecondaryKey String
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
deadLetterSecret String
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri String
Dead letter storage URL for identity-based authentication.
endpointUri String
The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath String
The EventHub name in the EventHub namespace for identity-based authentication.
identity Property Map
Managed identity properties for the endpoint.

EventHubResponse
, EventHubResponseArgs

CreatedTime This property is required. string
Time when the Endpoint was added to DigitalTwinsInstance.
ProvisioningState This property is required. string
The provisioning state.
AuthenticationType string
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
ConnectionStringPrimaryKey string
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
ConnectionStringSecondaryKey string
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
DeadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
DeadLetterUri string
Dead letter storage URL for identity-based authentication.
EndpointUri string
The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
EntityPath string
The EventHub name in the EventHub namespace for identity-based authentication.
Identity Pulumi.AzureNative.DigitalTwins.Inputs.ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
CreatedTime This property is required. string
Time when the Endpoint was added to DigitalTwinsInstance.
ProvisioningState This property is required. string
The provisioning state.
AuthenticationType string
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
ConnectionStringPrimaryKey string
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
ConnectionStringSecondaryKey string
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
DeadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
DeadLetterUri string
Dead letter storage URL for identity-based authentication.
EndpointUri string
The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
EntityPath string
The EventHub name in the EventHub namespace for identity-based authentication.
Identity ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
createdTime This property is required. String
Time when the Endpoint was added to DigitalTwinsInstance.
provisioningState This property is required. String
The provisioning state.
authenticationType String
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
connectionStringPrimaryKey String
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
connectionStringSecondaryKey String
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
deadLetterSecret String
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri String
Dead letter storage URL for identity-based authentication.
endpointUri String
The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath String
The EventHub name in the EventHub namespace for identity-based authentication.
identity ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
createdTime This property is required. string
Time when the Endpoint was added to DigitalTwinsInstance.
provisioningState This property is required. string
The provisioning state.
authenticationType string
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
connectionStringPrimaryKey string
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
connectionStringSecondaryKey string
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
deadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri string
Dead letter storage URL for identity-based authentication.
endpointUri string
The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath string
The EventHub name in the EventHub namespace for identity-based authentication.
identity ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
created_time This property is required. str
Time when the Endpoint was added to DigitalTwinsInstance.
provisioning_state This property is required. str
The provisioning state.
authentication_type str
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
connection_string_primary_key str
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
connection_string_secondary_key str
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
dead_letter_secret str
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
dead_letter_uri str
Dead letter storage URL for identity-based authentication.
endpoint_uri str
The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
entity_path str
The EventHub name in the EventHub namespace for identity-based authentication.
identity ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
createdTime This property is required. String
Time when the Endpoint was added to DigitalTwinsInstance.
provisioningState This property is required. String
The provisioning state.
authenticationType String
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
connectionStringPrimaryKey String
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
connectionStringSecondaryKey String
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
deadLetterSecret String
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri String
Dead letter storage URL for identity-based authentication.
endpointUri String
The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath String
The EventHub name in the EventHub namespace for identity-based authentication.
identity Property Map
Managed identity properties for the endpoint.

IdentityType
, IdentityTypeArgs

SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
IdentityTypeSystemAssigned
SystemAssigned
IdentityTypeUserAssigned
UserAssigned
SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
SYSTEM_ASSIGNED
SystemAssigned
USER_ASSIGNED
UserAssigned
"SystemAssigned"
SystemAssigned
"UserAssigned"
UserAssigned

ManagedIdentityReference
, ManagedIdentityReferenceArgs

Type string | Pulumi.AzureNative.DigitalTwins.IdentityType
The type of managed identity used.
UserAssignedIdentity string
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
Type string | IdentityType
The type of managed identity used.
UserAssignedIdentity string
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
type String | IdentityType
The type of managed identity used.
userAssignedIdentity String
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
type string | IdentityType
The type of managed identity used.
userAssignedIdentity string
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
type str | IdentityType
The type of managed identity used.
user_assigned_identity str
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
type String | "SystemAssigned" | "UserAssigned"
The type of managed identity used.
userAssignedIdentity String
The user identity ARM resource id if the managed identity type is 'UserAssigned'.

ManagedIdentityReferenceResponse
, ManagedIdentityReferenceResponseArgs

Type string
The type of managed identity used.
UserAssignedIdentity string
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
Type string
The type of managed identity used.
UserAssignedIdentity string
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
type String
The type of managed identity used.
userAssignedIdentity String
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
type string
The type of managed identity used.
userAssignedIdentity string
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
type str
The type of managed identity used.
user_assigned_identity str
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
type String
The type of managed identity used.
userAssignedIdentity String
The user identity ARM resource id if the managed identity type is 'UserAssigned'.

ServiceBus
, ServiceBusArgs

AuthenticationType string | Pulumi.AzureNative.DigitalTwins.AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
DeadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
DeadLetterUri string
Dead letter storage URL for identity-based authentication.
EndpointUri string
The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
EntityPath string
The ServiceBus Topic name for identity-based authentication.
Identity Pulumi.AzureNative.DigitalTwins.Inputs.ManagedIdentityReference
Managed identity properties for the endpoint.
PrimaryConnectionString string
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
SecondaryConnectionString string
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
AuthenticationType string | AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
DeadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
DeadLetterUri string
Dead letter storage URL for identity-based authentication.
EndpointUri string
The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
EntityPath string
The ServiceBus Topic name for identity-based authentication.
Identity ManagedIdentityReference
Managed identity properties for the endpoint.
PrimaryConnectionString string
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
SecondaryConnectionString string
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
authenticationType String | AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
deadLetterSecret String
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri String
Dead letter storage URL for identity-based authentication.
endpointUri String
The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath String
The ServiceBus Topic name for identity-based authentication.
identity ManagedIdentityReference
Managed identity properties for the endpoint.
primaryConnectionString String
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
secondaryConnectionString String
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
authenticationType string | AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
deadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri string
Dead letter storage URL for identity-based authentication.
endpointUri string
The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath string
The ServiceBus Topic name for identity-based authentication.
identity ManagedIdentityReference
Managed identity properties for the endpoint.
primaryConnectionString string
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
secondaryConnectionString string
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
authentication_type str | AuthenticationType
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
dead_letter_secret str
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
dead_letter_uri str
Dead letter storage URL for identity-based authentication.
endpoint_uri str
The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
entity_path str
The ServiceBus Topic name for identity-based authentication.
identity ManagedIdentityReference
Managed identity properties for the endpoint.
primary_connection_string str
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
secondary_connection_string str
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
authenticationType String | "KeyBased" | "IdentityBased"
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
deadLetterSecret String
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri String
Dead letter storage URL for identity-based authentication.
endpointUri String
The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath String
The ServiceBus Topic name for identity-based authentication.
identity Property Map
Managed identity properties for the endpoint.
primaryConnectionString String
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
secondaryConnectionString String
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.

ServiceBusResponse
, ServiceBusResponseArgs

CreatedTime This property is required. string
Time when the Endpoint was added to DigitalTwinsInstance.
ProvisioningState This property is required. string
The provisioning state.
AuthenticationType string
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
DeadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
DeadLetterUri string
Dead letter storage URL for identity-based authentication.
EndpointUri string
The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
EntityPath string
The ServiceBus Topic name for identity-based authentication.
Identity Pulumi.AzureNative.DigitalTwins.Inputs.ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
PrimaryConnectionString string
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
SecondaryConnectionString string
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
CreatedTime This property is required. string
Time when the Endpoint was added to DigitalTwinsInstance.
ProvisioningState This property is required. string
The provisioning state.
AuthenticationType string
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
DeadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
DeadLetterUri string
Dead letter storage URL for identity-based authentication.
EndpointUri string
The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
EntityPath string
The ServiceBus Topic name for identity-based authentication.
Identity ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
PrimaryConnectionString string
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
SecondaryConnectionString string
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
createdTime This property is required. String
Time when the Endpoint was added to DigitalTwinsInstance.
provisioningState This property is required. String
The provisioning state.
authenticationType String
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
deadLetterSecret String
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri String
Dead letter storage URL for identity-based authentication.
endpointUri String
The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath String
The ServiceBus Topic name for identity-based authentication.
identity ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
primaryConnectionString String
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
secondaryConnectionString String
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
createdTime This property is required. string
Time when the Endpoint was added to DigitalTwinsInstance.
provisioningState This property is required. string
The provisioning state.
authenticationType string
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
deadLetterSecret string
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri string
Dead letter storage URL for identity-based authentication.
endpointUri string
The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath string
The ServiceBus Topic name for identity-based authentication.
identity ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
primaryConnectionString string
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
secondaryConnectionString string
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
created_time This property is required. str
Time when the Endpoint was added to DigitalTwinsInstance.
provisioning_state This property is required. str
The provisioning state.
authentication_type str
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
dead_letter_secret str
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
dead_letter_uri str
Dead letter storage URL for identity-based authentication.
endpoint_uri str
The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
entity_path str
The ServiceBus Topic name for identity-based authentication.
identity ManagedIdentityReferenceResponse
Managed identity properties for the endpoint.
primary_connection_string str
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
secondary_connection_string str
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
createdTime This property is required. String
Time when the Endpoint was added to DigitalTwinsInstance.
provisioningState This property is required. String
The provisioning state.
authenticationType String
Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
deadLetterSecret String
Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri String
Dead letter storage URL for identity-based authentication.
endpointUri String
The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath String
The ServiceBus Topic name for identity-based authentication.
identity Property Map
Managed identity properties for the endpoint.
primaryConnectionString String
PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
secondaryConnectionString String
SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:digitaltwins:DigitalTwinsEndpoint myServiceBus /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native