We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
Manages an IotHub
NOTE: Endpoints can be defined either directly on the
azure.iot.IoTHubresource, or using theazurerm_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 aazurerm_iothub_endpoint_*resource and another endpoint of a different type directly on theazure.iot.IoTHubresource is not supported.
NOTE: Routes can be defined either directly on the
azure.iot.IoTHubresource, or using theazure.iot.Routeresource - but the two cannot be used together. If both are used against the same IoTHub, spurious changes will occur.
NOTE: Enrichments can be defined either directly on the
azure.iot.IoTHubresource, or using theazure.iot.Enrichmentresource - but the two cannot be used together. If both are used against the same IoTHub, spurious changes will occur.
NOTE: Fallback route can be defined either directly on the
azure.iot.IoTHubresource, or using theazure.iot.FallbackRouteresource - but the two cannot be used together. If both are used against the same IoTHub, spurious changes will occur.
Example Usage
using Pulumi;
using Azure = Pulumi.Azure;
class MyStack : Stack
{
public MyStack()
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
{
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
});
var exampleContainer = new Azure.Storage.Container("exampleContainer", new Azure.Storage.ContainerArgs
{
StorageAccountName = exampleAccount.Name,
ContainerAccessType = "private",
});
var exampleEventHubNamespace = new Azure.EventHub.EventHubNamespace("exampleEventHubNamespace", new Azure.EventHub.EventHubNamespaceArgs
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
Sku = "Basic",
});
var exampleEventHub = new Azure.EventHub.EventHub("exampleEventHub", new Azure.EventHub.EventHubArgs
{
ResourceGroupName = exampleResourceGroup.Name,
NamespaceName = exampleEventHubNamespace.Name,
PartitionCount = 2,
MessageRetention = 1,
});
var exampleAuthorizationRule = new Azure.EventHub.AuthorizationRule("exampleAuthorizationRule", new Azure.EventHub.AuthorizationRuleArgs
{
ResourceGroupName = exampleResourceGroup.Name,
NamespaceName = exampleEventHubNamespace.Name,
EventhubName = exampleEventHub.Name,
Send = true,
});
var exampleIoTHub = new Azure.Iot.IoTHub("exampleIoTHub", new Azure.Iot.IoTHubArgs
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
{
Name = "S1",
Capacity = 1,
},
Endpoints =
{
new Azure.Iot.Inputs.IoTHubEndpointArgs
{
Type = "AzureIotHub.StorageContainer",
ConnectionString = exampleAccount.PrimaryBlobConnectionString,
Name = "export",
BatchFrequencyInSeconds = 60,
MaxChunkSizeInBytes = 10485760,
ContainerName = exampleContainer.Name,
Encoding = "Avro",
FileNameFormat = "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
},
new Azure.Iot.Inputs.IoTHubEndpointArgs
{
Type = "AzureIotHub.EventHub",
ConnectionString = exampleAuthorizationRule.PrimaryConnectionString,
Name = "export2",
},
},
Routes =
{
new Azure.Iot.Inputs.IoTHubRouteArgs
{
Name = "export",
Source = "DeviceMessages",
Condition = "true",
EndpointNames =
{
"export",
},
Enabled = true,
},
new Azure.Iot.Inputs.IoTHubRouteArgs
{
Name = "export2",
Source = "DeviceMessages",
Condition = "true",
EndpointNames =
{
"export2",
},
Enabled = true,
},
},
Enrichments =
{
new Azure.Iot.Inputs.IoTHubEnrichmentArgs
{
Key = "tenant",
Value = "$twin.tags.Tenant",
EndpointNames =
{
"export",
"export2",
},
},
},
CloudToDevice = new Azure.Iot.Inputs.IoTHubCloudToDeviceArgs
{
MaxDeliveryCount = 30,
DefaultTtl = "PT1H",
Feedbacks =
{
new Azure.Iot.Inputs.IoTHubCloudToDeviceFeedbackArgs
{
TimeToLive = "PT1H10M",
MaxDeliveryCount = 15,
LockDuration = "PT30S",
},
},
},
Tags =
{
{ "purpose", "testing" },
},
});
}
}
package main
import (
"fmt"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/eventhub"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/iot"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
AccountTier: pulumi.String("Standard"),
AccountReplicationType: pulumi.String("LRS"),
})
if err != nil {
return err
}
exampleContainer, err := storage.NewContainer(ctx, "exampleContainer", &storage.ContainerArgs{
StorageAccountName: exampleAccount.Name,
ContainerAccessType: pulumi.String("private"),
})
if err != nil {
return err
}
exampleEventHubNamespace, err := eventhub.NewEventHubNamespace(ctx, "exampleEventHubNamespace", &eventhub.EventHubNamespaceArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
Sku: pulumi.String("Basic"),
})
if err != nil {
return err
}
exampleEventHub, err := eventhub.NewEventHub(ctx, "exampleEventHub", &eventhub.EventHubArgs{
ResourceGroupName: exampleResourceGroup.Name,
NamespaceName: exampleEventHubNamespace.Name,
PartitionCount: pulumi.Int(2),
MessageRetention: pulumi.Int(1),
})
if err != nil {
return err
}
exampleAuthorizationRule, err := eventhub.NewAuthorizationRule(ctx, "exampleAuthorizationRule", &eventhub.AuthorizationRuleArgs{
ResourceGroupName: exampleResourceGroup.Name,
NamespaceName: exampleEventHubNamespace.Name,
EventhubName: exampleEventHub.Name,
Send: pulumi.Bool(true),
})
if err != nil {
return err
}
_, err = iot.NewIoTHub(ctx, "exampleIoTHub", &iot.IoTHubArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
Sku: &iot.IoTHubSkuArgs{
Name: pulumi.String("S1"),
Capacity: pulumi.Int(1),
},
Endpoints: iot.IoTHubEndpointArray{
&iot.IoTHubEndpointArgs{
Type: pulumi.String("AzureIotHub.StorageContainer"),
ConnectionString: exampleAccount.PrimaryBlobConnectionString,
Name: pulumi.String("export"),
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}"),
},
&iot.IoTHubEndpointArgs{
Type: pulumi.String("AzureIotHub.EventHub"),
ConnectionString: exampleAuthorizationRule.PrimaryConnectionString,
Name: pulumi.String("export2"),
},
},
Routes: iot.IoTHubRouteArray{
&iot.IoTHubRouteArgs{
Name: pulumi.String("export"),
Source: pulumi.String("DeviceMessages"),
Condition: pulumi.String("true"),
EndpointNames: pulumi.StringArray{
pulumi.String("export"),
},
Enabled: pulumi.Bool(true),
},
&iot.IoTHubRouteArgs{
Name: pulumi.String("export2"),
Source: pulumi.String("DeviceMessages"),
Condition: pulumi.String("true"),
EndpointNames: pulumi.StringArray{
pulumi.String("export2"),
},
Enabled: pulumi.Bool(true),
},
},
Enrichments: iot.IoTHubEnrichmentArray{
&iot.IoTHubEnrichmentArgs{
Key: pulumi.String("tenant"),
Value: pulumi.String(fmt.Sprintf("%v%v", "$", "twin.tags.Tenant")),
EndpointNames: pulumi.StringArray{
pulumi.String("export"),
pulumi.String("export2"),
},
},
},
CloudToDevice: &iot.IoTHubCloudToDeviceArgs{
MaxDeliveryCount: pulumi.Int(30),
DefaultTtl: pulumi.String("PT1H"),
Feedbacks: iot.IoTHubCloudToDeviceFeedbackArray{
&iot.IoTHubCloudToDeviceFeedbackArgs{
TimeToLive: pulumi.String("PT1H10M"),
MaxDeliveryCount: pulumi.Int(15),
LockDuration: pulumi.String("PT30S"),
},
},
},
Tags: pulumi.StringMap{
"purpose": pulumi.String("testing"),
},
})
if err != nil {
return err
}
return nil
})
}
Example coming soon!
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
accountTier: "Standard",
accountReplicationType: "LRS",
});
const exampleContainer = new azure.storage.Container("exampleContainer", {
storageAccountName: exampleAccount.name,
containerAccessType: "private",
});
const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("exampleEventHubNamespace", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
sku: "Basic",
});
const exampleEventHub = new azure.eventhub.EventHub("exampleEventHub", {
resourceGroupName: exampleResourceGroup.name,
namespaceName: exampleEventHubNamespace.name,
partitionCount: 2,
messageRetention: 1,
});
const exampleAuthorizationRule = new azure.eventhub.AuthorizationRule("exampleAuthorizationRule", {
resourceGroupName: exampleResourceGroup.name,
namespaceName: exampleEventHubNamespace.name,
eventhubName: exampleEventHub.name,
send: true,
});
const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
sku: {
name: "S1",
capacity: "1",
},
endpoints: [
{
type: "AzureIotHub.StorageContainer",
connectionString: exampleAccount.primaryBlobConnectionString,
name: "export",
batchFrequencyInSeconds: 60,
maxChunkSizeInBytes: 10485760,
containerName: exampleContainer.name,
encoding: "Avro",
fileNameFormat: "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
},
{
type: "AzureIotHub.EventHub",
connectionString: exampleAuthorizationRule.primaryConnectionString,
name: "export2",
},
],
routes: [
{
name: "export",
source: "DeviceMessages",
condition: "true",
endpointNames: ["export"],
enabled: true,
},
{
name: "export2",
source: "DeviceMessages",
condition: "true",
endpointNames: ["export2"],
enabled: true,
},
],
enrichments: [{
key: "tenant",
value: `$twin.tags.Tenant`,
endpointNames: [
"export",
"export2",
],
}],
cloudToDevice: {
maxDeliveryCount: 30,
defaultTtl: "PT1H",
feedbacks: [{
timeToLive: "PT1H10M",
maxDeliveryCount: 15,
lockDuration: "PT30S",
}],
},
tags: {
purpose: "testing",
},
});
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
account_tier="Standard",
account_replication_type="LRS")
example_container = azure.storage.Container("exampleContainer",
storage_account_name=example_account.name,
container_access_type="private")
example_event_hub_namespace = azure.eventhub.EventHubNamespace("exampleEventHubNamespace",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
sku="Basic")
example_event_hub = azure.eventhub.EventHub("exampleEventHub",
resource_group_name=example_resource_group.name,
namespace_name=example_event_hub_namespace.name,
partition_count=2,
message_retention=1)
example_authorization_rule = azure.eventhub.AuthorizationRule("exampleAuthorizationRule",
resource_group_name=example_resource_group.name,
namespace_name=example_event_hub_namespace.name,
eventhub_name=example_event_hub.name,
send=True)
example_io_t_hub = azure.iot.IoTHub("exampleIoTHub",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
sku=azure.iot.IoTHubSkuArgs(
name="S1",
capacity=1,
),
endpoints=[
azure.iot.IoTHubEndpointArgs(
type="AzureIotHub.StorageContainer",
connection_string=example_account.primary_blob_connection_string,
name="export",
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}",
),
azure.iot.IoTHubEndpointArgs(
type="AzureIotHub.EventHub",
connection_string=example_authorization_rule.primary_connection_string,
name="export2",
),
],
routes=[
azure.iot.IoTHubRouteArgs(
name="export",
source="DeviceMessages",
condition="true",
endpoint_names=["export"],
enabled=True,
),
azure.iot.IoTHubRouteArgs(
name="export2",
source="DeviceMessages",
condition="true",
endpoint_names=["export2"],
enabled=True,
),
],
enrichments=[azure.iot.IoTHubEnrichmentArgs(
key="tenant",
value="$twin.tags.Tenant",
endpoint_names=[
"export",
"export2",
],
)],
cloud_to_device=azure.iot.IoTHubCloudToDeviceArgs(
max_delivery_count=30,
default_ttl="PT1H",
feedbacks=[azure.iot.IoTHubCloudToDeviceFeedbackArgs(
time_to_live="PT1H10M",
max_delivery_count=15,
lock_duration="PT30S",
)],
),
tags={
"purpose": "testing",
})
Example coming soon!
Create IoTHub Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IoTHub(name: string, args: IoTHubArgs, opts?: CustomResourceOptions);@overload
def IoTHub(resource_name: str,
args: IoTHubArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IoTHub(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
sku: Optional[IoTHubSkuArgs] = None,
ip_filter_rules: Optional[Sequence[IoTHubIpFilterRuleArgs]] = None,
location: Optional[str] = None,
event_hub_retention_in_days: Optional[int] = None,
fallback_route: Optional[IoTHubFallbackRouteArgs] = None,
file_upload: Optional[IoTHubFileUploadArgs] = None,
identity: Optional[IoTHubIdentityArgs] = None,
cloud_to_device: Optional[IoTHubCloudToDeviceArgs] = None,
event_hub_partition_count: Optional[int] = None,
min_tls_version: Optional[str] = None,
name: Optional[str] = None,
network_rule_sets: Optional[Sequence[IoTHubNetworkRuleSetArgs]] = None,
public_network_access_enabled: Optional[bool] = None,
enrichments: Optional[Sequence[IoTHubEnrichmentArgs]] = None,
routes: Optional[Sequence[IoTHubRouteArgs]] = None,
endpoints: Optional[Sequence[IoTHubEndpointArgs]] = None,
tags: Optional[Mapping[str, str]] = None)func NewIoTHub(ctx *Context, name string, args IoTHubArgs, opts ...ResourceOption) (*IoTHub, error)public IoTHub(string name, IoTHubArgs args, CustomResourceOptions? opts = null)
public IoTHub(String name, IoTHubArgs args)
public IoTHub(String name, IoTHubArgs args, CustomResourceOptions options)
type: azure:iot:IoTHub
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 IoTHubArgs
- 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 IoTHubArgs
- 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 IoTHubArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IoTHubArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IoTHubArgs
- 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 ioTHubResource = new Azure.Iot.IoTHub("ioTHubResource", new()
{
ResourceGroupName = "string",
Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
{
Capacity = 0,
Name = "string",
},
Location = "string",
EventHubRetentionInDays = 0,
FallbackRoute = new Azure.Iot.Inputs.IoTHubFallbackRouteArgs
{
Condition = "string",
Enabled = false,
EndpointNames = new[]
{
"string",
},
Source = "string",
},
FileUpload = new Azure.Iot.Inputs.IoTHubFileUploadArgs
{
ConnectionString = "string",
ContainerName = "string",
DefaultTtl = "string",
LockDuration = "string",
MaxDeliveryCount = 0,
Notifications = false,
SasTtl = "string",
},
Identity = new Azure.Iot.Inputs.IoTHubIdentityArgs
{
Type = "string",
IdentityIds = new[]
{
"string",
},
PrincipalId = "string",
TenantId = "string",
},
CloudToDevice = new Azure.Iot.Inputs.IoTHubCloudToDeviceArgs
{
DefaultTtl = "string",
Feedbacks = new[]
{
new Azure.Iot.Inputs.IoTHubCloudToDeviceFeedbackArgs
{
LockDuration = "string",
MaxDeliveryCount = 0,
TimeToLive = "string",
},
},
MaxDeliveryCount = 0,
},
EventHubPartitionCount = 0,
MinTlsVersion = "string",
Name = "string",
NetworkRuleSets = new[]
{
new Azure.Iot.Inputs.IoTHubNetworkRuleSetArgs
{
ApplyToBuiltinEventhubEndpoint = false,
DefaultAction = "string",
IpRules = new[]
{
new Azure.Iot.Inputs.IoTHubNetworkRuleSetIpRuleArgs
{
IpMask = "string",
Name = "string",
Action = "string",
},
},
},
},
PublicNetworkAccessEnabled = false,
Enrichments = new[]
{
new Azure.Iot.Inputs.IoTHubEnrichmentArgs
{
EndpointNames = new[]
{
"string",
},
Key = "string",
Value = "string",
},
},
Routes = new[]
{
new Azure.Iot.Inputs.IoTHubRouteArgs
{
Enabled = false,
EndpointNames = new[]
{
"string",
},
Name = "string",
Source = "string",
Condition = "string",
},
},
Endpoints = new[]
{
new Azure.Iot.Inputs.IoTHubEndpointArgs
{
Name = "string",
Type = "string",
EntityPath = "string",
ContainerName = "string",
Encoding = "string",
EndpointUri = "string",
AuthenticationType = "string",
FileNameFormat = "string",
IdentityId = "string",
MaxChunkSizeInBytes = 0,
ConnectionString = "string",
ResourceGroupName = "string",
BatchFrequencyInSeconds = 0,
},
},
Tags =
{
{ "string", "string" },
},
});
example, err := iot.NewIoTHub(ctx, "ioTHubResource", &iot.IoTHubArgs{
ResourceGroupName: pulumi.String("string"),
Sku: &iot.IoTHubSkuArgs{
Capacity: pulumi.Int(0),
Name: pulumi.String("string"),
},
Location: pulumi.String("string"),
EventHubRetentionInDays: pulumi.Int(0),
FallbackRoute: &iot.IoTHubFallbackRouteArgs{
Condition: pulumi.String("string"),
Enabled: pulumi.Bool(false),
EndpointNames: pulumi.StringArray{
pulumi.String("string"),
},
Source: pulumi.String("string"),
},
FileUpload: &iot.IoTHubFileUploadArgs{
ConnectionString: pulumi.String("string"),
ContainerName: pulumi.String("string"),
DefaultTtl: pulumi.String("string"),
LockDuration: pulumi.String("string"),
MaxDeliveryCount: pulumi.Int(0),
Notifications: pulumi.Bool(false),
SasTtl: pulumi.String("string"),
},
Identity: &iot.IoTHubIdentityArgs{
Type: pulumi.String("string"),
IdentityIds: pulumi.StringArray{
pulumi.String("string"),
},
PrincipalId: pulumi.String("string"),
TenantId: pulumi.String("string"),
},
CloudToDevice: &iot.IoTHubCloudToDeviceArgs{
DefaultTtl: pulumi.String("string"),
Feedbacks: iot.IoTHubCloudToDeviceFeedbackArray{
&iot.IoTHubCloudToDeviceFeedbackArgs{
LockDuration: pulumi.String("string"),
MaxDeliveryCount: pulumi.Int(0),
TimeToLive: pulumi.String("string"),
},
},
MaxDeliveryCount: pulumi.Int(0),
},
EventHubPartitionCount: pulumi.Int(0),
MinTlsVersion: pulumi.String("string"),
Name: pulumi.String("string"),
NetworkRuleSets: iot.IoTHubNetworkRuleSetArray{
&iot.IoTHubNetworkRuleSetArgs{
ApplyToBuiltinEventhubEndpoint: pulumi.Bool(false),
DefaultAction: pulumi.String("string"),
IpRules: iot.IoTHubNetworkRuleSetIpRuleArray{
&iot.IoTHubNetworkRuleSetIpRuleArgs{
IpMask: pulumi.String("string"),
Name: pulumi.String("string"),
Action: pulumi.String("string"),
},
},
},
},
PublicNetworkAccessEnabled: pulumi.Bool(false),
Enrichments: iot.IoTHubEnrichmentArray{
&iot.IoTHubEnrichmentArgs{
EndpointNames: pulumi.StringArray{
pulumi.String("string"),
},
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Routes: iot.IoTHubRouteArray{
&iot.IoTHubRouteArgs{
Enabled: pulumi.Bool(false),
EndpointNames: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
Source: pulumi.String("string"),
Condition: pulumi.String("string"),
},
},
Endpoints: iot.IoTHubEndpointArray{
&iot.IoTHubEndpointArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
EntityPath: pulumi.String("string"),
ContainerName: pulumi.String("string"),
Encoding: pulumi.String("string"),
EndpointUri: pulumi.String("string"),
AuthenticationType: pulumi.String("string"),
FileNameFormat: pulumi.String("string"),
IdentityId: pulumi.String("string"),
MaxChunkSizeInBytes: pulumi.Int(0),
ConnectionString: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
BatchFrequencyInSeconds: pulumi.Int(0),
},
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var ioTHubResource = new IoTHub("ioTHubResource", IoTHubArgs.builder()
.resourceGroupName("string")
.sku(IoTHubSkuArgs.builder()
.capacity(0)
.name("string")
.build())
.location("string")
.eventHubRetentionInDays(0)
.fallbackRoute(IoTHubFallbackRouteArgs.builder()
.condition("string")
.enabled(false)
.endpointNames("string")
.source("string")
.build())
.fileUpload(IoTHubFileUploadArgs.builder()
.connectionString("string")
.containerName("string")
.defaultTtl("string")
.lockDuration("string")
.maxDeliveryCount(0)
.notifications(false)
.sasTtl("string")
.build())
.identity(IoTHubIdentityArgs.builder()
.type("string")
.identityIds("string")
.principalId("string")
.tenantId("string")
.build())
.cloudToDevice(IoTHubCloudToDeviceArgs.builder()
.defaultTtl("string")
.feedbacks(IoTHubCloudToDeviceFeedbackArgs.builder()
.lockDuration("string")
.maxDeliveryCount(0)
.timeToLive("string")
.build())
.maxDeliveryCount(0)
.build())
.eventHubPartitionCount(0)
.minTlsVersion("string")
.name("string")
.networkRuleSets(IoTHubNetworkRuleSetArgs.builder()
.applyToBuiltinEventhubEndpoint(false)
.defaultAction("string")
.ipRules(IoTHubNetworkRuleSetIpRuleArgs.builder()
.ipMask("string")
.name("string")
.action("string")
.build())
.build())
.publicNetworkAccessEnabled(false)
.enrichments(IoTHubEnrichmentArgs.builder()
.endpointNames("string")
.key("string")
.value("string")
.build())
.routes(IoTHubRouteArgs.builder()
.enabled(false)
.endpointNames("string")
.name("string")
.source("string")
.condition("string")
.build())
.endpoints(IoTHubEndpointArgs.builder()
.name("string")
.type("string")
.entityPath("string")
.containerName("string")
.encoding("string")
.endpointUri("string")
.authenticationType("string")
.fileNameFormat("string")
.identityId("string")
.maxChunkSizeInBytes(0)
.connectionString("string")
.resourceGroupName("string")
.batchFrequencyInSeconds(0)
.build())
.tags(Map.of("string", "string"))
.build());
io_t_hub_resource = azure.iot.IoTHub("ioTHubResource",
resource_group_name="string",
sku={
"capacity": 0,
"name": "string",
},
location="string",
event_hub_retention_in_days=0,
fallback_route={
"condition": "string",
"enabled": False,
"endpoint_names": ["string"],
"source": "string",
},
file_upload={
"connection_string": "string",
"container_name": "string",
"default_ttl": "string",
"lock_duration": "string",
"max_delivery_count": 0,
"notifications": False,
"sas_ttl": "string",
},
identity={
"type": "string",
"identity_ids": ["string"],
"principal_id": "string",
"tenant_id": "string",
},
cloud_to_device={
"default_ttl": "string",
"feedbacks": [{
"lock_duration": "string",
"max_delivery_count": 0,
"time_to_live": "string",
}],
"max_delivery_count": 0,
},
event_hub_partition_count=0,
min_tls_version="string",
name="string",
network_rule_sets=[{
"apply_to_builtin_eventhub_endpoint": False,
"default_action": "string",
"ip_rules": [{
"ip_mask": "string",
"name": "string",
"action": "string",
}],
}],
public_network_access_enabled=False,
enrichments=[{
"endpoint_names": ["string"],
"key": "string",
"value": "string",
}],
routes=[{
"enabled": False,
"endpoint_names": ["string"],
"name": "string",
"source": "string",
"condition": "string",
}],
endpoints=[{
"name": "string",
"type": "string",
"entity_path": "string",
"container_name": "string",
"encoding": "string",
"endpoint_uri": "string",
"authentication_type": "string",
"file_name_format": "string",
"identity_id": "string",
"max_chunk_size_in_bytes": 0,
"connection_string": "string",
"resource_group_name": "string",
"batch_frequency_in_seconds": 0,
}],
tags={
"string": "string",
})
const ioTHubResource = new azure.iot.IoTHub("ioTHubResource", {
resourceGroupName: "string",
sku: {
capacity: 0,
name: "string",
},
location: "string",
eventHubRetentionInDays: 0,
fallbackRoute: {
condition: "string",
enabled: false,
endpointNames: ["string"],
source: "string",
},
fileUpload: {
connectionString: "string",
containerName: "string",
defaultTtl: "string",
lockDuration: "string",
maxDeliveryCount: 0,
notifications: false,
sasTtl: "string",
},
identity: {
type: "string",
identityIds: ["string"],
principalId: "string",
tenantId: "string",
},
cloudToDevice: {
defaultTtl: "string",
feedbacks: [{
lockDuration: "string",
maxDeliveryCount: 0,
timeToLive: "string",
}],
maxDeliveryCount: 0,
},
eventHubPartitionCount: 0,
minTlsVersion: "string",
name: "string",
networkRuleSets: [{
applyToBuiltinEventhubEndpoint: false,
defaultAction: "string",
ipRules: [{
ipMask: "string",
name: "string",
action: "string",
}],
}],
publicNetworkAccessEnabled: false,
enrichments: [{
endpointNames: ["string"],
key: "string",
value: "string",
}],
routes: [{
enabled: false,
endpointNames: ["string"],
name: "string",
source: "string",
condition: "string",
}],
endpoints: [{
name: "string",
type: "string",
entityPath: "string",
containerName: "string",
encoding: "string",
endpointUri: "string",
authenticationType: "string",
fileNameFormat: "string",
identityId: "string",
maxChunkSizeInBytes: 0,
connectionString: "string",
resourceGroupName: "string",
batchFrequencyInSeconds: 0,
}],
tags: {
string: "string",
},
});
type: azure:iot:IoTHub
properties:
cloudToDevice:
defaultTtl: string
feedbacks:
- lockDuration: string
maxDeliveryCount: 0
timeToLive: string
maxDeliveryCount: 0
endpoints:
- authenticationType: string
batchFrequencyInSeconds: 0
connectionString: string
containerName: string
encoding: string
endpointUri: string
entityPath: string
fileNameFormat: string
identityId: string
maxChunkSizeInBytes: 0
name: string
resourceGroupName: string
type: string
enrichments:
- endpointNames:
- string
key: string
value: string
eventHubPartitionCount: 0
eventHubRetentionInDays: 0
fallbackRoute:
condition: string
enabled: false
endpointNames:
- string
source: string
fileUpload:
connectionString: string
containerName: string
defaultTtl: string
lockDuration: string
maxDeliveryCount: 0
notifications: false
sasTtl: string
identity:
identityIds:
- string
principalId: string
tenantId: string
type: string
location: string
minTlsVersion: string
name: string
networkRuleSets:
- applyToBuiltinEventhubEndpoint: false
defaultAction: string
ipRules:
- action: string
ipMask: string
name: string
publicNetworkAccessEnabled: false
resourceGroupName: string
routes:
- condition: string
enabled: false
endpointNames:
- string
name: string
source: string
sku:
capacity: 0
name: string
tags:
string: string
IoTHub 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 IoTHub resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
- Sku
Io
THub Sku - A
skublock as defined below. - Cloud
To IoDevice THub Cloud To Device - A
cloud_to_deviceblock as defined below. - Endpoints
List<Io
THub Endpoint> - An
endpointblock as defined below. - Enrichments
List<Io
THub Enrichment> - A
enrichmentblock as defined below. - Event
Hub intPartition Count - The number of device-to-cloud partitions used by backing event hubs. Must be between
2and128. - Event
Hub intRetention In Days - The event hub retention to use in days. Must be between
1and7. - Fallback
Route IoTHub Fallback Route - A
fallback_routeblock as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events. - File
Upload IoTHub File Upload - A
file_uploadblock as defined below. - Identity
Io
THub Identity - An
identityblock as defined below. - Ip
Filter List<IoRules THub Ip Filter Rule> - One or more
ip_filter_ruleblocks as defined below. - Location string
- Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
- Min
Tls stringVersion - Specifies the minimum TLS version to support for this hub. The only valid value is
1.2. Changing this forces a new resource to be created. - Name string
- Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
- Network
Rule List<IoSets THub Network Rule Set> - A
network_rule_setblock as defined below. - Public
Network boolAccess Enabled - Is the IotHub resource accessible from a public network?
- Routes
List<Io
THub Route> - A
routeblock as defined below. - Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Resource
Group stringName - The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
- Sku
Io
THub Sku Args - A
skublock as defined below. - Cloud
To IoDevice THub Cloud To Device Args - A
cloud_to_deviceblock as defined below. - Endpoints
[]Io
THub Endpoint Args - An
endpointblock as defined below. - Enrichments
[]Io
THub Enrichment Args - A
enrichmentblock as defined below. - Event
Hub intPartition Count - The number of device-to-cloud partitions used by backing event hubs. Must be between
2and128. - Event
Hub intRetention In Days - The event hub retention to use in days. Must be between
1and7. - Fallback
Route IoTHub Fallback Route Args - A
fallback_routeblock as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events. - File
Upload IoTHub File Upload Args - A
file_uploadblock as defined below. - Identity
Io
THub Identity Args - An
identityblock as defined below. - Ip
Filter []IoRules THub Ip Filter Rule Args - One or more
ip_filter_ruleblocks as defined below. - Location string
- Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
- Min
Tls stringVersion - Specifies the minimum TLS version to support for this hub. The only valid value is
1.2. Changing this forces a new resource to be created. - Name string
- Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
- Network
Rule []IoSets THub Network Rule Set Args - A
network_rule_setblock as defined below. - Public
Network boolAccess Enabled - Is the IotHub resource accessible from a public network?
- Routes
[]Io
THub Route Args - A
routeblock as defined below. - map[string]string
- A mapping of tags to assign to the resource.
- resource
Group StringName - The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
- sku
Io
THub Sku - A
skublock as defined below. - cloud
To IoDevice THub Cloud To Device - A
cloud_to_deviceblock as defined below. - endpoints
List<Io
THub Endpoint> - An
endpointblock as defined below. - enrichments
List<Io
THub Enrichment> - A
enrichmentblock as defined below. - event
Hub IntegerPartition Count - The number of device-to-cloud partitions used by backing event hubs. Must be between
2and128. - event
Hub IntegerRetention In Days - The event hub retention to use in days. Must be between
1and7. - fallback
Route IoTHub Fallback Route - A
fallback_routeblock as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events. - file
Upload IoTHub File Upload - A
file_uploadblock as defined below. - identity
Io
THub Identity - An
identityblock as defined below. - ip
Filter List<IoRules THub Ip Filter Rule> - One or more
ip_filter_ruleblocks as defined below. - location String
- Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
- min
Tls StringVersion - Specifies the minimum TLS version to support for this hub. The only valid value is
1.2. Changing this forces a new resource to be created. - name String
- Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
- network
Rule List<IoSets THub Network Rule Set> - A
network_rule_setblock as defined below. - public
Network BooleanAccess Enabled - Is the IotHub resource accessible from a public network?
- routes
List<Io
THub Route> - A
routeblock as defined below. - Map<String,String>
- A mapping of tags to assign to the resource.
- resource
Group stringName - The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
- sku
Io
THub Sku - A
skublock as defined below. - cloud
To IoDevice THub Cloud To Device - A
cloud_to_deviceblock as defined below. - endpoints
Io
THub Endpoint[] - An
endpointblock as defined below. - enrichments
Io
THub Enrichment[] - A
enrichmentblock as defined below. - event
Hub numberPartition Count - The number of device-to-cloud partitions used by backing event hubs. Must be between
2and128. - event
Hub numberRetention In Days - The event hub retention to use in days. Must be between
1and7. - fallback
Route IoTHub Fallback Route - A
fallback_routeblock as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events. - file
Upload IoTHub File Upload - A
file_uploadblock as defined below. - identity
Io
THub Identity - An
identityblock as defined below. - ip
Filter IoRules THub Ip Filter Rule[] - One or more
ip_filter_ruleblocks as defined below. - location string
- Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
- min
Tls stringVersion - Specifies the minimum TLS version to support for this hub. The only valid value is
1.2. Changing this forces a new resource to be created. - name string
- Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
- network
Rule IoSets THub Network Rule Set[] - A
network_rule_setblock as defined below. - public
Network booleanAccess Enabled - Is the IotHub resource accessible from a public network?
- routes
Io
THub Route[] - A
routeblock as defined below. - {[key: string]: string}
- A mapping of tags to assign to the resource.
- resource_
group_ strname - The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
- sku
Io
THub Sku Args - A
skublock as defined below. - cloud_
to_ Iodevice THub Cloud To Device Args - A
cloud_to_deviceblock as defined below. - endpoints
Sequence[Io
THub Endpoint Args] - An
endpointblock as defined below. - enrichments
Sequence[Io
THub Enrichment Args] - A
enrichmentblock as defined below. - event_
hub_ intpartition_ count - The number of device-to-cloud partitions used by backing event hubs. Must be between
2and128. - event_
hub_ intretention_ in_ days - The event hub retention to use in days. Must be between
1and7. - fallback_
route IoTHub Fallback Route Args - A
fallback_routeblock as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events. - file_
upload IoTHub File Upload Args - A
file_uploadblock as defined below. - identity
Io
THub Identity Args - An
identityblock as defined below. - ip_
filter_ Sequence[Iorules THub Ip Filter Rule Args] - One or more
ip_filter_ruleblocks as defined below. - location str
- Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
- min_
tls_ strversion - Specifies the minimum TLS version to support for this hub. The only valid value is
1.2. Changing this forces a new resource to be created. - name str
- Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
- network_
rule_ Sequence[Iosets THub Network Rule Set Args] - A
network_rule_setblock as defined below. - public_
network_ boolaccess_ enabled - Is the IotHub resource accessible from a public network?
- routes
Sequence[Io
THub Route Args] - A
routeblock as defined below. - Mapping[str, str]
- A mapping of tags to assign to the resource.
- resource
Group StringName - The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
- sku Property Map
- A
skublock as defined below. - cloud
To Property MapDevice - A
cloud_to_deviceblock as defined below. - endpoints List<Property Map>
- An
endpointblock as defined below. - enrichments List<Property Map>
- A
enrichmentblock as defined below. - event
Hub NumberPartition Count - The number of device-to-cloud partitions used by backing event hubs. Must be between
2and128. - event
Hub NumberRetention In Days - The event hub retention to use in days. Must be between
1and7. - fallback
Route Property Map - A
fallback_routeblock as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events. - file
Upload Property Map - A
file_uploadblock as defined below. - identity Property Map
- An
identityblock as defined below. - ip
Filter List<Property Map>Rules - One or more
ip_filter_ruleblocks as defined below. - location String
- Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
- min
Tls StringVersion - Specifies the minimum TLS version to support for this hub. The only valid value is
1.2. Changing this forces a new resource to be created. - name String
- Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
- network
Rule List<Property Map>Sets - A
network_rule_setblock as defined below. - public
Network BooleanAccess Enabled - Is the IotHub resource accessible from a public network?
- routes List<Property Map>
- A
routeblock as defined below. - Map<String>
- A mapping of tags to assign to the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the IoTHub resource produces the following output properties:
- Event
Hub stringEvents Endpoint - The EventHub compatible endpoint for events data
- Event
Hub stringEvents Namespace - The EventHub namespace for events data
- Event
Hub stringEvents Path - The EventHub compatible path for events data
- Event
Hub stringOperations Endpoint - The EventHub compatible endpoint for operational data
- Event
Hub stringOperations Path - The EventHub compatible path for operational data
- Hostname string
- The hostname of the IotHub Resource.
- Id string
- The provider-assigned unique ID for this managed resource.
-
List<Io
THub Shared Access Policy> - One or more
shared_access_policyblocks as defined below. - Type string
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub.
- Event
Hub stringEvents Endpoint - The EventHub compatible endpoint for events data
- Event
Hub stringEvents Namespace - The EventHub namespace for events data
- Event
Hub stringEvents Path - The EventHub compatible path for events data
- Event
Hub stringOperations Endpoint - The EventHub compatible endpoint for operational data
- Event
Hub stringOperations Path - The EventHub compatible path for operational data
- Hostname string
- The hostname of the IotHub Resource.
- Id string
- The provider-assigned unique ID for this managed resource.
-
[]Io
THub Shared Access Policy - One or more
shared_access_policyblocks as defined below. - Type string
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub.
- event
Hub StringEvents Endpoint - The EventHub compatible endpoint for events data
- event
Hub StringEvents Namespace - The EventHub namespace for events data
- event
Hub StringEvents Path - The EventHub compatible path for events data
- event
Hub StringOperations Endpoint - The EventHub compatible endpoint for operational data
- event
Hub StringOperations Path - The EventHub compatible path for operational data
- hostname String
- The hostname of the IotHub Resource.
- id String
- The provider-assigned unique ID for this managed resource.
-
List<Io
THub Shared Access Policy> - One or more
shared_access_policyblocks as defined below. - type String
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub.
- event
Hub stringEvents Endpoint - The EventHub compatible endpoint for events data
- event
Hub stringEvents Namespace - The EventHub namespace for events data
- event
Hub stringEvents Path - The EventHub compatible path for events data
- event
Hub stringOperations Endpoint - The EventHub compatible endpoint for operational data
- event
Hub stringOperations Path - The EventHub compatible path for operational data
- hostname string
- The hostname of the IotHub Resource.
- id string
- The provider-assigned unique ID for this managed resource.
-
Io
THub Shared Access Policy[] - One or more
shared_access_policyblocks as defined below. - type string
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub.
- event_
hub_ strevents_ endpoint - The EventHub compatible endpoint for events data
- event_
hub_ strevents_ namespace - The EventHub namespace for events data
- event_
hub_ strevents_ path - The EventHub compatible path for events data
- event_
hub_ stroperations_ endpoint - The EventHub compatible endpoint for operational data
- event_
hub_ stroperations_ path - The EventHub compatible path for operational data
- hostname str
- The hostname of the IotHub Resource.
- id str
- The provider-assigned unique ID for this managed resource.
-
Sequence[Io
THub Shared Access Policy] - One or more
shared_access_policyblocks as defined below. - type str
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub.
- event
Hub StringEvents Endpoint - The EventHub compatible endpoint for events data
- event
Hub StringEvents Namespace - The EventHub namespace for events data
- event
Hub StringEvents Path - The EventHub compatible path for events data
- event
Hub StringOperations Endpoint - The EventHub compatible endpoint for operational data
- event
Hub StringOperations Path - The EventHub compatible path for operational data
- hostname String
- The hostname of the IotHub Resource.
- id String
- The provider-assigned unique ID for this managed resource.
- List<Property Map>
- One or more
shared_access_policyblocks as defined below. - type String
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub.
Look up Existing IoTHub Resource
Get an existing IoTHub 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?: IoTHubState, opts?: CustomResourceOptions): IoTHub@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cloud_to_device: Optional[IoTHubCloudToDeviceArgs] = None,
endpoints: Optional[Sequence[IoTHubEndpointArgs]] = None,
enrichments: Optional[Sequence[IoTHubEnrichmentArgs]] = None,
event_hub_events_endpoint: Optional[str] = None,
event_hub_events_namespace: Optional[str] = None,
event_hub_events_path: Optional[str] = None,
event_hub_operations_endpoint: Optional[str] = None,
event_hub_operations_path: Optional[str] = None,
event_hub_partition_count: Optional[int] = None,
event_hub_retention_in_days: Optional[int] = None,
fallback_route: Optional[IoTHubFallbackRouteArgs] = None,
file_upload: Optional[IoTHubFileUploadArgs] = None,
hostname: Optional[str] = None,
identity: Optional[IoTHubIdentityArgs] = None,
ip_filter_rules: Optional[Sequence[IoTHubIpFilterRuleArgs]] = None,
location: Optional[str] = None,
min_tls_version: Optional[str] = None,
name: Optional[str] = None,
network_rule_sets: Optional[Sequence[IoTHubNetworkRuleSetArgs]] = None,
public_network_access_enabled: Optional[bool] = None,
resource_group_name: Optional[str] = None,
routes: Optional[Sequence[IoTHubRouteArgs]] = None,
shared_access_policies: Optional[Sequence[IoTHubSharedAccessPolicyArgs]] = None,
sku: Optional[IoTHubSkuArgs] = None,
tags: Optional[Mapping[str, str]] = None,
type: Optional[str] = None) -> IoTHubfunc GetIoTHub(ctx *Context, name string, id IDInput, state *IoTHubState, opts ...ResourceOption) (*IoTHub, error)public static IoTHub Get(string name, Input<string> id, IoTHubState? state, CustomResourceOptions? opts = null)public static IoTHub get(String name, Output<String> id, IoTHubState state, CustomResourceOptions options)resources: _: type: azure:iot:IoTHub get: id: ${id}- 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.
- Cloud
To IoDevice THub Cloud To Device - A
cloud_to_deviceblock as defined below. - Endpoints
List<Io
THub Endpoint> - An
endpointblock as defined below. - Enrichments
List<Io
THub Enrichment> - A
enrichmentblock as defined below. - Event
Hub stringEvents Endpoint - The EventHub compatible endpoint for events data
- Event
Hub stringEvents Namespace - The EventHub namespace for events data
- Event
Hub stringEvents Path - The EventHub compatible path for events data
- Event
Hub stringOperations Endpoint - The EventHub compatible endpoint for operational data
- Event
Hub stringOperations Path - The EventHub compatible path for operational data
- Event
Hub intPartition Count - The number of device-to-cloud partitions used by backing event hubs. Must be between
2and128. - Event
Hub intRetention In Days - The event hub retention to use in days. Must be between
1and7. - Fallback
Route IoTHub Fallback Route - A
fallback_routeblock as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events. - File
Upload IoTHub File Upload - A
file_uploadblock as defined below. - Hostname string
- The hostname of the IotHub Resource.
- Identity
Io
THub Identity - An
identityblock as defined below. - Ip
Filter List<IoRules THub Ip Filter Rule> - One or more
ip_filter_ruleblocks as defined below. - Location string
- Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
- Min
Tls stringVersion - Specifies the minimum TLS version to support for this hub. The only valid value is
1.2. Changing this forces a new resource to be created. - Name string
- Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
- Network
Rule List<IoSets THub Network Rule Set> - A
network_rule_setblock as defined below. - Public
Network boolAccess Enabled - Is the IotHub resource accessible from a public network?
- Resource
Group stringName - The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
- Routes
List<Io
THub Route> - A
routeblock as defined below. -
List<Io
THub Shared Access Policy> - One or more
shared_access_policyblocks as defined below. - Sku
Io
THub Sku - A
skublock as defined below. - Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Type string
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub.
- Cloud
To IoDevice THub Cloud To Device Args - A
cloud_to_deviceblock as defined below. - Endpoints
[]Io
THub Endpoint Args - An
endpointblock as defined below. - Enrichments
[]Io
THub Enrichment Args - A
enrichmentblock as defined below. - Event
Hub stringEvents Endpoint - The EventHub compatible endpoint for events data
- Event
Hub stringEvents Namespace - The EventHub namespace for events data
- Event
Hub stringEvents Path - The EventHub compatible path for events data
- Event
Hub stringOperations Endpoint - The EventHub compatible endpoint for operational data
- Event
Hub stringOperations Path - The EventHub compatible path for operational data
- Event
Hub intPartition Count - The number of device-to-cloud partitions used by backing event hubs. Must be between
2and128. - Event
Hub intRetention In Days - The event hub retention to use in days. Must be between
1and7. - Fallback
Route IoTHub Fallback Route Args - A
fallback_routeblock as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events. - File
Upload IoTHub File Upload Args - A
file_uploadblock as defined below. - Hostname string
- The hostname of the IotHub Resource.
- Identity
Io
THub Identity Args - An
identityblock as defined below. - Ip
Filter []IoRules THub Ip Filter Rule Args - One or more
ip_filter_ruleblocks as defined below. - Location string
- Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
- Min
Tls stringVersion - Specifies the minimum TLS version to support for this hub. The only valid value is
1.2. Changing this forces a new resource to be created. - Name string
- Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
- Network
Rule []IoSets THub Network Rule Set Args - A
network_rule_setblock as defined below. - Public
Network boolAccess Enabled - Is the IotHub resource accessible from a public network?
- Resource
Group stringName - The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
- Routes
[]Io
THub Route Args - A
routeblock as defined below. -
[]Io
THub Shared Access Policy Args - One or more
shared_access_policyblocks as defined below. - Sku
Io
THub Sku Args - A
skublock as defined below. - map[string]string
- A mapping of tags to assign to the resource.
- Type string
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub.
- cloud
To IoDevice THub Cloud To Device - A
cloud_to_deviceblock as defined below. - endpoints
List<Io
THub Endpoint> - An
endpointblock as defined below. - enrichments
List<Io
THub Enrichment> - A
enrichmentblock as defined below. - event
Hub StringEvents Endpoint - The EventHub compatible endpoint for events data
- event
Hub StringEvents Namespace - The EventHub namespace for events data
- event
Hub StringEvents Path - The EventHub compatible path for events data
- event
Hub StringOperations Endpoint - The EventHub compatible endpoint for operational data
- event
Hub StringOperations Path - The EventHub compatible path for operational data
- event
Hub IntegerPartition Count - The number of device-to-cloud partitions used by backing event hubs. Must be between
2and128. - event
Hub IntegerRetention In Days - The event hub retention to use in days. Must be between
1and7. - fallback
Route IoTHub Fallback Route - A
fallback_routeblock as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events. - file
Upload IoTHub File Upload - A
file_uploadblock as defined below. - hostname String
- The hostname of the IotHub Resource.
- identity
Io
THub Identity - An
identityblock as defined below. - ip
Filter List<IoRules THub Ip Filter Rule> - One or more
ip_filter_ruleblocks as defined below. - location String
- Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
- min
Tls StringVersion - Specifies the minimum TLS version to support for this hub. The only valid value is
1.2. Changing this forces a new resource to be created. - name String
- Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
- network
Rule List<IoSets THub Network Rule Set> - A
network_rule_setblock as defined below. - public
Network BooleanAccess Enabled - Is the IotHub resource accessible from a public network?
- resource
Group StringName - The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
- routes
List<Io
THub Route> - A
routeblock as defined below. -
List<Io
THub Shared Access Policy> - One or more
shared_access_policyblocks as defined below. - sku
Io
THub Sku - A
skublock as defined below. - Map<String,String>
- A mapping of tags to assign to the resource.
- type String
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub.
- cloud
To IoDevice THub Cloud To Device - A
cloud_to_deviceblock as defined below. - endpoints
Io
THub Endpoint[] - An
endpointblock as defined below. - enrichments
Io
THub Enrichment[] - A
enrichmentblock as defined below. - event
Hub stringEvents Endpoint - The EventHub compatible endpoint for events data
- event
Hub stringEvents Namespace - The EventHub namespace for events data
- event
Hub stringEvents Path - The EventHub compatible path for events data
- event
Hub stringOperations Endpoint - The EventHub compatible endpoint for operational data
- event
Hub stringOperations Path - The EventHub compatible path for operational data
- event
Hub numberPartition Count - The number of device-to-cloud partitions used by backing event hubs. Must be between
2and128. - event
Hub numberRetention In Days - The event hub retention to use in days. Must be between
1and7. - fallback
Route IoTHub Fallback Route - A
fallback_routeblock as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events. - file
Upload IoTHub File Upload - A
file_uploadblock as defined below. - hostname string
- The hostname of the IotHub Resource.
- identity
Io
THub Identity - An
identityblock as defined below. - ip
Filter IoRules THub Ip Filter Rule[] - One or more
ip_filter_ruleblocks as defined below. - location string
- Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
- min
Tls stringVersion - Specifies the minimum TLS version to support for this hub. The only valid value is
1.2. Changing this forces a new resource to be created. - name string
- Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
- network
Rule IoSets THub Network Rule Set[] - A
network_rule_setblock as defined below. - public
Network booleanAccess Enabled - Is the IotHub resource accessible from a public network?
- resource
Group stringName - The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
- routes
Io
THub Route[] - A
routeblock as defined below. -
Io
THub Shared Access Policy[] - One or more
shared_access_policyblocks as defined below. - sku
Io
THub Sku - A
skublock as defined below. - {[key: string]: string}
- A mapping of tags to assign to the resource.
- type string
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub.
- cloud_
to_ Iodevice THub Cloud To Device Args - A
cloud_to_deviceblock as defined below. - endpoints
Sequence[Io
THub Endpoint Args] - An
endpointblock as defined below. - enrichments
Sequence[Io
THub Enrichment Args] - A
enrichmentblock as defined below. - event_
hub_ strevents_ endpoint - The EventHub compatible endpoint for events data
- event_
hub_ strevents_ namespace - The EventHub namespace for events data
- event_
hub_ strevents_ path - The EventHub compatible path for events data
- event_
hub_ stroperations_ endpoint - The EventHub compatible endpoint for operational data
- event_
hub_ stroperations_ path - The EventHub compatible path for operational data
- event_
hub_ intpartition_ count - The number of device-to-cloud partitions used by backing event hubs. Must be between
2and128. - event_
hub_ intretention_ in_ days - The event hub retention to use in days. Must be between
1and7. - fallback_
route IoTHub Fallback Route Args - A
fallback_routeblock as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events. - file_
upload IoTHub File Upload Args - A
file_uploadblock as defined below. - hostname str
- The hostname of the IotHub Resource.
- identity
Io
THub Identity Args - An
identityblock as defined below. - ip_
filter_ Sequence[Iorules THub Ip Filter Rule Args] - One or more
ip_filter_ruleblocks as defined below. - location str
- Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
- min_
tls_ strversion - Specifies the minimum TLS version to support for this hub. The only valid value is
1.2. Changing this forces a new resource to be created. - name str
- Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
- network_
rule_ Sequence[Iosets THub Network Rule Set Args] - A
network_rule_setblock as defined below. - public_
network_ boolaccess_ enabled - Is the IotHub resource accessible from a public network?
- resource_
group_ strname - The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
- routes
Sequence[Io
THub Route Args] - A
routeblock as defined below. -
Sequence[Io
THub Shared Access Policy Args] - One or more
shared_access_policyblocks as defined below. - sku
Io
THub Sku Args - A
skublock as defined below. - Mapping[str, str]
- A mapping of tags to assign to the resource.
- type str
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub.
- cloud
To Property MapDevice - A
cloud_to_deviceblock as defined below. - endpoints List<Property Map>
- An
endpointblock as defined below. - enrichments List<Property Map>
- A
enrichmentblock as defined below. - event
Hub StringEvents Endpoint - The EventHub compatible endpoint for events data
- event
Hub StringEvents Namespace - The EventHub namespace for events data
- event
Hub StringEvents Path - The EventHub compatible path for events data
- event
Hub StringOperations Endpoint - The EventHub compatible endpoint for operational data
- event
Hub StringOperations Path - The EventHub compatible path for operational data
- event
Hub NumberPartition Count - The number of device-to-cloud partitions used by backing event hubs. Must be between
2and128. - event
Hub NumberRetention In Days - The event hub retention to use in days. Must be between
1and7. - fallback
Route Property Map - A
fallback_routeblock as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events. - file
Upload Property Map - A
file_uploadblock as defined below. - hostname String
- The hostname of the IotHub Resource.
- identity Property Map
- An
identityblock as defined below. - ip
Filter List<Property Map>Rules - One or more
ip_filter_ruleblocks as defined below. - location String
- Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
- min
Tls StringVersion - Specifies the minimum TLS version to support for this hub. The only valid value is
1.2. Changing this forces a new resource to be created. - name String
- Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
- network
Rule List<Property Map>Sets - A
network_rule_setblock as defined below. - public
Network BooleanAccess Enabled - Is the IotHub resource accessible from a public network?
- resource
Group StringName - The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
- routes List<Property Map>
- A
routeblock as defined below. - List<Property Map>
- One or more
shared_access_policyblocks as defined below. - sku Property Map
- A
skublock as defined below. - Map<String>
- A mapping of tags to assign to the resource.
- type String
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub.
Supporting Types
IoTHubCloudToDevice, IoTHubCloudToDeviceArgs
- Default
Ttl string - The default time to live for cloud-to-device messages, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default. - Feedbacks
List<Io
THub Cloud To Device Feedback> - A
feedbackblock as defined below. - Max
Delivery intCount - The maximum delivery count for cloud-to-device per-device queues. This value must be between
1and100, and evaluates to10by default.
- Default
Ttl string - The default time to live for cloud-to-device messages, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default. - Feedbacks
[]Io
THub Cloud To Device Feedback - A
feedbackblock as defined below. - Max
Delivery intCount - The maximum delivery count for cloud-to-device per-device queues. This value must be between
1and100, and evaluates to10by default.
- default
Ttl String - The default time to live for cloud-to-device messages, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default. - feedbacks
List<Io
THub Cloud To Device Feedback> - A
feedbackblock as defined below. - max
Delivery IntegerCount - The maximum delivery count for cloud-to-device per-device queues. This value must be between
1and100, and evaluates to10by default.
- default
Ttl string - The default time to live for cloud-to-device messages, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default. - feedbacks
Io
THub Cloud To Device Feedback[] - A
feedbackblock as defined below. - max
Delivery numberCount - The maximum delivery count for cloud-to-device per-device queues. This value must be between
1and100, and evaluates to10by default.
- default_
ttl str - The default time to live for cloud-to-device messages, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default. - feedbacks
Sequence[Io
THub Cloud To Device Feedback] - A
feedbackblock as defined below. - max_
delivery_ intcount - The maximum delivery count for cloud-to-device per-device queues. This value must be between
1and100, and evaluates to10by default.
- default
Ttl String - The default time to live for cloud-to-device messages, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default. - feedbacks List<Property Map>
- A
feedbackblock as defined below. - max
Delivery NumberCount - The maximum delivery count for cloud-to-device per-device queues. This value must be between
1and100, and evaluates to10by default.
IoTHubCloudToDeviceFeedback, IoTHubCloudToDeviceFeedbackArgs
- Lock
Duration string - The lock duration for the feedback queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to
PT60Sby default. - Max
Delivery intCount - The maximum delivery count for the feedback queue. This value must be between
1and100, and evaluates to10by default. - Time
To stringLive - The retention time for service-bound feedback messages, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default.
- Lock
Duration string - The lock duration for the feedback queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to
PT60Sby default. - Max
Delivery intCount - The maximum delivery count for the feedback queue. This value must be between
1and100, and evaluates to10by default. - Time
To stringLive - The retention time for service-bound feedback messages, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default.
- lock
Duration String - The lock duration for the feedback queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to
PT60Sby default. - max
Delivery IntegerCount - The maximum delivery count for the feedback queue. This value must be between
1and100, and evaluates to10by default. - time
To StringLive - The retention time for service-bound feedback messages, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default.
- lock
Duration string - The lock duration for the feedback queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to
PT60Sby default. - max
Delivery numberCount - The maximum delivery count for the feedback queue. This value must be between
1and100, and evaluates to10by default. - time
To stringLive - The retention time for service-bound feedback messages, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default.
- lock_
duration str - The lock duration for the feedback queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to
PT60Sby default. - max_
delivery_ intcount - The maximum delivery count for the feedback queue. This value must be between
1and100, and evaluates to10by default. - time_
to_ strlive - The retention time for service-bound feedback messages, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default.
- lock
Duration String - The lock duration for the feedback queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to
PT60Sby default. - max
Delivery NumberCount - The maximum delivery count for the feedback queue. This value must be between
1and100, and evaluates to10by default. - time
To StringLive - The retention time for service-bound feedback messages, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default.
IoTHubEndpoint, IoTHubEndpointArgs
- Name string
- The name of the endpoint. The name must be unique across endpoint types. The following names are reserved:
events,operationsMonitoringEvents,fileNotificationsand$default. - Type string
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - Authentication
Type string - Type used to authenticate against the endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased. - Batch
Frequency intIn Seconds - Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. This attribute is applicable for endpoint type
AzureIotHub.StorageContainer. - Connection
String string - The connection string for the endpoint. This attribute is mandatory and can only be specified when
authentication_typeiskeyBased. - Container
Name string - The name of storage container in the storage account. This attribute is mandatory for endpoint type
AzureIotHub.StorageContainer. - Encoding string
- Encoding that is used to serialize messages to blobs. Supported values are
Avro,AvroDeflateandJSON. Default value isAvro. This attribute is applicable for endpoint typeAzureIotHub.StorageContainer. Changing this forces a new resource to be created. - Endpoint
Uri string - URI of the Service Bus or Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBasedfor endpoint typeAzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - Entity
Path string - Name of the Service Bus Queue/Topic or Event Hub. This attribute can only be specified and is mandatory when
authentication_typeisidentityBasedfor endpoint typeAzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - File
Name stringFormat - File name format for the blob. Default format is
{iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. This attribute is applicable for endpoint typeAzureIotHub.StorageContainer. - Identity
Id string - ID of the User Managed Identity used to authenticate against the endpoint.
- Max
Chunk intSize In Bytes - Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). This attribute is applicable for endpoint type
AzureIotHub.StorageContainer. - Resource
Group stringName - The resource group in which the endpoint will be created.
- Name string
- The name of the endpoint. The name must be unique across endpoint types. The following names are reserved:
events,operationsMonitoringEvents,fileNotificationsand$default. - Type string
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - Authentication
Type string - Type used to authenticate against the endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased. - Batch
Frequency intIn Seconds - Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. This attribute is applicable for endpoint type
AzureIotHub.StorageContainer. - Connection
String string - The connection string for the endpoint. This attribute is mandatory and can only be specified when
authentication_typeiskeyBased. - Container
Name string - The name of storage container in the storage account. This attribute is mandatory for endpoint type
AzureIotHub.StorageContainer. - Encoding string
- Encoding that is used to serialize messages to blobs. Supported values are
Avro,AvroDeflateandJSON. Default value isAvro. This attribute is applicable for endpoint typeAzureIotHub.StorageContainer. Changing this forces a new resource to be created. - Endpoint
Uri string - URI of the Service Bus or Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBasedfor endpoint typeAzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - Entity
Path string - Name of the Service Bus Queue/Topic or Event Hub. This attribute can only be specified and is mandatory when
authentication_typeisidentityBasedfor endpoint typeAzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - File
Name stringFormat - File name format for the blob. Default format is
{iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. This attribute is applicable for endpoint typeAzureIotHub.StorageContainer. - Identity
Id string - ID of the User Managed Identity used to authenticate against the endpoint.
- Max
Chunk intSize In Bytes - Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). This attribute is applicable for endpoint type
AzureIotHub.StorageContainer. - Resource
Group stringName - The resource group in which the endpoint will be created.
- name String
- The name of the endpoint. The name must be unique across endpoint types. The following names are reserved:
events,operationsMonitoringEvents,fileNotificationsand$default. - type String
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - authentication
Type String - Type used to authenticate against the endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased. - batch
Frequency IntegerIn Seconds - Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. This attribute is applicable for endpoint type
AzureIotHub.StorageContainer. - connection
String String - The connection string for the endpoint. This attribute is mandatory and can only be specified when
authentication_typeiskeyBased. - container
Name String - The name of storage container in the storage account. This attribute is mandatory for endpoint type
AzureIotHub.StorageContainer. - encoding String
- Encoding that is used to serialize messages to blobs. Supported values are
Avro,AvroDeflateandJSON. Default value isAvro. This attribute is applicable for endpoint typeAzureIotHub.StorageContainer. Changing this forces a new resource to be created. - endpoint
Uri String - URI of the Service Bus or Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBasedfor endpoint typeAzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - entity
Path String - Name of the Service Bus Queue/Topic or Event Hub. This attribute can only be specified and is mandatory when
authentication_typeisidentityBasedfor endpoint typeAzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - file
Name StringFormat - File name format for the blob. Default format is
{iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. This attribute is applicable for endpoint typeAzureIotHub.StorageContainer. - identity
Id String - ID of the User Managed Identity used to authenticate against the endpoint.
- max
Chunk IntegerSize In Bytes - Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). This attribute is applicable for endpoint type
AzureIotHub.StorageContainer. - resource
Group StringName - The resource group in which the endpoint will be created.
- name string
- The name of the endpoint. The name must be unique across endpoint types. The following names are reserved:
events,operationsMonitoringEvents,fileNotificationsand$default. - type string
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - authentication
Type string - Type used to authenticate against the endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased. - batch
Frequency numberIn Seconds - Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. This attribute is applicable for endpoint type
AzureIotHub.StorageContainer. - connection
String string - The connection string for the endpoint. This attribute is mandatory and can only be specified when
authentication_typeiskeyBased. - container
Name string - The name of storage container in the storage account. This attribute is mandatory for endpoint type
AzureIotHub.StorageContainer. - encoding string
- Encoding that is used to serialize messages to blobs. Supported values are
Avro,AvroDeflateandJSON. Default value isAvro. This attribute is applicable for endpoint typeAzureIotHub.StorageContainer. Changing this forces a new resource to be created. - endpoint
Uri string - URI of the Service Bus or Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBasedfor endpoint typeAzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - entity
Path string - Name of the Service Bus Queue/Topic or Event Hub. This attribute can only be specified and is mandatory when
authentication_typeisidentityBasedfor endpoint typeAzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - file
Name stringFormat - File name format for the blob. Default format is
{iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. This attribute is applicable for endpoint typeAzureIotHub.StorageContainer. - identity
Id string - ID of the User Managed Identity used to authenticate against the endpoint.
- max
Chunk numberSize In Bytes - Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). This attribute is applicable for endpoint type
AzureIotHub.StorageContainer. - resource
Group stringName - The resource group in which the endpoint will be created.
- name str
- The name of the endpoint. The name must be unique across endpoint types. The following names are reserved:
events,operationsMonitoringEvents,fileNotificationsand$default. - type str
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - authentication_
type str - Type used to authenticate against the endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased. - batch_
frequency_ intin_ seconds - Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. This attribute is applicable for endpoint type
AzureIotHub.StorageContainer. - connection_
string str - The connection string for the endpoint. This attribute is mandatory and can only be specified when
authentication_typeiskeyBased. - container_
name str - The name of storage container in the storage account. This attribute is mandatory for endpoint type
AzureIotHub.StorageContainer. - encoding str
- Encoding that is used to serialize messages to blobs. Supported values are
Avro,AvroDeflateandJSON. Default value isAvro. This attribute is applicable for endpoint typeAzureIotHub.StorageContainer. Changing this forces a new resource to be created. - endpoint_
uri str - URI of the Service Bus or Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBasedfor endpoint typeAzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - entity_
path str - Name of the Service Bus Queue/Topic or Event Hub. This attribute can only be specified and is mandatory when
authentication_typeisidentityBasedfor endpoint typeAzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - file_
name_ strformat - File name format for the blob. Default format is
{iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. This attribute is applicable for endpoint typeAzureIotHub.StorageContainer. - identity_
id str - ID of the User Managed Identity used to authenticate against the endpoint.
- max_
chunk_ intsize_ in_ bytes - Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). This attribute is applicable for endpoint type
AzureIotHub.StorageContainer. - resource_
group_ strname - The resource group in which the endpoint will be created.
- name String
- The name of the endpoint. The name must be unique across endpoint types. The following names are reserved:
events,operationsMonitoringEvents,fileNotificationsand$default. - type String
- The type of the endpoint. Possible values are
AzureIotHub.StorageContainer,AzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - authentication
Type String - Type used to authenticate against the endpoint. Possible values are
keyBasedandidentityBased. Defaults tokeyBased. - batch
Frequency NumberIn Seconds - Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. This attribute is applicable for endpoint type
AzureIotHub.StorageContainer. - connection
String String - The connection string for the endpoint. This attribute is mandatory and can only be specified when
authentication_typeiskeyBased. - container
Name String - The name of storage container in the storage account. This attribute is mandatory for endpoint type
AzureIotHub.StorageContainer. - encoding String
- Encoding that is used to serialize messages to blobs. Supported values are
Avro,AvroDeflateandJSON. Default value isAvro. This attribute is applicable for endpoint typeAzureIotHub.StorageContainer. Changing this forces a new resource to be created. - endpoint
Uri String - URI of the Service Bus or Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when
authentication_typeisidentityBasedfor endpoint typeAzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - entity
Path String - Name of the Service Bus Queue/Topic or Event Hub. This attribute can only be specified and is mandatory when
authentication_typeisidentityBasedfor endpoint typeAzureIotHub.ServiceBusQueue,AzureIotHub.ServiceBusTopicorAzureIotHub.EventHub. - file
Name StringFormat - File name format for the blob. Default format is
{iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. This attribute is applicable for endpoint typeAzureIotHub.StorageContainer. - identity
Id String - ID of the User Managed Identity used to authenticate against the endpoint.
- max
Chunk NumberSize In Bytes - Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). This attribute is applicable for endpoint type
AzureIotHub.StorageContainer. - resource
Group StringName - The resource group in which the endpoint will be created.
IoTHubEnrichment, IoTHubEnrichmentArgs
- Endpoint
Names List<string> - The list of endpoints which will be enriched.
- Key string
- The key of the enrichment.
- 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 []string - The list of endpoints which will be enriched.
- Key string
- The key of the enrichment.
- 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 List<String> - The list of endpoints which will be enriched.
- key String
- The key of the enrichment.
- 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 string[] - The list of endpoints which will be enriched.
- key string
- The key of the enrichment.
- 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.
- key str
- The key of the enrichment.
- 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)
- endpoint
Names List<String> - The list of endpoints which will be enriched.
- key String
- The key of the enrichment.
- 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)
IoTHubFallbackRoute, IoTHubFallbackRouteArgs
- Condition string
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
- Enabled bool
- Used to specify whether the fallback route is enabled.
- Endpoint
Names List<string> - The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
- Source string
- The source that the routing rule is to be applied to, such as
DeviceMessages. Possible values include:Invalid,DeviceMessages,TwinChangeEvents,DeviceLifecycleEvents,DeviceConnectionStateEvents,DeviceJobLifecycleEvents.
- Condition string
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
- Enabled bool
- Used to specify whether the fallback route is enabled.
- Endpoint
Names []string - The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
- Source string
- The source that the routing rule is to be applied to, such as
DeviceMessages. Possible values include:Invalid,DeviceMessages,TwinChangeEvents,DeviceLifecycleEvents,DeviceConnectionStateEvents,DeviceJobLifecycleEvents.
- condition String
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
- enabled Boolean
- Used to specify whether the fallback route is enabled.
- endpoint
Names List<String> - The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
- source String
- The source that the routing rule is to be applied to, such as
DeviceMessages. Possible values include:Invalid,DeviceMessages,TwinChangeEvents,DeviceLifecycleEvents,DeviceConnectionStateEvents,DeviceJobLifecycleEvents.
- condition string
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
- enabled boolean
- Used to specify whether the fallback route is enabled.
- endpoint
Names string[] - The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
- source string
- The source that the routing rule is to be applied to, such as
DeviceMessages. Possible values include:Invalid,DeviceMessages,TwinChangeEvents,DeviceLifecycleEvents,DeviceConnectionStateEvents,DeviceJobLifecycleEvents.
- condition str
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
- enabled bool
- Used to specify whether the fallback route is enabled.
- endpoint_
names Sequence[str] - The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
- source str
- The source that the routing rule is to be applied to, such as
DeviceMessages. Possible values include:Invalid,DeviceMessages,TwinChangeEvents,DeviceLifecycleEvents,DeviceConnectionStateEvents,DeviceJobLifecycleEvents.
- condition String
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
- enabled Boolean
- Used to specify whether the fallback route is enabled.
- endpoint
Names List<String> - The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
- source String
- The source that the routing rule is to be applied to, such as
DeviceMessages. Possible values include:Invalid,DeviceMessages,TwinChangeEvents,DeviceLifecycleEvents,DeviceConnectionStateEvents,DeviceJobLifecycleEvents.
IoTHubFileUpload, IoTHubFileUploadArgs
- Connection
String string - The connection string for the Azure Storage account to which files are uploaded.
- Container
Name string - The name of the root container where you upload files. The container need not exist but should be creatable using the connection_string specified.
- Default
Ttl string - The period of time for which a file upload notification message is available to consume before it is expired by the IoT hub, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default. - Lock
Duration string - The lock duration for the file upload notifications queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to
PT1Mby default. - Max
Delivery intCount - The number of times the IoT hub attempts to deliver a file upload notification message. It evaluates to
10by default. - Notifications bool
- Used to specify whether file notifications are sent to IoT Hub on upload. It evaluates to false by default.
- Sas
Ttl string - The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 24 hours, and evaluates to
PT1Hby default.
- Connection
String string - The connection string for the Azure Storage account to which files are uploaded.
- Container
Name string - The name of the root container where you upload files. The container need not exist but should be creatable using the connection_string specified.
- Default
Ttl string - The period of time for which a file upload notification message is available to consume before it is expired by the IoT hub, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default. - Lock
Duration string - The lock duration for the file upload notifications queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to
PT1Mby default. - Max
Delivery intCount - The number of times the IoT hub attempts to deliver a file upload notification message. It evaluates to
10by default. - Notifications bool
- Used to specify whether file notifications are sent to IoT Hub on upload. It evaluates to false by default.
- Sas
Ttl string - The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 24 hours, and evaluates to
PT1Hby default.
- connection
String String - The connection string for the Azure Storage account to which files are uploaded.
- container
Name String - The name of the root container where you upload files. The container need not exist but should be creatable using the connection_string specified.
- default
Ttl String - The period of time for which a file upload notification message is available to consume before it is expired by the IoT hub, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default. - lock
Duration String - The lock duration for the file upload notifications queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to
PT1Mby default. - max
Delivery IntegerCount - The number of times the IoT hub attempts to deliver a file upload notification message. It evaluates to
10by default. - notifications Boolean
- Used to specify whether file notifications are sent to IoT Hub on upload. It evaluates to false by default.
- sas
Ttl String - The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 24 hours, and evaluates to
PT1Hby default.
- connection
String string - The connection string for the Azure Storage account to which files are uploaded.
- container
Name string - The name of the root container where you upload files. The container need not exist but should be creatable using the connection_string specified.
- default
Ttl string - The period of time for which a file upload notification message is available to consume before it is expired by the IoT hub, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default. - lock
Duration string - The lock duration for the file upload notifications queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to
PT1Mby default. - max
Delivery numberCount - The number of times the IoT hub attempts to deliver a file upload notification message. It evaluates to
10by default. - notifications boolean
- Used to specify whether file notifications are sent to IoT Hub on upload. It evaluates to false by default.
- sas
Ttl string - The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 24 hours, and evaluates to
PT1Hby default.
- connection_
string str - The connection string for the Azure Storage account to which files are uploaded.
- container_
name str - The name of the root container where you upload files. The container need not exist but should be creatable using the connection_string specified.
- default_
ttl str - The period of time for which a file upload notification message is available to consume before it is expired by the IoT hub, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default. - lock_
duration str - The lock duration for the file upload notifications queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to
PT1Mby default. - max_
delivery_ intcount - The number of times the IoT hub attempts to deliver a file upload notification message. It evaluates to
10by default. - notifications bool
- Used to specify whether file notifications are sent to IoT Hub on upload. It evaluates to false by default.
- sas_
ttl str - The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 24 hours, and evaluates to
PT1Hby default.
- connection
String String - The connection string for the Azure Storage account to which files are uploaded.
- container
Name String - The name of the root container where you upload files. The container need not exist but should be creatable using the connection_string specified.
- default
Ttl String - The period of time for which a file upload notification message is available to consume before it is expired by the IoT hub, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to
PT1Hby default. - lock
Duration String - The lock duration for the file upload notifications queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to
PT1Mby default. - max
Delivery NumberCount - The number of times the IoT hub attempts to deliver a file upload notification message. It evaluates to
10by default. - notifications Boolean
- Used to specify whether file notifications are sent to IoT Hub on upload. It evaluates to false by default.
- sas
Ttl String - The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 24 hours, and evaluates to
PT1Hby default.
IoTHubIdentity, IoTHubIdentityArgs
- Type string
- The type of Managed Identity which should be assigned to the Iot Hub. Possible values are
SystemAssigned,UserAssignedandSystemAssigned, UserAssigned. - Identity
Ids List<string> - A list of User Managed Identity ID's which should be assigned to the Iot Hub.
- Principal
Id string - The ID of the System Managed Service Principal.
- Tenant
Id string - The ID of the Tenant the System Managed Service Principal is assigned in.
- Type string
- The type of Managed Identity which should be assigned to the Iot Hub. Possible values are
SystemAssigned,UserAssignedandSystemAssigned, UserAssigned. - Identity
Ids []string - A list of User Managed Identity ID's which should be assigned to the Iot Hub.
- Principal
Id string - The ID of the System Managed Service Principal.
- Tenant
Id string - The ID of the Tenant the System Managed Service Principal is assigned in.
- type String
- The type of Managed Identity which should be assigned to the Iot Hub. Possible values are
SystemAssigned,UserAssignedandSystemAssigned, UserAssigned. - identity
Ids List<String> - A list of User Managed Identity ID's which should be assigned to the Iot Hub.
- principal
Id String - The ID of the System Managed Service Principal.
- tenant
Id String - The ID of the Tenant the System Managed Service Principal is assigned in.
- type string
- The type of Managed Identity which should be assigned to the Iot Hub. Possible values are
SystemAssigned,UserAssignedandSystemAssigned, UserAssigned. - identity
Ids string[] - A list of User Managed Identity ID's which should be assigned to the Iot Hub.
- principal
Id string - The ID of the System Managed Service Principal.
- tenant
Id string - The ID of the Tenant the System Managed Service Principal is assigned in.
- type str
- The type of Managed Identity which should be assigned to the Iot Hub. Possible values are
SystemAssigned,UserAssignedandSystemAssigned, UserAssigned. - identity_
ids Sequence[str] - A list of User Managed Identity ID's which should be assigned to the Iot Hub.
- principal_
id str - The ID of the System Managed Service Principal.
- tenant_
id str - The ID of the Tenant the System Managed Service Principal is assigned in.
- type String
- The type of Managed Identity which should be assigned to the Iot Hub. Possible values are
SystemAssigned,UserAssignedandSystemAssigned, UserAssigned. - identity
Ids List<String> - A list of User Managed Identity ID's which should be assigned to the Iot Hub.
- principal
Id String - The ID of the System Managed Service Principal.
- tenant
Id String - The ID of the Tenant the System Managed Service Principal is assigned in.
IoTHubIpFilterRule, IoTHubIpFilterRuleArgs
IoTHubNetworkRuleSet, IoTHubNetworkRuleSetArgs
- Apply
To boolBuiltin Eventhub Endpoint - Determines if Network Rule Set is also applied to the BuiltIn EventHub EndPoint of the IotHub. Defaults to
false. - Default
Action string - Default Action for Network Rule Set. Possible values are
DefaultActionDeny,DefaultActionAllow. Defaults toDefaultActionDeny. - Ip
Rules List<IoTHub Network Rule Set Ip Rule> - One or more
ip_ruleblocks as defined below.
- Apply
To boolBuiltin Eventhub Endpoint - Determines if Network Rule Set is also applied to the BuiltIn EventHub EndPoint of the IotHub. Defaults to
false. - Default
Action string - Default Action for Network Rule Set. Possible values are
DefaultActionDeny,DefaultActionAllow. Defaults toDefaultActionDeny. - Ip
Rules []IoTHub Network Rule Set Ip Rule - One or more
ip_ruleblocks as defined below.
- apply
To BooleanBuiltin Eventhub Endpoint - Determines if Network Rule Set is also applied to the BuiltIn EventHub EndPoint of the IotHub. Defaults to
false. - default
Action String - Default Action for Network Rule Set. Possible values are
DefaultActionDeny,DefaultActionAllow. Defaults toDefaultActionDeny. - ip
Rules List<IoTHub Network Rule Set Ip Rule> - One or more
ip_ruleblocks as defined below.
- apply
To booleanBuiltin Eventhub Endpoint - Determines if Network Rule Set is also applied to the BuiltIn EventHub EndPoint of the IotHub. Defaults to
false. - default
Action string - Default Action for Network Rule Set. Possible values are
DefaultActionDeny,DefaultActionAllow. Defaults toDefaultActionDeny. - ip
Rules IoTHub Network Rule Set Ip Rule[] - One or more
ip_ruleblocks as defined below.
- apply_
to_ boolbuiltin_ eventhub_ endpoint - Determines if Network Rule Set is also applied to the BuiltIn EventHub EndPoint of the IotHub. Defaults to
false. - default_
action str - Default Action for Network Rule Set. Possible values are
DefaultActionDeny,DefaultActionAllow. Defaults toDefaultActionDeny. - ip_
rules Sequence[IoTHub Network Rule Set Ip Rule] - One or more
ip_ruleblocks as defined below.
- apply
To BooleanBuiltin Eventhub Endpoint - Determines if Network Rule Set is also applied to the BuiltIn EventHub EndPoint of the IotHub. Defaults to
false. - default
Action String - Default Action for Network Rule Set. Possible values are
DefaultActionDeny,DefaultActionAllow. Defaults toDefaultActionDeny. - ip
Rules List<Property Map> - One or more
ip_ruleblocks as defined below.
IoTHubNetworkRuleSetIpRule, IoTHubNetworkRuleSetIpRuleArgs
IoTHubRoute, IoTHubRouteArgs
- Enabled bool
- Used to specify whether a route is enabled.
- Endpoint
Names List<string> - The list of endpoints to which messages that satisfy the condition are routed.
- Name string
- The name of the route.
- Source string
- The source that the routing rule is to be applied to, such as
DeviceMessages. Possible values include:Invalid,DeviceMessages,TwinChangeEvents,DeviceLifecycleEvents,DeviceConnectionStateEvents,DeviceJobLifecycleEvents. - Condition string
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
- Enabled bool
- Used to specify whether a route is enabled.
- Endpoint
Names []string - The list of endpoints to which messages that satisfy the condition are routed.
- Name string
- The name of the route.
- Source string
- The source that the routing rule is to be applied to, such as
DeviceMessages. Possible values include:Invalid,DeviceMessages,TwinChangeEvents,DeviceLifecycleEvents,DeviceConnectionStateEvents,DeviceJobLifecycleEvents. - Condition string
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
- enabled Boolean
- Used to specify whether a route is enabled.
- endpoint
Names List<String> - The list of endpoints to which messages that satisfy the condition are routed.
- name String
- The name of the route.
- source String
- The source that the routing rule is to be applied to, such as
DeviceMessages. Possible values include:Invalid,DeviceMessages,TwinChangeEvents,DeviceLifecycleEvents,DeviceConnectionStateEvents,DeviceJobLifecycleEvents. - condition String
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
- enabled boolean
- Used to specify whether a route is enabled.
- endpoint
Names string[] - The list of endpoints to which messages that satisfy the condition are routed.
- name string
- The name of the route.
- source string
- The source that the routing rule is to be applied to, such as
DeviceMessages. Possible values include:Invalid,DeviceMessages,TwinChangeEvents,DeviceLifecycleEvents,DeviceConnectionStateEvents,DeviceJobLifecycleEvents. - condition string
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
- enabled bool
- Used to specify whether a route is enabled.
- endpoint_
names Sequence[str] - The list of endpoints to which messages that satisfy the condition are routed.
- name str
- The name of the route.
- source str
- The source that the routing rule is to be applied to, such as
DeviceMessages. Possible values include:Invalid,DeviceMessages,TwinChangeEvents,DeviceLifecycleEvents,DeviceConnectionStateEvents,DeviceJobLifecycleEvents. - condition str
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
- enabled Boolean
- Used to specify whether a route is enabled.
- endpoint
Names List<String> - The list of endpoints to which messages that satisfy the condition are routed.
- name String
- The name of the route.
- source String
- The source that the routing rule is to be applied to, such as
DeviceMessages. Possible values include:Invalid,DeviceMessages,TwinChangeEvents,DeviceLifecycleEvents,DeviceConnectionStateEvents,DeviceJobLifecycleEvents. - condition String
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
IoTHubSharedAccessPolicy, IoTHubSharedAccessPolicyArgs
- Key
Name string - The name of the shared access policy.
- Permissions string
- The permissions assigned to the shared access policy.
- Primary
Key string - The primary key.
- Secondary
Key string - The secondary key.
- Key
Name string - The name of the shared access policy.
- Permissions string
- The permissions assigned to the shared access policy.
- Primary
Key string - The primary key.
- Secondary
Key string - The secondary key.
- key
Name String - The name of the shared access policy.
- permissions String
- The permissions assigned to the shared access policy.
- primary
Key String - The primary key.
- secondary
Key String - The secondary key.
- key
Name string - The name of the shared access policy.
- permissions string
- The permissions assigned to the shared access policy.
- primary
Key string - The primary key.
- secondary
Key string - The secondary key.
- key_
name str - The name of the shared access policy.
- permissions str
- The permissions assigned to the shared access policy.
- primary_
key str - The primary key.
- secondary_
key str - The secondary key.
- key
Name String - The name of the shared access policy.
- permissions String
- The permissions assigned to the shared access policy.
- primary
Key String - The primary key.
- secondary
Key String - The secondary key.
IoTHubSku, IoTHubSkuArgs
Import
IoTHubs can be imported using the resource id, e.g.
$ pulumi import azure:iot/ioTHub:IoTHub hub1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Devices/IotHubs/hub1
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
azurermTerraform Provider.
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi