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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.iot.Enrichment

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an IotHub Enrichment

NOTE: Enrichment can be defined either directly on the azure.iot.IoTHub resource, or using the azure.iot.Enrichment resources - but the two cannot be used together. If both are used against the same IoTHub, spurious changes will occur.

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 exampleAccount = new azure.storage.Account("example", {
    name: "examplestorageaccount",
    resourceGroupName: example.name,
    location: example.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleContainer = new azure.storage.Container("example", {
    name: "example",
    storageAccountName: exampleAccount.name,
    containerAccessType: "private",
});
const exampleIoTHub = new azure.iot.IoTHub("example", {
    name: "exampleIothub",
    resourceGroupName: example.name,
    location: example.location,
    sku: {
        name: "S1",
        capacity: 1,
    },
    tags: {
        purpose: "testing",
    },
});
const exampleEndpointStorageContainer = new azure.iot.EndpointStorageContainer("example", {
    resourceGroupName: example.name,
    iothubId: exampleIoTHub.id,
    name: "example",
    connectionString: exampleAccount.primaryBlobConnectionString,
    batchFrequencyInSeconds: 60,
    maxChunkSizeInBytes: 10485760,
    containerName: exampleContainer.name,
    encoding: "Avro",
    fileNameFormat: "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
});
const exampleRoute = new azure.iot.Route("example", {
    resourceGroupName: example.name,
    iothubName: exampleIoTHub.name,
    name: "example",
    source: "DeviceMessages",
    condition: "true",
    endpointNames: exampleEndpointStorageContainer.name,
    enabled: true,
});
const exampleEnrichment = new azure.iot.Enrichment("example", {
    resourceGroupName: example.name,
    iothubName: exampleIoTHub.name,
    key: "example",
    value: "my value",
    endpointNames: [exampleEndpointStorageContainer.name],
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_account = azure.storage.Account("example",
    name="examplestorageaccount",
    resource_group_name=example.name,
    location=example.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_container = azure.storage.Container("example",
    name="example",
    storage_account_name=example_account.name,
    container_access_type="private")
example_io_t_hub = azure.iot.IoTHub("example",
    name="exampleIothub",
    resource_group_name=example.name,
    location=example.location,
    sku={
        "name": "S1",
        "capacity": 1,
    },
    tags={
        "purpose": "testing",
    })
example_endpoint_storage_container = azure.iot.EndpointStorageContainer("example",
    resource_group_name=example.name,
    iothub_id=example_io_t_hub.id,
    name="example",
    connection_string=example_account.primary_blob_connection_string,
    batch_frequency_in_seconds=60,
    max_chunk_size_in_bytes=10485760,
    container_name=example_container.name,
    encoding="Avro",
    file_name_format="{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}")
example_route = azure.iot.Route("example",
    resource_group_name=example.name,
    iothub_name=example_io_t_hub.name,
    name="example",
    source="DeviceMessages",
    condition="true",
    endpoint_names=example_endpoint_storage_container.name,
    enabled=True)
example_enrichment = azure.iot.Enrichment("example",
    resource_group_name=example.name,
    iothub_name=example_io_t_hub.name,
    key="example",
    value="my value",
    endpoint_names=[example_endpoint_storage_container.name])
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/iot"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
	"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
		}
		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
			Name:                   pulumi.String("examplestorageaccount"),
			ResourceGroupName:      example.Name,
			Location:               example.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		exampleContainer, err := storage.NewContainer(ctx, "example", &storage.ContainerArgs{
			Name:                pulumi.String("example"),
			StorageAccountName:  exampleAccount.Name,
			ContainerAccessType: pulumi.String("private"),
		})
		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("S1"),
				Capacity: pulumi.Int(1),
			},
			Tags: pulumi.StringMap{
				"purpose": pulumi.String("testing"),
			},
		})
		if err != nil {
			return err
		}
		exampleEndpointStorageContainer, err := iot.NewEndpointStorageContainer(ctx, "example", &iot.EndpointStorageContainerArgs{
			ResourceGroupName:       example.Name,
			IothubId:                exampleIoTHub.ID(),
			Name:                    pulumi.String("example"),
			ConnectionString:        exampleAccount.PrimaryBlobConnectionString,
			BatchFrequencyInSeconds: pulumi.Int(60),
			MaxChunkSizeInBytes:     pulumi.Int(10485760),
			ContainerName:           exampleContainer.Name,
			Encoding:                pulumi.String("Avro"),
			FileNameFormat:          pulumi.String("{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}"),
		})
		if err != nil {
			return err
		}
		_, err = iot.NewRoute(ctx, "example", &iot.RouteArgs{
			ResourceGroupName: example.Name,
			IothubName:        exampleIoTHub.Name,
			Name:              pulumi.String("example"),
			Source:            pulumi.String("DeviceMessages"),
			Condition:         pulumi.String("true"),
			EndpointNames:     exampleEndpointStorageContainer.Name,
			Enabled:           pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = iot.NewEnrichment(ctx, "example", &iot.EnrichmentArgs{
			ResourceGroupName: example.Name,
			IothubName:        exampleIoTHub.Name,
			Key:               pulumi.String("example"),
			Value:             pulumi.String("my value"),
			EndpointNames: pulumi.StringArray{
				exampleEndpointStorageContainer.Name,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 exampleAccount = new Azure.Storage.Account("example", new()
    {
        Name = "examplestorageaccount",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
    });

    var exampleContainer = new Azure.Storage.Container("example", new()
    {
        Name = "example",
        StorageAccountName = exampleAccount.Name,
        ContainerAccessType = "private",
    });

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

    var exampleEndpointStorageContainer = new Azure.Iot.EndpointStorageContainer("example", new()
    {
        ResourceGroupName = example.Name,
        IothubId = exampleIoTHub.Id,
        Name = "example",
        ConnectionString = exampleAccount.PrimaryBlobConnectionString,
        BatchFrequencyInSeconds = 60,
        MaxChunkSizeInBytes = 10485760,
        ContainerName = exampleContainer.Name,
        Encoding = "Avro",
        FileNameFormat = "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
    });

    var exampleRoute = new Azure.Iot.Route("example", new()
    {
        ResourceGroupName = example.Name,
        IothubName = exampleIoTHub.Name,
        Name = "example",
        Source = "DeviceMessages",
        Condition = "true",
        EndpointNames = exampleEndpointStorageContainer.Name,
        Enabled = true,
    });

    var exampleEnrichment = new Azure.Iot.Enrichment("example", new()
    {
        ResourceGroupName = example.Name,
        IothubName = exampleIoTHub.Name,
        Key = "example",
        Value = "my value",
        EndpointNames = new[]
        {
            exampleEndpointStorageContainer.Name,
        },
    });

});
Copy
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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.Container;
import com.pulumi.azure.storage.ContainerArgs;
import com.pulumi.azure.iot.IoTHub;
import com.pulumi.azure.iot.IoTHubArgs;
import com.pulumi.azure.iot.inputs.IoTHubSkuArgs;
import com.pulumi.azure.iot.EndpointStorageContainer;
import com.pulumi.azure.iot.EndpointStorageContainerArgs;
import com.pulumi.azure.iot.Route;
import com.pulumi.azure.iot.RouteArgs;
import com.pulumi.azure.iot.Enrichment;
import com.pulumi.azure.iot.EnrichmentArgs;
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 exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("examplestorageaccount")
            .resourceGroupName(example.name())
            .location(example.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());

        var exampleContainer = new Container("exampleContainer", ContainerArgs.builder()
            .name("example")
            .storageAccountName(exampleAccount.name())
            .containerAccessType("private")
            .build());

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

        var exampleEndpointStorageContainer = new EndpointStorageContainer("exampleEndpointStorageContainer", EndpointStorageContainerArgs.builder()
            .resourceGroupName(example.name())
            .iothubId(exampleIoTHub.id())
            .name("example")
            .connectionString(exampleAccount.primaryBlobConnectionString())
            .batchFrequencyInSeconds(60)
            .maxChunkSizeInBytes(10485760)
            .containerName(exampleContainer.name())
            .encoding("Avro")
            .fileNameFormat("{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}")
            .build());

        var exampleRoute = new Route("exampleRoute", RouteArgs.builder()
            .resourceGroupName(example.name())
            .iothubName(exampleIoTHub.name())
            .name("example")
            .source("DeviceMessages")
            .condition("true")
            .endpointNames(exampleEndpointStorageContainer.name())
            .enabled(true)
            .build());

        var exampleEnrichment = new Enrichment("exampleEnrichment", EnrichmentArgs.builder()
            .resourceGroupName(example.name())
            .iothubName(exampleIoTHub.name())
            .key("example")
            .value("my value")
            .endpointNames(exampleEndpointStorageContainer.name())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: examplestorageaccount
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountTier: Standard
      accountReplicationType: LRS
  exampleContainer:
    type: azure:storage:Container
    name: example
    properties:
      name: example
      storageAccountName: ${exampleAccount.name}
      containerAccessType: private
  exampleIoTHub:
    type: azure:iot:IoTHub
    name: example
    properties:
      name: exampleIothub
      resourceGroupName: ${example.name}
      location: ${example.location}
      sku:
        name: S1
        capacity: '1'
      tags:
        purpose: testing
  exampleEndpointStorageContainer:
    type: azure:iot:EndpointStorageContainer
    name: example
    properties:
      resourceGroupName: ${example.name}
      iothubId: ${exampleIoTHub.id}
      name: example
      connectionString: ${exampleAccount.primaryBlobConnectionString}
      batchFrequencyInSeconds: 60
      maxChunkSizeInBytes: 1.048576e+07
      containerName: ${exampleContainer.name}
      encoding: Avro
      fileNameFormat: '{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}'
  exampleRoute:
    type: azure:iot:Route
    name: example
    properties:
      resourceGroupName: ${example.name}
      iothubName: ${exampleIoTHub.name}
      name: example
      source: DeviceMessages
      condition: 'true'
      endpointNames: ${exampleEndpointStorageContainer.name}
      enabled: true
  exampleEnrichment:
    type: azure:iot:Enrichment
    name: example
    properties:
      resourceGroupName: ${example.name}
      iothubName: ${exampleIoTHub.name}
      key: example
      value: my value
      endpointNames:
        - ${exampleEndpointStorageContainer.name}
Copy

Create Enrichment Resource

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

Constructor syntax

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

@overload
def Enrichment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               endpoint_names: Optional[Sequence[str]] = None,
               iothub_name: Optional[str] = None,
               key: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               value: Optional[str] = None)
func NewEnrichment(ctx *Context, name string, args EnrichmentArgs, opts ...ResourceOption) (*Enrichment, error)
public Enrichment(string name, EnrichmentArgs args, CustomResourceOptions? opts = null)
public Enrichment(String name, EnrichmentArgs args)
public Enrichment(String name, EnrichmentArgs args, CustomResourceOptions options)

type: azure:iot:Enrichment
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. EnrichmentArgs
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. EnrichmentArgs
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. EnrichmentArgs
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. EnrichmentArgs
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. EnrichmentArgs
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 enrichmentResource = new Azure.Iot.Enrichment("enrichmentResource", new()
{
    EndpointNames = new[]
    {
        "string",
    },
    IothubName = "string",
    Key = "string",
    ResourceGroupName = "string",
    Value = "string",
});
Copy
example, err := iot.NewEnrichment(ctx, "enrichmentResource", &iot.EnrichmentArgs{
	EndpointNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	IothubName:        pulumi.String("string"),
	Key:               pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Value:             pulumi.String("string"),
})
Copy
var enrichmentResource = new Enrichment("enrichmentResource", EnrichmentArgs.builder()
    .endpointNames("string")
    .iothubName("string")
    .key("string")
    .resourceGroupName("string")
    .value("string")
    .build());
Copy
enrichment_resource = azure.iot.Enrichment("enrichmentResource",
    endpoint_names=["string"],
    iothub_name="string",
    key="string",
    resource_group_name="string",
    value="string")
Copy
const enrichmentResource = new azure.iot.Enrichment("enrichmentResource", {
    endpointNames: ["string"],
    iothubName: "string",
    key: "string",
    resourceGroupName: "string",
    value: "string",
});
Copy
type: azure:iot:Enrichment
properties:
    endpointNames:
        - string
    iothubName: string
    key: string
    resourceGroupName: string
    value: string
Copy

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

EndpointNames This property is required. List<string>
The list of endpoints which will be enriched.
IothubName
This property is required.
Changes to this property will trigger replacement.
string
The IoTHub name of the enrichment. Changing this forces a new resource to be created.
Key
This property is required.
Changes to this property will trigger replacement.
string
The key of the enrichment. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group under which the IoTHub resource is created. Changing this forces a new resource to be created.
Value This property is required. string
The value of the enrichment. Value can be any static string, the name of the IoT hub sending the message (use $iothubname) or information from the device twin (ex: $twin.tags.latitude)
EndpointNames This property is required. []string
The list of endpoints which will be enriched.
IothubName
This property is required.
Changes to this property will trigger replacement.
string
The IoTHub name of the enrichment. Changing this forces a new resource to be created.
Key
This property is required.
Changes to this property will trigger replacement.
string
The key of the enrichment. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group under which the IoTHub resource is created. Changing this forces a new resource to be created.
Value This property is required. string
The value of the enrichment. Value can be any static string, the name of the IoT hub sending the message (use $iothubname) or information from the device twin (ex: $twin.tags.latitude)
endpointNames This property is required. List<String>
The list of endpoints which will be enriched.
iothubName
This property is required.
Changes to this property will trigger replacement.
String
The IoTHub name of the enrichment. Changing this forces a new resource to be created.
key
This property is required.
Changes to this property will trigger replacement.
String
The key of the enrichment. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group under which the IoTHub resource is created. Changing this forces a new resource to be created.
value This property is required. String
The value of the enrichment. Value can be any static string, the name of the IoT hub sending the message (use $iothubname) or information from the device twin (ex: $twin.tags.latitude)
endpointNames This property is required. string[]
The list of endpoints which will be enriched.
iothubName
This property is required.
Changes to this property will trigger replacement.
string
The IoTHub name of the enrichment. Changing this forces a new resource to be created.
key
This property is required.
Changes to this property will trigger replacement.
string
The key of the enrichment. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group under which the IoTHub resource is created. Changing this forces a new resource to be created.
value This property is required. string
The value of the enrichment. Value can be any static string, the name of the IoT hub sending the message (use $iothubname) or information from the device twin (ex: $twin.tags.latitude)
endpoint_names This property is required. Sequence[str]
The list of endpoints which will be enriched.
iothub_name
This property is required.
Changes to this property will trigger replacement.
str
The IoTHub name of the enrichment. Changing this forces a new resource to be created.
key
This property is required.
Changes to this property will trigger replacement.
str
The key of the enrichment. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group under which the IoTHub resource is created. Changing this forces a new resource to be created.
value This property is required. str
The value of the enrichment. Value can be any static string, the name of the IoT hub sending the message (use $iothubname) or information from the device twin (ex: $twin.tags.latitude)
endpointNames This property is required. List<String>
The list of endpoints which will be enriched.
iothubName
This property is required.
Changes to this property will trigger replacement.
String
The IoTHub name of the enrichment. Changing this forces a new resource to be created.
key
This property is required.
Changes to this property will trigger replacement.
String
The key of the enrichment. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group under which the IoTHub resource is created. Changing this forces a new resource to be created.
value This property is required. String
The value of the enrichment. Value can be any static string, the name of the IoT hub sending the message (use $iothubname) or information from the device twin (ex: $twin.tags.latitude)

Outputs

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

Get an existing Enrichment 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?: EnrichmentState, opts?: CustomResourceOptions): Enrichment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        endpoint_names: Optional[Sequence[str]] = None,
        iothub_name: Optional[str] = None,
        key: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        value: Optional[str] = None) -> Enrichment
func GetEnrichment(ctx *Context, name string, id IDInput, state *EnrichmentState, opts ...ResourceOption) (*Enrichment, error)
public static Enrichment Get(string name, Input<string> id, EnrichmentState? state, CustomResourceOptions? opts = null)
public static Enrichment get(String name, Output<String> id, EnrichmentState state, CustomResourceOptions options)
resources:  _:    type: azure:iot:Enrichment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
EndpointNames List<string>
The list of endpoints which will be enriched.
IothubName Changes to this property will trigger replacement. string
The IoTHub name of the enrichment. Changing this forces a new resource to be created.
Key Changes to this property will trigger replacement. string
The key of the enrichment. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group under which the IoTHub resource is created. Changing this forces a new resource to be created.
Value string
The value of the enrichment. Value can be any static string, the name of the IoT hub sending the message (use $iothubname) or information from the device twin (ex: $twin.tags.latitude)
EndpointNames []string
The list of endpoints which will be enriched.
IothubName Changes to this property will trigger replacement. string
The IoTHub name of the enrichment. Changing this forces a new resource to be created.
Key Changes to this property will trigger replacement. string
The key of the enrichment. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group under which the IoTHub resource is created. Changing this forces a new resource to be created.
Value string
The value of the enrichment. Value can be any static string, the name of the IoT hub sending the message (use $iothubname) or information from the device twin (ex: $twin.tags.latitude)
endpointNames List<String>
The list of endpoints which will be enriched.
iothubName Changes to this property will trigger replacement. String
The IoTHub name of the enrichment. Changing this forces a new resource to be created.
key Changes to this property will trigger replacement. String
The key of the enrichment. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group under which the IoTHub resource is created. Changing this forces a new resource to be created.
value String
The value of the enrichment. Value can be any static string, the name of the IoT hub sending the message (use $iothubname) or information from the device twin (ex: $twin.tags.latitude)
endpointNames string[]
The list of endpoints which will be enriched.
iothubName Changes to this property will trigger replacement. string
The IoTHub name of the enrichment. Changing this forces a new resource to be created.
key Changes to this property will trigger replacement. string
The key of the enrichment. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group under which the IoTHub resource is created. Changing this forces a new resource to be created.
value string
The value of the enrichment. Value can be any static string, the name of the IoT hub sending the message (use $iothubname) or information from the device twin (ex: $twin.tags.latitude)
endpoint_names Sequence[str]
The list of endpoints which will be enriched.
iothub_name Changes to this property will trigger replacement. str
The IoTHub name of the enrichment. Changing this forces a new resource to be created.
key Changes to this property will trigger replacement. str
The key of the enrichment. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group under which the IoTHub resource is created. Changing this forces a new resource to be created.
value str
The value of the enrichment. Value can be any static string, the name of the IoT hub sending the message (use $iothubname) or information from the device twin (ex: $twin.tags.latitude)
endpointNames List<String>
The list of endpoints which will be enriched.
iothubName Changes to this property will trigger replacement. String
The IoTHub name of the enrichment. Changing this forces a new resource to be created.
key Changes to this property will trigger replacement. String
The key of the enrichment. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group under which the IoTHub resource is created. Changing this forces a new resource to be created.
value String
The value of the enrichment. Value can be any static string, the name of the IoT hub sending the message (use $iothubname) or information from the device twin (ex: $twin.tags.latitude)

Import

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

$ pulumi import azure:iot/enrichment:Enrichment enrichment1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Devices/iotHubs/hub1/enrichments/enrichment1
Copy

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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure