Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. iot
  5. EndpointEventhub

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

azure.iot.EndpointEventhub

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an IotHub EventHub Endpoint

    NOTE: Endpoints can be defined either directly on the azure.iot.IoTHub resource, or using the azurerm_iothub_endpoint_* resources - but the two ways of defining the endpoints cannot be used together. If both are used against the same IoTHub, spurious changes will occur. Also, defining a azurerm_iothub_endpoint_* resource and another endpoint of a different type directly on the azure.iot.IoTHub resource is not supported.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("example", {
    name: "exampleEventHubNamespace",
    location: example.location,
    resourceGroupName: example.name,
    sku: "Basic",
});
const exampleEventHub = new azure.eventhub.EventHub("example", {
    name: "exampleEventHub",
    namespaceName: exampleEventHubNamespace.name,
    resourceGroupName: example.name,
    partitionCount: 2,
    messageRetention: 1,
});
const exampleAuthorizationRule = new azure.eventhub.AuthorizationRule("example", {
    name: "exampleRule",
    namespaceName: exampleEventHubNamespace.name,
    eventhubName: exampleEventHub.name,
    resourceGroupName: example.name,
    listen: false,
    send: true,
    manage: false,
});
const exampleIoTHub = new azure.iot.IoTHub("example", {
    name: "exampleIothub",
    resourceGroupName: example.name,
    location: example.location,
    sku: {
        name: "B1",
        capacity: 1,
    },
    tags: {
        purpose: "example",
    },
});
const exampleEndpointEventhub = new azure.iot.EndpointEventhub("example", {
    resourceGroupName: example.name,
    iothubId: exampleIoTHub.id,
    name: "example",
    connectionString: exampleAuthorizationRule.primaryConnectionString,
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_event_hub_namespace = azure.eventhub.EventHubNamespace("example",
    name="exampleEventHubNamespace",
    location=example.location,
    resource_group_name=example.name,
    sku="Basic")
example_event_hub = azure.eventhub.EventHub("example",
    name="exampleEventHub",
    namespace_name=example_event_hub_namespace.name,
    resource_group_name=example.name,
    partition_count=2,
    message_retention=1)
example_authorization_rule = azure.eventhub.AuthorizationRule("example",
    name="exampleRule",
    namespace_name=example_event_hub_namespace.name,
    eventhub_name=example_event_hub.name,
    resource_group_name=example.name,
    listen=False,
    send=True,
    manage=False)
example_io_t_hub = azure.iot.IoTHub("example",
    name="exampleIothub",
    resource_group_name=example.name,
    location=example.location,
    sku={
        "name": "B1",
        "capacity": 1,
    },
    tags={
        "purpose": "example",
    })
example_endpoint_eventhub = azure.iot.EndpointEventhub("example",
    resource_group_name=example.name,
    iothub_id=example_io_t_hub.id,
    name="example",
    connection_string=example_authorization_rule.primary_connection_string)

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/eventhub"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/iot"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleEventHubNamespace, err := eventhub.NewEventHubNamespace(ctx, "example", &eventhub.EventHubNamespaceArgs{
			Name:              pulumi.String("exampleEventHubNamespace"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku:               pulumi.String("Basic"),
		})
		if err != nil {
			return err
		}
		exampleEventHub, err := eventhub.NewEventHub(ctx, "example", &eventhub.EventHubArgs{
			Name:              pulumi.String("exampleEventHub"),
			NamespaceName:     exampleEventHubNamespace.Name,
			ResourceGroupName: example.Name,
			PartitionCount:    pulumi.Int(2),
			MessageRetention:  pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		exampleAuthorizationRule, err := eventhub.NewAuthorizationRule(ctx, "example", &eventhub.AuthorizationRuleArgs{
			Name:              pulumi.String("exampleRule"),
			NamespaceName:     exampleEventHubNamespace.Name,
			EventhubName:      exampleEventHub.Name,
			ResourceGroupName: example.Name,
			Listen:            pulumi.Bool(false),
			Send:              pulumi.Bool(true),
			Manage:            pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		exampleIoTHub, err := iot.NewIoTHub(ctx, "example", &iot.IoTHubArgs{
			Name:              pulumi.String("exampleIothub"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			Sku: &iot.IoTHubSkuArgs{
				Name:     pulumi.String("B1"),
				Capacity: pulumi.Int(1),
			},
			Tags: pulumi.StringMap{
				"purpose": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		_, err = iot.NewEndpointEventhub(ctx, "example", &iot.EndpointEventhubArgs{
			ResourceGroupName: example.Name,
			IothubId:          exampleIoTHub.ID(),
			Name:              pulumi.String("example"),
			ConnectionString:  exampleAuthorizationRule.PrimaryConnectionString,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

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

    var exampleEventHubNamespace = new Azure.EventHub.EventHubNamespace("example", new()
    {
        Name = "exampleEventHubNamespace",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = "Basic",
    });

    var exampleEventHub = new Azure.EventHub.EventHub("example", new()
    {
        Name = "exampleEventHub",
        NamespaceName = exampleEventHubNamespace.Name,
        ResourceGroupName = example.Name,
        PartitionCount = 2,
        MessageRetention = 1,
    });

    var exampleAuthorizationRule = new Azure.EventHub.AuthorizationRule("example", new()
    {
        Name = "exampleRule",
        NamespaceName = exampleEventHubNamespace.Name,
        EventhubName = exampleEventHub.Name,
        ResourceGroupName = example.Name,
        Listen = false,
        Send = true,
        Manage = false,
    });

    var exampleIoTHub = new Azure.Iot.IoTHub("example", new()
    {
        Name = "exampleIothub",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
        {
            Name = "B1",
            Capacity = 1,
        },
        Tags = 
        {
            { "purpose", "example" },
        },
    });

    var exampleEndpointEventhub = new Azure.Iot.EndpointEventhub("example", new()
    {
        ResourceGroupName = example.Name,
        IothubId = exampleIoTHub.Id,
        Name = "example",
        ConnectionString = exampleAuthorizationRule.PrimaryConnectionString,
    });

});

    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.eventhub.EventHubNamespace;
import com.pulumi.azure.eventhub.EventHubNamespaceArgs;
import com.pulumi.azure.eventhub.EventHub;
import com.pulumi.azure.eventhub.EventHubArgs;
import com.pulumi.azure.eventhub.AuthorizationRule;
import com.pulumi.azure.eventhub.AuthorizationRuleArgs;
import com.pulumi.azure.iot.IoTHub;
import com.pulumi.azure.iot.IoTHubArgs;
import com.pulumi.azure.iot.inputs.IoTHubSkuArgs;
import com.pulumi.azure.iot.EndpointEventhub;
import com.pulumi.azure.iot.EndpointEventhubArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleEventHubNamespace = new EventHubNamespace("exampleEventHubNamespace", EventHubNamespaceArgs.builder()
            .name("exampleEventHubNamespace")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku("Basic")
            .build());

        var exampleEventHub = new EventHub("exampleEventHub", EventHubArgs.builder()
            .name("exampleEventHub")
            .namespaceName(exampleEventHubNamespace.name())
            .resourceGroupName(example.name())
            .partitionCount(2)
            .messageRetention(1)
            .build());

        var exampleAuthorizationRule = new AuthorizationRule("exampleAuthorizationRule", AuthorizationRuleArgs.builder()
            .name("exampleRule")
            .namespaceName(exampleEventHubNamespace.name())
            .eventhubName(exampleEventHub.name())
            .resourceGroupName(example.name())
            .listen(false)
            .send(true)
            .manage(false)
            .build());

        var exampleIoTHub = new IoTHub("exampleIoTHub", IoTHubArgs.builder()
            .name("exampleIothub")
            .resourceGroupName(example.name())
            .location(example.location())
            .sku(IoTHubSkuArgs.builder()
                .name("B1")
                .capacity("1")
                .build())
            .tags(Map.of("purpose", "example"))
            .build());

        var exampleEndpointEventhub = new EndpointEventhub("exampleEndpointEventhub", EndpointEventhubArgs.builder()
            .resourceGroupName(example.name())
            .iothubId(exampleIoTHub.id())
            .name("example")
            .connectionString(exampleAuthorizationRule.primaryConnectionString())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleEventHubNamespace:
    type: azure:eventhub:EventHubNamespace
    name: example
    properties:
      name: exampleEventHubNamespace
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku: Basic
  exampleEventHub:
    type: azure:eventhub:EventHub
    name: example
    properties:
      name: exampleEventHub
      namespaceName: ${exampleEventHubNamespace.name}
      resourceGroupName: ${example.name}
      partitionCount: 2
      messageRetention: 1
  exampleAuthorizationRule:
    type: azure:eventhub:AuthorizationRule
    name: example
    properties:
      name: exampleRule
      namespaceName: ${exampleEventHubNamespace.name}
      eventhubName: ${exampleEventHub.name}
      resourceGroupName: ${example.name}
      listen: false
      send: true
      manage: false
  exampleIoTHub:
    type: azure:iot:IoTHub
    name: example
    properties:
      name: exampleIothub
      resourceGroupName: ${example.name}
      location: ${example.location}
      sku:
        name: B1
        capacity: '1'
      tags:
        purpose: example
  exampleEndpointEventhub:
    type: azure:iot:EndpointEventhub
    name: example
    properties:
      resourceGroupName: ${example.name}
      iothubId: ${exampleIoTHub.id}
      name: example
      connectionString: ${exampleAuthorizationRule.primaryConnectionString}

    Create EndpointEventhub Resource

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

    Constructor syntax

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

@overload
def EndpointEventhub(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     iothub_id: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     authentication_type: Optional[str] = None,
                     connection_string: Optional[str] = None,
                     endpoint_uri: Optional[str] = None,
                     entity_path: Optional[str] = None,
                     identity_id: Optional[str] = None,
                     name: Optional[str] = None)
    func NewEndpointEventhub(ctx *Context, name string, args EndpointEventhubArgs, opts ...ResourceOption) (*EndpointEventhub, error)
    public EndpointEventhub(string name, EndpointEventhubArgs args, CustomResourceOptions? opts = null)
    public EndpointEventhub(String name, EndpointEventhubArgs args)
public EndpointEventhub(String name, EndpointEventhubArgs args, CustomResourceOptions options)

    type: azure:iot:EndpointEventhub
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EndpointEventhubArgs
    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 EndpointEventhubArgs
    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 EndpointEventhubArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EndpointEventhubArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EndpointEventhubArgs
    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 endpointEventhubResource = new Azure.Iot.EndpointEventhub("endpointEventhubResource", new()
{
    IothubId = "string",
    ResourceGroupName = "string",
    AuthenticationType = "string",
    ConnectionString = "string",
    EndpointUri = "string",
    EntityPath = "string",
    IdentityId = "string",
    Name = "string",
});

    example, err := iot.NewEndpointEventhub(ctx, "endpointEventhubResource", &iot.EndpointEventhubArgs{
	IothubId:           pulumi.String("string"),
	ResourceGroupName:  pulumi.String("string"),
	AuthenticationType: pulumi.String("string"),
	ConnectionString:   pulumi.String("string"),
	EndpointUri:        pulumi.String("string"),
	EntityPath:         pulumi.String("string"),
	IdentityId:         pulumi.String("string"),
	Name:               pulumi.String("string"),
})

    var endpointEventhubResource = new EndpointEventhub("endpointEventhubResource", EndpointEventhubArgs.builder()
    .iothubId("string")
    .resourceGroupName("string")
    .authenticationType("string")
    .connectionString("string")
    .endpointUri("string")
    .entityPath("string")
    .identityId("string")
    .name("string")
    .build());

    endpoint_eventhub_resource = azure.iot.EndpointEventhub("endpointEventhubResource",
    iothub_id="string",
    resource_group_name="string",
    authentication_type="string",
    connection_string="string",
    endpoint_uri="string",
    entity_path="string",
    identity_id="string",
    name="string")

    const endpointEventhubResource = new azure.iot.EndpointEventhub("endpointEventhubResource", {
    iothubId: "string",
    resourceGroupName: "string",
    authenticationType: "string",
    connectionString: "string",
    endpointUri: "string",
    entityPath: "string",
    identityId: "string",
    name: "string",
});

    type: azure:iot:EndpointEventhub
properties:
    authenticationType: string
    connectionString: string
    endpointUri: string
    entityPath: string
    identityId: string
    iothubId: string
    name: string
    resourceGroupName: string

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

    IothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the Event Hub has been created. Changing this forces a new resource to be created.
    AuthenticationType string
    Type used to authenticate against the Event Hub endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    ConnectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    EndpointUri string
    URI of the Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    EntityPath string
    Name of the Event Hub. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    IdentityId string

    ID of the User Managed Identity used to authenticate against the Event Hub endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    Name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    IothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the Event Hub has been created. Changing this forces a new resource to be created.
    AuthenticationType string
    Type used to authenticate against the Event Hub endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    ConnectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    EndpointUri string
    URI of the Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    EntityPath string
    Name of the Event Hub. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    IdentityId string

    ID of the User Managed Identity used to authenticate against the Event Hub endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    Name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    iothubId String
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the Event Hub has been created. Changing this forces a new resource to be created.
    authenticationType String
    Type used to authenticate against the Event Hub endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString String
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpointUri String
    URI of the Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entityPath String
    Name of the Event Hub. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identityId String

    ID of the User Managed Identity used to authenticate against the Event Hub endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    name String
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    iothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group under which the Event Hub has been created. Changing this forces a new resource to be created.
    authenticationType string
    Type used to authenticate against the Event Hub endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpointUri string
    URI of the Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entityPath string
    Name of the Event Hub. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identityId string

    ID of the User Managed Identity used to authenticate against the Event Hub endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    iothub_id str
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group under which the Event Hub has been created. Changing this forces a new resource to be created.
    authentication_type str
    Type used to authenticate against the Event Hub endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connection_string str
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpoint_uri str
    URI of the Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entity_path str
    Name of the Event Hub. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identity_id str

    ID of the User Managed Identity used to authenticate against the Event Hub endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    name str
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    iothubId String
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the Event Hub has been created. Changing this forces a new resource to be created.
    authenticationType String
    Type used to authenticate against the Event Hub endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString String
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpointUri String
    URI of the Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entityPath String
    Name of the Event Hub. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identityId String

    ID of the User Managed Identity used to authenticate against the Event Hub endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    name String
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EndpointEventhub Resource

    Get an existing EndpointEventhub 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?: EndpointEventhubState, opts?: CustomResourceOptions): EndpointEventhub
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication_type: Optional[str] = None,
        connection_string: Optional[str] = None,
        endpoint_uri: Optional[str] = None,
        entity_path: Optional[str] = None,
        identity_id: Optional[str] = None,
        iothub_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None) -> EndpointEventhub
    func GetEndpointEventhub(ctx *Context, name string, id IDInput, state *EndpointEventhubState, opts ...ResourceOption) (*EndpointEventhub, error)
    public static EndpointEventhub Get(string name, Input<string> id, EndpointEventhubState? state, CustomResourceOptions? opts = null)
    public static EndpointEventhub get(String name, Output<String> id, EndpointEventhubState 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:
    AuthenticationType string
    Type used to authenticate against the Event Hub endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    ConnectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    EndpointUri string
    URI of the Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    EntityPath string
    Name of the Event Hub. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    IdentityId string

    ID of the User Managed Identity used to authenticate against the Event Hub endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    IothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    Name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the Event Hub has been created. Changing this forces a new resource to be created.
    AuthenticationType string
    Type used to authenticate against the Event Hub endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    ConnectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    EndpointUri string
    URI of the Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    EntityPath string
    Name of the Event Hub. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    IdentityId string

    ID of the User Managed Identity used to authenticate against the Event Hub endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    IothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    Name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the Event Hub has been created. Changing this forces a new resource to be created.
    authenticationType String
    Type used to authenticate against the Event Hub endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString String
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpointUri String
    URI of the Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entityPath String
    Name of the Event Hub. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identityId String

    ID of the User Managed Identity used to authenticate against the Event Hub endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    iothubId String
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    name String
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the Event Hub has been created. Changing this forces a new resource to be created.
    authenticationType string
    Type used to authenticate against the Event Hub endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpointUri string
    URI of the Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entityPath string
    Name of the Event Hub. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identityId string

    ID of the User Managed Identity used to authenticate against the Event Hub endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    iothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group under which the Event Hub has been created. Changing this forces a new resource to be created.
    authentication_type str
    Type used to authenticate against the Event Hub endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connection_string str
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpoint_uri str
    URI of the Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entity_path str
    Name of the Event Hub. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identity_id str

    ID of the User Managed Identity used to authenticate against the Event Hub endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    iothub_id str
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    name str
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group under which the Event Hub has been created. Changing this forces a new resource to be created.
    authenticationType String
    Type used to authenticate against the Event Hub endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString String
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    endpointUri String
    URI of the Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    entityPath String
    Name of the Event Hub. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    identityId String

    ID of the User Managed Identity used to authenticate against the Event Hub endpoint.

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the Iot Hub. If not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    iothubId String
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    name String
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the Event Hub has been created. Changing this forces a new resource to be created.

    Import

    IoTHub EventHub Endpoint can be imported using the resource id, e.g.

    $ pulumi import azure:iot/endpointEventhub:EndpointEventhub eventhub1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Devices/iotHubs/hub1/endpoints/eventhub_endpoint1

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-azure