com.pulumi.azure.iot.kotlin.RouteArgs.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.iot.kotlin
import com.pulumi.azure.iot.RouteArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
* Manages an IotHub Route
* > **NOTE:** Routes can be defined either directly on the `azure.iot.IoTHub` resource, or using the `azure.iot.Route` resource - but the two cannot be used together. If both are used against the same IoTHub, spurious changes will occur.
* ## Example Usage
*
* ```typescript
* 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,
* });
* ```
* ```python
* 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=azure.iot.IoTHubSkuArgs(
* 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)
* ```
* ```csharp
* 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,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/iot"
* "github.com/pulumi/pulumi-azure/sdk/v5/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
* }
* return nil
* })
* }
* ```
* ```java
* 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 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());
* }
* }
* ```
* ```yaml
* 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
* ```
*
* ## Import
* IoTHub Route can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:iot/route:Route route1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Devices/iotHubs/hub1/routes/route1
* ```
* @property condition The condition that is evaluated to apply the routing rule. For grammar, see: . Defaults to `true`.
* @property enabled Specifies whether a route is enabled.
* @property endpointNames The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
* @property iothubName The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
* @property name The name of the route. Changing this forces a new resource to be created.
* @property resourceGroupName The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
* @property source The source that the routing rule is to be applied to. Possible values include: `DeviceConnectionStateEvents`, `DeviceJobLifecycleEvents`, `DeviceLifecycleEvents`, `DeviceMessages`, `DigitalTwinChangeEvents`, `Invalid`, `TwinChangeEvents`.
*/
public data class RouteArgs(
public val condition: Output? = null,
public val enabled: Output? = null,
public val endpointNames: Output? = null,
public val iothubName: Output? = null,
public val name: Output? = null,
public val resourceGroupName: Output? = null,
public val source: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.iot.RouteArgs = com.pulumi.azure.iot.RouteArgs.builder()
.condition(condition?.applyValue({ args0 -> args0 }))
.enabled(enabled?.applyValue({ args0 -> args0 }))
.endpointNames(endpointNames?.applyValue({ args0 -> args0 }))
.iothubName(iothubName?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
.source(source?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [RouteArgs].
*/
@PulumiTagMarker
public class RouteArgsBuilder internal constructor() {
private var condition: Output? = null
private var enabled: Output? = null
private var endpointNames: Output? = null
private var iothubName: Output? = null
private var name: Output? = null
private var resourceGroupName: Output? = null
private var source: Output? = null
/**
* @param value The condition that is evaluated to apply the routing rule. For grammar, see: . Defaults to `true`.
*/
@JvmName("hohlohtyinwiwgxw")
public suspend fun condition(`value`: Output) {
this.condition = value
}
/**
* @param value Specifies whether a route is enabled.
*/
@JvmName("ihauryhsrtdkcilr")
public suspend fun enabled(`value`: Output) {
this.enabled = value
}
/**
* @param value The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
*/
@JvmName("fcvqcjbvhurjrcko")
public suspend fun endpointNames(`value`: Output) {
this.endpointNames = value
}
/**
* @param value The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
*/
@JvmName("ghbxrwwclsufqowe")
public suspend fun iothubName(`value`: Output) {
this.iothubName = value
}
/**
* @param value The name of the route. Changing this forces a new resource to be created.
*/
@JvmName("ipiyitcbefppfbyv")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
*/
@JvmName("ldmenobliyfmoyus")
public suspend fun resourceGroupName(`value`: Output) {
this.resourceGroupName = value
}
/**
* @param value The source that the routing rule is to be applied to. Possible values include: `DeviceConnectionStateEvents`, `DeviceJobLifecycleEvents`, `DeviceLifecycleEvents`, `DeviceMessages`, `DigitalTwinChangeEvents`, `Invalid`, `TwinChangeEvents`.
*/
@JvmName("hgmciqdghvydacmq")
public suspend fun source(`value`: Output) {
this.source = value
}
/**
* @param value The condition that is evaluated to apply the routing rule. For grammar, see: . Defaults to `true`.
*/
@JvmName("glnujujklnbdevps")
public suspend fun condition(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.condition = mapped
}
/**
* @param value Specifies whether a route is enabled.
*/
@JvmName("qwaautsfayndjfis")
public suspend fun enabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.enabled = mapped
}
/**
* @param value The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
*/
@JvmName("tejuysxmwsxyjkjg")
public suspend fun endpointNames(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.endpointNames = mapped
}
/**
* @param value The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
*/
@JvmName("vytbvanmwjbqhces")
public suspend fun iothubName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.iothubName = mapped
}
/**
* @param value The name of the route. Changing this forces a new resource to be created.
*/
@JvmName("xcqihtgpurukpojv")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
*/
@JvmName("apmmkptnfyfbrtio")
public suspend fun resourceGroupName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.resourceGroupName = mapped
}
/**
* @param value The source that the routing rule is to be applied to. Possible values include: `DeviceConnectionStateEvents`, `DeviceJobLifecycleEvents`, `DeviceLifecycleEvents`, `DeviceMessages`, `DigitalTwinChangeEvents`, `Invalid`, `TwinChangeEvents`.
*/
@JvmName("eksinvpjepehgcov")
public suspend fun source(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.source = mapped
}
internal fun build(): RouteArgs = RouteArgs(
condition = condition,
enabled = enabled,
endpointNames = endpointNames,
iothubName = iothubName,
name = name,
resourceGroupName = resourceGroupName,
source = source,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy