This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

iot¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.iot.AwaitableGetDpsResult(allocation_policy=None, device_provisioning_host_name=None, id=None, id_scope=None, location=None, name=None, resource_group_name=None, service_operations_host_name=None, tags=None)¶

class pulumi_azure.iot.AwaitableGetDpsSharedAccessPolicyResult(id=None, iothub_dps_name=None, name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None)¶

class pulumi_azure.iot.AwaitableGetSharedAccessPolicyResult(id=None, iothub_name=None, name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None)¶

class pulumi_azure.iot.ConsumerGroup(resource_name, opts=None, eventhub_endpoint_name=None, iothub_name=None, name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Consumer Group within an IotHub

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_io_t_hub = azure.iot.IoTHub("exampleIoTHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku={
        "name": "S1",
        "capacity": "1",
    },
    tags={
        "purpose": "testing",
    })
example_consumer_group = azure.iot.ConsumerGroup("exampleConsumerGroup",
    iothub_name=example_io_t_hub.name,
    eventhub_endpoint_name="events",
    resource_group_name=example_resource_group.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
eventhub_endpoint_name (pulumi.Input[str]) – The name of the Event Hub-compatible endpoint in the IoT hub. Changing this forces a new resource to be created.
iothub_name (pulumi.Input[str]) – The name of the IoT Hub. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The name of this Consumer Group. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group that contains the IoT hub. Changing this forces a new resource to be created.

eventhub_endpoint_name: pulumi.Output[str] = None¶: The name of the Event Hub-compatible endpoint in the IoT hub. Changing this forces a new resource to be created.

iothub_name: pulumi.Output[str] = None¶: The name of the IoT Hub. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of this Consumer Group. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group that contains the IoT hub. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, eventhub_endpoint_name=None, iothub_name=None, name=None, resource_group_name=None)¶

Get an existing ConsumerGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
eventhub_endpoint_name (pulumi.Input[str]) – The name of the Event Hub-compatible endpoint in the IoT hub. Changing this forces a new resource to be created.
iothub_name (pulumi.Input[str]) – The name of the IoT Hub. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The name of this Consumer Group. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group that contains the IoT hub. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.iot.DpsSharedAccessPolicy(resource_name, opts=None, enrollment_read=None, enrollment_write=None, iothub_dps_name=None, name=None, registration_read=None, registration_write=None, resource_group_name=None, service_config=None, __props__=None, __name__=None, __opts__=None)¶

Manages an IotHub Device Provisioning Service Shared Access Policy

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_iot_hub_dps = azure.iot.IotHubDps("exampleIotHubDps",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku={
        "name": "S1",
        "capacity": "1",
    })
example_dps_shared_access_policy = azure.iot.DpsSharedAccessPolicy("exampleDpsSharedAccessPolicy",
    resource_group_name=example_resource_group.name,
    iothub_dps_name=example_iot_hub_dps.name,
    enrollment_write=True,
    enrollment_read=True)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
enrollment_read (pulumi.Input[bool]) – Adds EnrollmentRead permission to this Shared Access Account. It allows read access to enrollment data.
enrollment_write (pulumi.Input[bool]) – Adds EnrollmentWrite permission to this Shared Access Account. It allows write access to enrollment data.
iothub_dps_name (pulumi.Input[str]) – The name of the IoT Hub Device Provisioning service to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
registration_read (pulumi.Input[bool]) – Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.
registration_write (pulumi.Input[bool]) – Adds RegistrationStatusWrite permission to this Shared Access Account. It allows write access to device registrations.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the IotHub Shared Access Policy resource has to be created. Changing this forces a new resource to be created.
service_config (pulumi.Input[bool]) – Adds ServiceConfig permission to this Shared Access Account. It allows configuration of the Device Provisioning Service.

enrollment_read: pulumi.Output[bool] = None¶: Adds EnrollmentRead permission to this Shared Access Account. It allows read access to enrollment data.

enrollment_write: pulumi.Output[bool] = None¶: Adds EnrollmentWrite permission to this Shared Access Account. It allows write access to enrollment data.

iothub_dps_name: pulumi.Output[str] = None¶: The name of the IoT Hub Device Provisioning service to which this Shared Access Policy belongs. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.

primary_connection_string: pulumi.Output[str] = None¶: The primary connection string of the Shared Access Policy.

primary_key: pulumi.Output[str] = None¶: The primary key used to create the authentication token.

registration_read: pulumi.Output[bool] = None¶: Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.

registration_write: pulumi.Output[bool] = None¶: Adds RegistrationStatusWrite permission to this Shared Access Account. It allows write access to device registrations.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group under which the IotHub Shared Access Policy resource has to be created. Changing this forces a new resource to be created.

secondary_connection_string: pulumi.Output[str] = None¶: The secondary connection string of the Shared Access Policy.

secondary_key: pulumi.Output[str] = None¶: The secondary key used to create the authentication token.

service_config: pulumi.Output[bool] = None¶: Adds ServiceConfig permission to this Shared Access Account. It allows configuration of the Device Provisioning Service.

static get(resource_name, id, opts=None, enrollment_read=None, enrollment_write=None, iothub_dps_name=None, name=None, primary_connection_string=None, primary_key=None, registration_read=None, registration_write=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, service_config=None)¶

Get an existing DpsSharedAccessPolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
enrollment_read (pulumi.Input[bool]) – Adds EnrollmentRead permission to this Shared Access Account. It allows read access to enrollment data.
enrollment_write (pulumi.Input[bool]) – Adds EnrollmentWrite permission to this Shared Access Account. It allows write access to enrollment data.
iothub_dps_name (pulumi.Input[str]) – The name of the IoT Hub Device Provisioning service to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
primary_connection_string (pulumi.Input[str]) – The primary connection string of the Shared Access Policy.
primary_key (pulumi.Input[str]) – The primary key used to create the authentication token.
registration_read (pulumi.Input[bool]) – Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.
registration_write (pulumi.Input[bool]) – Adds RegistrationStatusWrite permission to this Shared Access Account. It allows write access to device registrations.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the IotHub Shared Access Policy resource has to be created. Changing this forces a new resource to be created.
secondary_connection_string (pulumi.Input[str]) – The secondary connection string of the Shared Access Policy.
secondary_key (pulumi.Input[str]) – The secondary key used to create the authentication token.
service_config (pulumi.Input[bool]) – Adds ServiceConfig permission to this Shared Access Account. It allows configuration of the Device Provisioning Service.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.iot.EndpointEventhub(resource_name, opts=None, connection_string=None, iothub_name=None, name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages an IotHub EventHub Endpoint

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="East US")
example_event_hub_namespace = azure.eventhub.EventHubNamespace("exampleEventHubNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Basic")
example_event_hub = azure.eventhub.EventHub("exampleEventHub",
    namespace_name=example_event_hub_namespace.name,
    resource_group_name=example_resource_group.name,
    partition_count=2,
    message_retention=1)
example_authorization_rule = azure.eventhub.AuthorizationRule("exampleAuthorizationRule",
    namespace_name=example_event_hub_namespace.name,
    eventhub_name=example_event_hub.name,
    resource_group_name=example_resource_group.name,
    listen=False,
    send=True,
    manage=False)
example_io_t_hub = azure.iot.IoTHub("exampleIoTHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku={
        "name": "B1",
        "tier": "Basic",
        "capacity": "1",
    },
    tags={
        "purpose": "example",
    })
example_endpoint_eventhub = azure.iot.EndpointEventhub("exampleEndpointEventhub",
    resource_group_name=example_resource_group.name,
    iothub_name=example_io_t_hub.name,
    connection_string=example_authorization_rule.primary_connection_string)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
connection_string (pulumi.Input[str]) – The connection string for the endpoint.
name (pulumi.Input[str]) – The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

connection_string: pulumi.Output[str] = None¶: The connection string for the endpoint.

name: pulumi.Output[str] = None¶: The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

static get(resource_name, id, opts=None, connection_string=None, iothub_name=None, name=None, resource_group_name=None)¶

Get an existing EndpointEventhub resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
connection_string (pulumi.Input[str]) – The connection string for the endpoint.
name (pulumi.Input[str]) – The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.iot.EndpointServicebusQueue(resource_name, opts=None, connection_string=None, iothub_name=None, name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages an IotHub ServiceBus Queue Endpoint

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="East US")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard")
example_queue = azure.servicebus.Queue("exampleQueue",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name,
    enable_partitioning=True)
example_queue_authorization_rule = azure.servicebus.QueueAuthorizationRule("exampleQueueAuthorizationRule",
    namespace_name=example_namespace.name,
    queue_name=example_queue.name,
    resource_group_name=example_resource_group.name,
    listen=False,
    send=True,
    manage=False)
example_io_t_hub = azure.iot.IoTHub("exampleIoTHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku={
        "name": "B1",
        "tier": "Basic",
        "capacity": "1",
    },
    tags={
        "purpose": "example",
    })
example_endpoint_servicebus_queue = azure.iot.EndpointServicebusQueue("exampleEndpointServicebusQueue",
    resource_group_name=example_resource_group.name,
    iothub_name=example_io_t_hub.name,
    connection_string=example_queue_authorization_rule.primary_connection_string)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
connection_string (pulumi.Input[str]) – The connection string for the endpoint.
name (pulumi.Input[str]) – The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

connection_string: pulumi.Output[str] = None¶: The connection string for the endpoint.

name: pulumi.Output[str] = None¶: The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

static get(resource_name, id, opts=None, connection_string=None, iothub_name=None, name=None, resource_group_name=None)¶

Get an existing EndpointServicebusQueue resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
connection_string (pulumi.Input[str]) – The connection string for the endpoint.
name (pulumi.Input[str]) – The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.iot.EndpointServicebusTopic(resource_name, opts=None, connection_string=None, iothub_name=None, name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages an IotHub ServiceBus Topic Endpoint

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="East US")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard")
example_topic = azure.servicebus.Topic("exampleTopic",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name)
example_topic_authorization_rule = azure.servicebus.TopicAuthorizationRule("exampleTopicAuthorizationRule",
    namespace_name=example_namespace.name,
    topic_name=example_topic.name,
    resource_group_name=example_resource_group.name,
    listen=False,
    send=True,
    manage=False)
example_io_t_hub = azure.iot.IoTHub("exampleIoTHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku={
        "name": "B1",
        "tier": "Basic",
        "capacity": "1",
    },
    tags={
        "purpose": "example",
    })
example_endpoint_servicebus_topic = azure.iot.EndpointServicebusTopic("exampleEndpointServicebusTopic",
    resource_group_name=example_resource_group.name,
    iothub_name=example_io_t_hub.name,
    connection_string=example_topic_authorization_rule.primary_connection_string)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
connection_string (pulumi.Input[str]) – The connection string for the endpoint.
name (pulumi.Input[str]) – The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

connection_string: pulumi.Output[str] = None¶: The connection string for the endpoint.

name: pulumi.Output[str] = None¶: The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

static get(resource_name, id, opts=None, connection_string=None, iothub_name=None, name=None, resource_group_name=None)¶

Get an existing EndpointServicebusTopic resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
connection_string (pulumi.Input[str]) – The connection string for the endpoint.
name (pulumi.Input[str]) – The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.iot.EndpointStorageContainer(resource_name, opts=None, batch_frequency_in_seconds=None, connection_string=None, container_name=None, encoding=None, file_name_format=None, iothub_name=None, max_chunk_size_in_bytes=None, name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages an IotHub Storage Container Endpoint

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
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_io_t_hub = azure.iot.IoTHub("exampleIoTHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku={
        "name": "S1",
        "capacity": "1",
    })
example_endpoint_storage_container = azure.iot.EndpointStorageContainer("exampleEndpointStorageContainer",
    resource_group_name=example_resource_group.name,
    iothub_name=example_io_t_hub.name,
    container_name="acctestcont",
    connection_string=example_account.primary_blob_connection_string,
    file_name_format="{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
    batch_frequency_in_seconds=60,
    max_chunk_size_in_bytes=10485760,
    encoding="JSON")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
batch_frequency_in_seconds (pulumi.Input[float]) – Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
connection_string (pulumi.Input[str]) – The connection string for the endpoint.
container_name (pulumi.Input[str]) – The name of storage container in the storage account. *
encoding (pulumi.Input[str]) – Encoding that is used to serialize messages to blobs. Supported values are ‘avro’ and ‘avrodeflate’. Default value is ‘avro’.
file_name_format (pulumi.Input[str]) – File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.
iothub_name (pulumi.Input[str]) – The name of the IoTHub to which this Storage Container Endpoint belongs. Changing this forces a new resource to be created.
max_chunk_size_in_bytes (pulumi.Input[float]) – Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
name (pulumi.Input[str]) – The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the IotHub Storage Container Endpoint resource has to be created. Changing this forces a new resource to be created.

batch_frequency_in_seconds: pulumi.Output[float] = None¶: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.

connection_string: pulumi.Output[str] = None¶: The connection string for the endpoint.

container_name: pulumi.Output[str] = None¶: The name of storage container in the storage account. *

encoding: pulumi.Output[str] = None¶: Encoding that is used to serialize messages to blobs. Supported values are ‘avro’ and ‘avrodeflate’. Default value is ‘avro’.

file_name_format: pulumi.Output[str] = None¶: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

iothub_name: pulumi.Output[str] = None¶: The name of the IoTHub to which this Storage Container Endpoint belongs. Changing this forces a new resource to be created.

max_chunk_size_in_bytes: pulumi.Output[float] = None¶: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).

name: pulumi.Output[str] = None¶: The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group under which the IotHub Storage Container Endpoint resource has to be created. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, batch_frequency_in_seconds=None, connection_string=None, container_name=None, encoding=None, file_name_format=None, iothub_name=None, max_chunk_size_in_bytes=None, name=None, resource_group_name=None)¶

Get an existing EndpointStorageContainer resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
batch_frequency_in_seconds (pulumi.Input[float]) – Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
connection_string (pulumi.Input[str]) – The connection string for the endpoint.
container_name (pulumi.Input[str]) – The name of storage container in the storage account. *
encoding (pulumi.Input[str]) – Encoding that is used to serialize messages to blobs. Supported values are ‘avro’ and ‘avrodeflate’. Default value is ‘avro’.
file_name_format (pulumi.Input[str]) – File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.
iothub_name (pulumi.Input[str]) – The name of the IoTHub to which this Storage Container Endpoint belongs. Changing this forces a new resource to be created.
max_chunk_size_in_bytes (pulumi.Input[float]) – Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
name (pulumi.Input[str]) – The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the IotHub Storage Container Endpoint resource has to be created. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.iot.FallbackRoute(resource_name, opts=None, condition=None, enabled=None, endpoint_names=None, iothub_name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages an IotHub Fallback Route

Note: Fallback route can be defined either directly on the iot.IoTHub resource, or using the iot.FallbackRoute resource - but the two cannot be used together. If both are used against the same IoTHub, spurious changes will occur.
Note: Since this resource is provisioned by default, the Azure Provider will not check for the presence of an existing resource prior to attempting to create it.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
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_io_t_hub = azure.iot.IoTHub("exampleIoTHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku={
        "name": "S1",
        "capacity": "1",
    },
    tags={
        "purpose": "testing",
    })
example_endpoint_storage_container = azure.iot.EndpointStorageContainer("exampleEndpointStorageContainer",
    resource_group_name=example_resource_group.name,
    iothub_name=example_io_t_hub.name,
    connection_string=example_account.primary_blob_connection_string,
    batch_frequency_in_seconds=60,
    max_chunk_size_in_bytes=10485760,
    container_name=example_container.name,
    encoding="Avro",
    file_name_format="{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}")
example_fallback_route = azure.iot.FallbackRoute("exampleFallbackRoute",
    resource_group_name=example_resource_group.name,
    iothub_name=example_io_t_hub.name,
    condition="true",
    endpoint_names=[example_endpoint_storage_container.name],
    enabled=True)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
condition (pulumi.Input[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 (pulumi.Input[bool]) – Used to specify whether the fallback route is enabled.
endpoint_names (pulumi.Input[str]) – The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
iothub_name (pulumi.Input[str]) – The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the IotHub Storage Container Endpoint resource has to be created. Changing this forces a new resource to be created.

condition: pulumi.Output[str] = None¶: 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: pulumi.Output[bool] = None¶: Used to specify whether the fallback route is enabled.

endpoint_names: pulumi.Output[str] = None¶: The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.

iothub_name: pulumi.Output[str] = None¶: The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group under which the IotHub Storage Container Endpoint resource has to be created. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, condition=None, enabled=None, endpoint_names=None, iothub_name=None, resource_group_name=None)¶

Get an existing FallbackRoute resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
condition (pulumi.Input[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 (pulumi.Input[bool]) – Used to specify whether the fallback route is enabled.
endpoint_names (pulumi.Input[str]) – The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
iothub_name (pulumi.Input[str]) – The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the IotHub Storage Container Endpoint resource has to be created. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.iot.GetDpsResult(allocation_policy=None, device_provisioning_host_name=None, id=None, id_scope=None, location=None, name=None, resource_group_name=None, service_operations_host_name=None, tags=None)¶

A collection of values returned by getDps.

allocation_policy = None¶: The allocation policy of the IoT Device Provisioning Service.

device_provisioning_host_name = None¶: The device endpoint of the IoT Device Provisioning Service.

id = None¶: The provider-assigned unique ID for this managed resource.

id_scope = None¶: The unique identifier of the IoT Device Provisioning Service.

location = None¶: Specifies the supported Azure location where the IoT Device Provisioning Service exists.

service_operations_host_name = None¶: The service endpoint of the IoT Device Provisioning Service.

class pulumi_azure.iot.GetDpsSharedAccessPolicyResult(id=None, iothub_dps_name=None, name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None)¶

A collection of values returned by getDpsSharedAccessPolicy.

id = None¶: The provider-assigned unique ID for this managed resource.

primary_connection_string = None¶: The primary connection string of the Shared Access Policy.

primary_key = None¶: The primary key used to create the authentication token.

secondary_connection_string = None¶: The secondary connection string of the Shared Access Policy.

secondary_key = None¶: The secondary key used to create the authentication token.

class pulumi_azure.iot.GetSharedAccessPolicyResult(id=None, iothub_name=None, name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None)¶

A collection of values returned by getSharedAccessPolicy.

id = None¶: The provider-assigned unique ID for this managed resource.

primary_connection_string = None¶: The primary connection string of the Shared Access Policy.

primary_key = None¶: The primary key used to create the authentication token.

secondary_connection_string = None¶: The secondary connection string of the Shared Access Policy.

secondary_key = None¶: The secondary key used to create the authentication token.

class pulumi_azure.iot.IoTHub(resource_name, opts=None, endpoints=None, event_hub_partition_count=None, event_hub_retention_in_days=None, fallback_route=None, file_upload=None, ip_filter_rules=None, location=None, name=None, resource_group_name=None, routes=None, sku=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages an IotHub

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="Canada Central")
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={
        "name": "S1",
        "capacity": "1",
    },
    endpoint=[
        {
            "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}",
        },
        {
            "type": "AzureIotHub.EventHub",
            "connection_string": example_authorization_rule.primary_connection_string,
            "name": "export2",
        },
    ],
    route=[
        {
            "name": "export",
            "source": "DeviceMessages",
            "condition": "true",
            "endpoint_names": ["export"],
            "enabled": True,
        },
        {
            "name": "export2",
            "source": "DeviceMessages",
            "condition": "true",
            "endpoint_names": ["export2"],
            "enabled": True,
        },
    ],
    tags={
        "purpose": "testing",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
endpoints (pulumi.Input[list]) – An endpoint block as defined below.
event_hub_partition_count (pulumi.Input[float]) – The number of device-to-cloud partitions used by backing event hubs. Must be between 2 and 128.
event_hub_retention_in_days (pulumi.Input[float]) – The event hub retention to use in days. Must be between 1 and 7.
fallback_route (pulumi.Input[dict]) – A fallback_route block 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 (pulumi.Input[dict]) – A file_upload block as defined below.
ip_filter_rules (pulumi.Input[list]) – One or more ip_filter_rule blocks as defined below.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – 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 (pulumi.Input[list]) – A route block as defined below.
sku (pulumi.Input[dict]) – A sku block as defined below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The endpoints object supports the following:

batch_frequency_in_seconds (pulumi.Input[float]) - 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 mandatory for endpoint type AzureIotHub.StorageContainer.
connection_string (pulumi.Input[str]) - The connection string for the endpoint.
container_name (pulumi.Input[str]) - The name of storage container in the storage account. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
encoding (pulumi.Input[str]) - Encoding that is used to serialize messages to blobs. Supported values are ‘avro’ and ‘avrodeflate’. Default value is ‘avro’. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
file_name_format (pulumi.Input[str]) - 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 mandatory for endpoint type AzureIotHub.StorageContainer.
max_chunk_size_in_bytes (pulumi.Input[float]) - 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 mandatory for endpoint type AzureIotHub.StorageContainer.
name (pulumi.Input[str]) - The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.
type (pulumi.Input[str]) - The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

The fallback_route object supports the following:

condition (pulumi.Input[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 (pulumi.Input[bool]) - Used to specify whether the fallback route is enabled.
endpoint_names (pulumi.Input[list]) - The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
source (pulumi.Input[str]) - The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.

The file_upload object supports the following:

connection_string (pulumi.Input[str]) - The connection string for the Azure Storage account to which files are uploaded.
container_name (pulumi.Input[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 (pulumi.Input[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 ‘PT1H’ by default.
lock_duration (pulumi.Input[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 ‘PT1M’ by default.
max_delivery_count (pulumi.Input[float]) - The number of times the IoT hub attempts to deliver a file upload notification message. It evaluates to 10 by default.
notifications (pulumi.Input[bool]) - Used to specify whether file notifications are sent to IoT Hub on upload. It evaluates to false by default.
sasTtl (pulumi.Input[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 ‘PT1H’ by default.

The ip_filter_rules object supports the following:

action (pulumi.Input[str]) - The desired action for requests captured by this rule. Possible values are Accept, Reject
ipMask (pulumi.Input[str]) - The IP address range in CIDR notation for the rule.
name (pulumi.Input[str]) - The name of the filter.

The routes object supports the following:

condition (pulumi.Input[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 (pulumi.Input[bool]) - Used to specify whether a route is enabled.
endpoint_names (pulumi.Input[list]) - The list of endpoints to which messages that satisfy the condition are routed.
name (pulumi.Input[str]) - The name of the route.
source (pulumi.Input[str]) - The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.

The sku object supports the following:

capacity (pulumi.Input[float]) - The number of provisioned IoT Hub units.
name (pulumi.Input[str]) - The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

endpoints: pulumi.Output[list] = None¶

An endpoint block as defined below.

batch_frequency_in_seconds (float) - 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 mandatory for endpoint type AzureIotHub.StorageContainer.
connection_string (str) - The connection string for the endpoint.
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’ and ‘avrodeflate’. Default value is ‘avro’. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
file_name_format (str) - 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 mandatory for endpoint type AzureIotHub.StorageContainer.
max_chunk_size_in_bytes (float) - 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 mandatory for endpoint type AzureIotHub.StorageContainer.
name (str) - The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.
type (str) - The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

event_hub_events_endpoint: pulumi.Output[str] = None¶: The EventHub compatible endpoint for events data

event_hub_events_path: pulumi.Output[str] = None¶: The EventHub compatible path for events data

event_hub_operations_endpoint: pulumi.Output[str] = None¶: The EventHub compatible endpoint for operational data

event_hub_operations_path: pulumi.Output[str] = None¶: The EventHub compatible path for operational data

event_hub_partition_count: pulumi.Output[float] = None¶: The number of device-to-cloud partitions used by backing event hubs. Must be between 2 and 128.

event_hub_retention_in_days: pulumi.Output[float] = None¶: The event hub retention to use in days. Must be between 1 and 7.

fallback_route: pulumi.Output[dict] = None¶

A fallback_route block 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.

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 (list) - 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: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.

file_upload: pulumi.Output[dict] = None¶

A file_upload block as defined below.

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 ‘PT1H’ by 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 ‘PT1M’ by default.
max_delivery_count (float) - The number of times the IoT hub attempts to deliver a file upload notification message. It evaluates to 10 by default.
notifications (bool) - Used to specify whether file notifications are sent to IoT Hub on upload. It evaluates to false by default.
sasTtl (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 ‘PT1H’ by default.

hostname: pulumi.Output[str] = None¶: The hostname of the IotHub Resource.

ip_filter_rules: pulumi.Output[list] = None¶

One or more ip_filter_rule blocks as defined below.

action (str) - The desired action for requests captured by this rule. Possible values are Accept, Reject
ipMask (str) - The IP address range in CIDR notation for the rule.
name (str) - The name of the filter.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: 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: pulumi.Output[list] = None¶

A route block as defined below.

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 a route is enabled.
endpoint_names (list) - 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: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.

shared_access_policies: pulumi.Output[list] = None¶

One or more shared_access_policy blocks as defined below.

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.

sku: pulumi.Output[dict] = None¶

A sku block as defined below.

capacity (float) - The number of provisioned IoT Hub units.
name (str) - The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

type: pulumi.Output[str] = None¶: The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

static get(resource_name, id, opts=None, endpoints=None, event_hub_events_endpoint=None, event_hub_events_path=None, event_hub_operations_endpoint=None, event_hub_operations_path=None, event_hub_partition_count=None, event_hub_retention_in_days=None, fallback_route=None, file_upload=None, hostname=None, ip_filter_rules=None, location=None, name=None, resource_group_name=None, routes=None, shared_access_policies=None, sku=None, tags=None, type=None)¶

Get an existing IoTHub resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
endpoints (pulumi.Input[list]) – An endpoint block as defined below.
event_hub_events_endpoint (pulumi.Input[str]) – The EventHub compatible endpoint for events data
event_hub_events_path (pulumi.Input[str]) – The EventHub compatible path for events data
event_hub_operations_endpoint (pulumi.Input[str]) – The EventHub compatible endpoint for operational data
event_hub_operations_path (pulumi.Input[str]) – The EventHub compatible path for operational data
event_hub_partition_count (pulumi.Input[float]) – The number of device-to-cloud partitions used by backing event hubs. Must be between 2 and 128.
event_hub_retention_in_days (pulumi.Input[float]) – The event hub retention to use in days. Must be between 1 and 7.
fallback_route (pulumi.Input[dict]) – A fallback_route block 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 (pulumi.Input[dict]) – A file_upload block as defined below.
hostname (pulumi.Input[str]) – The hostname of the IotHub Resource.
ip_filter_rules (pulumi.Input[list]) – One or more ip_filter_rule blocks as defined below.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – 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 (pulumi.Input[list]) – A route block as defined below.
shared_access_policies (pulumi.Input[list]) – One or more shared_access_policy blocks as defined below.
sku (pulumi.Input[dict]) – A sku block as defined below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
type (pulumi.Input[str]) – The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

The endpoints object supports the following:

batch_frequency_in_seconds (pulumi.Input[float]) - 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 mandatory for endpoint type AzureIotHub.StorageContainer.
connection_string (pulumi.Input[str]) - The connection string for the endpoint.
container_name (pulumi.Input[str]) - The name of storage container in the storage account. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
encoding (pulumi.Input[str]) - Encoding that is used to serialize messages to blobs. Supported values are ‘avro’ and ‘avrodeflate’. Default value is ‘avro’. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
file_name_format (pulumi.Input[str]) - 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 mandatory for endpoint type AzureIotHub.StorageContainer.
max_chunk_size_in_bytes (pulumi.Input[float]) - 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 mandatory for endpoint type AzureIotHub.StorageContainer.
name (pulumi.Input[str]) - The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.
type (pulumi.Input[str]) - The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

The fallback_route object supports the following:

condition (pulumi.Input[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 (pulumi.Input[bool]) - Used to specify whether the fallback route is enabled.
endpoint_names (pulumi.Input[list]) - The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
source (pulumi.Input[str]) - The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.

The file_upload object supports the following:

connection_string (pulumi.Input[str]) - The connection string for the Azure Storage account to which files are uploaded.
container_name (pulumi.Input[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 (pulumi.Input[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 ‘PT1H’ by default.
lock_duration (pulumi.Input[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 ‘PT1M’ by default.
max_delivery_count (pulumi.Input[float]) - The number of times the IoT hub attempts to deliver a file upload notification message. It evaluates to 10 by default.
notifications (pulumi.Input[bool]) - Used to specify whether file notifications are sent to IoT Hub on upload. It evaluates to false by default.
sasTtl (pulumi.Input[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 ‘PT1H’ by default.

The ip_filter_rules object supports the following:

action (pulumi.Input[str]) - The desired action for requests captured by this rule. Possible values are Accept, Reject
ipMask (pulumi.Input[str]) - The IP address range in CIDR notation for the rule.
name (pulumi.Input[str]) - The name of the filter.

The routes object supports the following:

condition (pulumi.Input[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 (pulumi.Input[bool]) - Used to specify whether a route is enabled.
endpoint_names (pulumi.Input[list]) - The list of endpoints to which messages that satisfy the condition are routed.
name (pulumi.Input[str]) - The name of the route.
source (pulumi.Input[str]) - The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.

The shared_access_policies object supports the following:

key_name (pulumi.Input[str]) - The name of the shared access policy.
permissions (pulumi.Input[str]) - The permissions assigned to the shared access policy.
primary_key (pulumi.Input[str]) - The primary key.
secondary_key (pulumi.Input[str]) - The secondary key.

The sku object supports the following:

capacity (pulumi.Input[float]) - The number of provisioned IoT Hub units.
name (pulumi.Input[str]) - The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.iot.IotHubCertificate(resource_name, opts=None, certificate_content=None, iot_dps_name=None, name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages an IotHub Device Provisioning Service Certificate.

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
certificate_content (pulumi.Input[str]) – The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.
iot_dps_name (pulumi.Input[str]) – The name of the IoT Device Provisioning Service that this certificate will be attached to. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Iot Device Provisioning Service Certificate resource. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the Iot Device Provisioning Service Certificate resource has to be created. Changing this forces a new resource to be created.

certificate_content: pulumi.Output[str] = None¶: The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

iot_dps_name: pulumi.Output[str] = None¶: The name of the IoT Device Provisioning Service that this certificate will be attached to. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Iot Device Provisioning Service Certificate resource. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group under which the Iot Device Provisioning Service Certificate resource has to be created. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, certificate_content=None, iot_dps_name=None, name=None, resource_group_name=None)¶

Get an existing IotHubCertificate resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
certificate_content (pulumi.Input[str]) – The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.
iot_dps_name (pulumi.Input[str]) – The name of the IoT Device Provisioning Service that this certificate will be attached to. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Iot Device Provisioning Service Certificate resource. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the Iot Device Provisioning Service Certificate resource has to be created. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.iot.IotHubDps(resource_name, opts=None, linked_hubs=None, location=None, name=None, resource_group_name=None, sku=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages an IotHub Device Provisioning Service.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_iot_hub_dps = azure.iot.IotHubDps("exampleIotHubDps",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku={
        "name": "S1",
        "capacity": "1",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
linked_hubs (pulumi.Input[list]) – A linked_hub block as defined below.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the Iot Device Provisioning Service resource has to be created. Changing this forces a new resource to be created.
sku (pulumi.Input[dict]) – A sku block as defined below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The linked_hubs object supports the following:

allocationWeight (pulumi.Input[float]) - The weight applied to the IoT Hub. Defaults to 0.
applyAllocationPolicy (pulumi.Input[bool]) - Determines whether to apply allocation policies to the IoT Hub. Defaults to false.
connection_string (pulumi.Input[str]) - The connection string to connect to the IoT Hub. Changing this forces a new resource.
hostname (pulumi.Input[str]) - The IoT Hub hostname.
location (pulumi.Input[str]) - The location of the IoT hub. Changing this forces a new resource.

The sku object supports the following:

capacity (pulumi.Input[float]) - The number of provisioned IoT Device Provisioning Service units.
name (pulumi.Input[str]) - The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

allocation_policy: pulumi.Output[str] = None¶: The allocation policy of the IoT Device Provisioning Service.

device_provisioning_host_name: pulumi.Output[str] = None¶: The device endpoint of the IoT Device Provisioning Service.

id_scope: pulumi.Output[str] = None¶: The unique identifier of the IoT Device Provisioning Service.

linked_hubs: pulumi.Output[list] = None¶

A linked_hub block as defined below.

allocationWeight (float) - The weight applied to the IoT Hub. Defaults to 0.
applyAllocationPolicy (bool) - Determines whether to apply allocation policies to the IoT Hub. Defaults to false.
connection_string (str) - The connection string to connect to the IoT Hub. Changing this forces a new resource.
hostname (str) - The IoT Hub hostname.
location (str) - The location of the IoT hub. Changing this forces a new resource.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group under which the Iot Device Provisioning Service resource has to be created. Changing this forces a new resource to be created.

service_operations_host_name: pulumi.Output[str] = None¶: The service endpoint of the IoT Device Provisioning Service.

sku: pulumi.Output[dict] = None¶

A sku block as defined below.

capacity (float) - The number of provisioned IoT Device Provisioning Service units.
name (str) - The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, allocation_policy=None, device_provisioning_host_name=None, id_scope=None, linked_hubs=None, location=None, name=None, resource_group_name=None, service_operations_host_name=None, sku=None, tags=None)¶

Get an existing IotHubDps resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
allocation_policy (pulumi.Input[str]) – The allocation policy of the IoT Device Provisioning Service.
device_provisioning_host_name (pulumi.Input[str]) – The device endpoint of the IoT Device Provisioning Service.
id_scope (pulumi.Input[str]) – The unique identifier of the IoT Device Provisioning Service.
linked_hubs (pulumi.Input[list]) – A linked_hub block as defined below.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the Iot Device Provisioning Service resource has to be created. Changing this forces a new resource to be created.
service_operations_host_name (pulumi.Input[str]) – The service endpoint of the IoT Device Provisioning Service.
sku (pulumi.Input[dict]) – A sku block as defined below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The linked_hubs object supports the following:

allocationWeight (pulumi.Input[float]) - The weight applied to the IoT Hub. Defaults to 0.
applyAllocationPolicy (pulumi.Input[bool]) - Determines whether to apply allocation policies to the IoT Hub. Defaults to false.
connection_string (pulumi.Input[str]) - The connection string to connect to the IoT Hub. Changing this forces a new resource.
hostname (pulumi.Input[str]) - The IoT Hub hostname.
location (pulumi.Input[str]) - The location of the IoT hub. Changing this forces a new resource.

The sku object supports the following:

capacity (pulumi.Input[float]) - The number of provisioned IoT Device Provisioning Service units.
name (pulumi.Input[str]) - The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.iot.Route(resource_name, opts=None, condition=None, enabled=None, endpoint_names=None, iothub_name=None, name=None, resource_group_name=None, source=None, __props__=None, __name__=None, __opts__=None)¶

Manages an IotHub Route

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
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_io_t_hub = azure.iot.IoTHub("exampleIoTHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku={
        "name": "S1",
        "capacity": "1",
    },
    tags={
        "purpose": "testing",
    })
example_endpoint_storage_container = azure.iot.EndpointStorageContainer("exampleEndpointStorageContainer",
    resource_group_name=example_resource_group.name,
    iothub_name=example_io_t_hub.name,
    connection_string=example_account.primary_blob_connection_string,
    batch_frequency_in_seconds=60,
    max_chunk_size_in_bytes=10485760,
    container_name=example_container.name,
    encoding="Avro",
    file_name_format="{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}")
example_route = azure.iot.Route("exampleRoute",
    resource_group_name=example_resource_group.name,
    iothub_name=example_io_t_hub.name,
    source="DeviceMessages",
    condition="true",
    endpoint_names=[example_endpoint_storage_container.name],
    enabled=True)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
condition (pulumi.Input[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 (pulumi.Input[bool]) – Specifies whether a route is enabled.
endpoint_names (pulumi.Input[str]) – The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
iothub_name (pulumi.Input[str]) – The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The name of the route.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
source (pulumi.Input[str]) – The source that the routing rule is to be applied to. Possible values include: DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, Invalid, TwinChangeEvents.

condition: pulumi.Output[str] = None¶: 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: pulumi.Output[bool] = None¶: Specifies whether a route is enabled.

endpoint_names: pulumi.Output[str] = None¶: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.

iothub_name: pulumi.Output[str] = None¶: The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the route.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.

source: pulumi.Output[str] = None¶: The source that the routing rule is to be applied to. Possible values include: DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, Invalid, TwinChangeEvents.

static get(resource_name, id, opts=None, condition=None, enabled=None, endpoint_names=None, iothub_name=None, name=None, resource_group_name=None, source=None)¶

Get an existing Route resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
condition (pulumi.Input[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 (pulumi.Input[bool]) – Specifies whether a route is enabled.
endpoint_names (pulumi.Input[str]) – The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
iothub_name (pulumi.Input[str]) – The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The name of the route.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
source (pulumi.Input[str]) – The source that the routing rule is to be applied to. Possible values include: DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, Invalid, TwinChangeEvents.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.iot.SharedAccessPolicy(resource_name, opts=None, device_connect=None, iothub_name=None, name=None, registry_read=None, registry_write=None, resource_group_name=None, service_connect=None, __props__=None, __name__=None, __opts__=None)¶

Manages an IotHub Shared Access Policy

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_io_t_hub = azure.iot.IoTHub("exampleIoTHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku={
        "name": "S1",
        "capacity": "1",
    })
example_shared_access_policy = azure.iot.SharedAccessPolicy("exampleSharedAccessPolicy",
    resource_group_name=example_resource_group.name,
    iothub_name=example_io_t_hub.name,
    registry_read=True,
    registry_write=True)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
device_connect (pulumi.Input[bool]) – Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.
iothub_name (pulumi.Input[str]) – The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
registry_read (pulumi.Input[bool]) – Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.
registry_write (pulumi.Input[bool]) – Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the IotHub Shared Access Policy resource has to be created. Changing this forces a new resource to be created.
service_connect (pulumi.Input[bool]) – Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.

device_connect: pulumi.Output[bool] = None¶: Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

iothub_name: pulumi.Output[str] = None¶: The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.

primary_connection_string: pulumi.Output[str] = None¶: The primary connection string of the Shared Access Policy.

primary_key: pulumi.Output[str] = None¶: The primary key used to create the authentication token.

registry_read: pulumi.Output[bool] = None¶: Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.

registry_write: pulumi.Output[bool] = None¶: Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group under which the IotHub Shared Access Policy resource has to be created. Changing this forces a new resource to be created.

secondary_connection_string: pulumi.Output[str] = None¶: The secondary connection string of the Shared Access Policy.

secondary_key: pulumi.Output[str] = None¶: The secondary key used to create the authentication token.

service_connect: pulumi.Output[bool] = None¶: Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.

static get(resource_name, id, opts=None, device_connect=None, iothub_name=None, name=None, primary_connection_string=None, primary_key=None, registry_read=None, registry_write=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, service_connect=None)¶

Get an existing SharedAccessPolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
device_connect (pulumi.Input[bool]) – Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.
iothub_name (pulumi.Input[str]) – The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
primary_connection_string (pulumi.Input[str]) – The primary connection string of the Shared Access Policy.
primary_key (pulumi.Input[str]) – The primary key used to create the authentication token.
registry_read (pulumi.Input[bool]) – Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.
registry_write (pulumi.Input[bool]) – Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the IotHub Shared Access Policy resource has to be created. Changing this forces a new resource to be created.
secondary_connection_string (pulumi.Input[str]) – The secondary connection string of the Shared Access Policy.
secondary_key (pulumi.Input[str]) – The secondary key used to create the authentication token.
service_connect (pulumi.Input[bool]) – Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.iot.TimeSeriesInsightsAccessPolicy(resource_name, opts=None, description=None, name=None, principal_object_id=None, roles=None, time_series_insights_environment_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure IoT Time Series Insights Access Policy.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_time_series_insights_standard_environment = azure.iot.TimeSeriesInsightsStandardEnvironment("exampleTimeSeriesInsightsStandardEnvironment",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku_name="S1_1",
    data_retention_time="P30D")
example_time_series_insights_access_policy = azure.iot.TimeSeriesInsightsAccessPolicy("exampleTimeSeriesInsightsAccessPolicy",
    time_series_insights_environment_id=example_time_series_insights_standard_environment.name,
    principal_object_id="aGUID",
    roles=["Reader"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the Azure IoT Time Series Insights Access Policy.
name (pulumi.Input[str]) – Specifies the name of the Azure IoT Time Series Insights Access Policy. Changing this forces a new resource to be created. Must be globally unique.
principal_object_id (pulumi.Input[str]) – The id of the principal in Azure Active Directory.
roles (pulumi.Input[list]) – A list of roles to apply to the Access Policy. Valid values include Contributor and Reader.
time_series_insights_environment_id (pulumi.Input[str]) – The resource ID of the Azure IoT Time Series Insights Environment in which to create the Azure IoT Time Series Insights Reference Data Set. Changing this forces a new resource to be created.

description: pulumi.Output[str] = None¶: The description of the Azure IoT Time Series Insights Access Policy.

name: pulumi.Output[str] = None¶: Specifies the name of the Azure IoT Time Series Insights Access Policy. Changing this forces a new resource to be created. Must be globally unique.

principal_object_id: pulumi.Output[str] = None¶: The id of the principal in Azure Active Directory.

roles: pulumi.Output[list] = None¶: A list of roles to apply to the Access Policy. Valid values include Contributor and Reader.

time_series_insights_environment_id: pulumi.Output[str] = None¶: The resource ID of the Azure IoT Time Series Insights Environment in which to create the Azure IoT Time Series Insights Reference Data Set. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, description=None, name=None, principal_object_id=None, roles=None, time_series_insights_environment_id=None)¶

Get an existing TimeSeriesInsightsAccessPolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the Azure IoT Time Series Insights Access Policy.
name (pulumi.Input[str]) – Specifies the name of the Azure IoT Time Series Insights Access Policy. Changing this forces a new resource to be created. Must be globally unique.
principal_object_id (pulumi.Input[str]) – The id of the principal in Azure Active Directory.
roles (pulumi.Input[list]) – A list of roles to apply to the Access Policy. Valid values include Contributor and Reader.
time_series_insights_environment_id (pulumi.Input[str]) – The resource ID of the Azure IoT Time Series Insights Environment in which to create the Azure IoT Time Series Insights Reference Data Set. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.iot.TimeSeriesInsightsReferenceDataSet(resource_name, opts=None, data_string_comparison_behavior=None, key_properties=None, location=None, name=None, tags=None, time_series_insights_environment_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure IoT Time Series Insights Reference Data Set.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_time_series_insights_standard_environment = azure.iot.TimeSeriesInsightsStandardEnvironment("exampleTimeSeriesInsightsStandardEnvironment",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku_name="S1_1",
    data_retention_time="P30D")
example_time_series_insights_reference_data_set = azure.iot.TimeSeriesInsightsReferenceDataSet("exampleTimeSeriesInsightsReferenceDataSet",
    time_series_insights_environment_id=example_time_series_insights_standard_environment.id,
    location=example_resource_group.location,
    key_property=[{
        "name": "keyProperty1",
        "type": "String",
    }])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
data_string_comparison_behavior (pulumi.Input[str]) – The comparison behavior that will be used to compare keys. Valid values include Ordinal and OrdinalIgnoreCase. Defaults to Ordinal.
key_properties (pulumi.Input[list]) – A key_property block as defined below.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Azure IoT Time Series Insights Reference Data Set. Changing this forces a new resource to be created. Must be globally unique.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
time_series_insights_environment_id (pulumi.Input[str]) – The resource ID of the Azure IoT Time Series Insights Environment in which to create the Azure IoT Time Series Insights Reference Data Set. Changing this forces a new resource to be created.

The key_properties object supports the following:

name (pulumi.Input[str]) - The name of the key property.
type (pulumi.Input[str]) - The data type of the key property. Valid values include Bool, DateTime, Double, String.

data_string_comparison_behavior: pulumi.Output[str] = None¶: The comparison behavior that will be used to compare keys. Valid values include Ordinal and OrdinalIgnoreCase. Defaults to Ordinal.

key_properties: pulumi.Output[list] = None¶

A key_property block as defined below.

name (str) - The name of the key property.
type (str) - The data type of the key property. Valid values include Bool, DateTime, Double, String.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Azure IoT Time Series Insights Reference Data Set. Changing this forces a new resource to be created. Must be globally unique.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

time_series_insights_environment_id: pulumi.Output[str] = None¶: The resource ID of the Azure IoT Time Series Insights Environment in which to create the Azure IoT Time Series Insights Reference Data Set. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, data_string_comparison_behavior=None, key_properties=None, location=None, name=None, tags=None, time_series_insights_environment_id=None)¶

Get an existing TimeSeriesInsightsReferenceDataSet resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
data_string_comparison_behavior (pulumi.Input[str]) – The comparison behavior that will be used to compare keys. Valid values include Ordinal and OrdinalIgnoreCase. Defaults to Ordinal.
key_properties (pulumi.Input[list]) – A key_property block as defined below.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Azure IoT Time Series Insights Reference Data Set. Changing this forces a new resource to be created. Must be globally unique.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
time_series_insights_environment_id (pulumi.Input[str]) – The resource ID of the Azure IoT Time Series Insights Environment in which to create the Azure IoT Time Series Insights Reference Data Set. Changing this forces a new resource to be created.

The key_properties object supports the following:

name (pulumi.Input[str]) - The name of the key property.
type (pulumi.Input[str]) - The data type of the key property. Valid values include Bool, DateTime, Double, String.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.iot.TimeSeriesInsightsStandardEnvironment(resource_name, opts=None, data_retention_time=None, location=None, name=None, partition_key=None, resource_group_name=None, sku_name=None, storage_limit_exceeded_behavior=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure IoT Time Series Insights Standard Environment.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_time_series_insights_standard_environment = azure.iot.TimeSeriesInsightsStandardEnvironment("exampleTimeSeriesInsightsStandardEnvironment",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku_name="S1_1",
    data_retention_time="P30D")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
data_retention_time (pulumi.Input[str]) – Specifies the ISO8601 timespan specifying the minimum number of days the environment’s events will be available for query. Changing this forces a new resource to be created.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Azure IoT Time Series Insights Standard Environment. Changing this forces a new resource to be created. Must be globally unique.
partition_key (pulumi.Input[str]) – The name of the event property which will be used to partition data. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Azure IoT Time Series Insights Standard Environment.
sku*name (pulumi.Input[str]) –
Specifies the SKU Name for this IoT Time Series Insights Standard Environment. It is string consisting of two parts separated by an underscore(*).The fist part is the name, valid values include: S1 and S2. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. S1_1). Changing this forces a new resource to be created.
storage_limit_exceeded_behavior (pulumi.Input[str]) – Specifies the behavior the IoT Time Series Insights service should take when the environment’s capacity has been exceeded. Valid values include PauseIngress and PurgeOldData. Defaults to PurgeOldData.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

data_retention_time: pulumi.Output[str] = None¶: Specifies the ISO8601 timespan specifying the minimum number of days the environment’s events will be available for query. Changing this forces a new resource to be created.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Azure IoT Time Series Insights Standard Environment. Changing this forces a new resource to be created. Must be globally unique.

partition_key: pulumi.Output[str] = None¶: The name of the event property which will be used to partition data. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Azure IoT Time Series Insights Standard Environment.

sku_name: pulumi.Output[str] = None¶: Specifies the SKU Name for this IoT Time Series Insights Standard Environment. It is string consisting of two parts separated by an underscore(_).The fist part is the name, valid values include: S1 and S2. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. S1_1). Changing this forces a new resource to be created.

storage_limit_exceeded_behavior: pulumi.Output[str] = None¶: Specifies the behavior the IoT Time Series Insights service should take when the environment’s capacity has been exceeded. Valid values include PauseIngress and PurgeOldData. Defaults to PurgeOldData.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, data_retention_time=None, location=None, name=None, partition_key=None, resource_group_name=None, sku_name=None, storage_limit_exceeded_behavior=None, tags=None)¶

Get an existing TimeSeriesInsightsStandardEnvironment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
data_retention_time (pulumi.Input[str]) – Specifies the ISO8601 timespan specifying the minimum number of days the environment’s events will be available for query. Changing this forces a new resource to be created.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Azure IoT Time Series Insights Standard Environment. Changing this forces a new resource to be created. Must be globally unique.
partition_key (pulumi.Input[str]) – The name of the event property which will be used to partition data. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Azure IoT Time Series Insights Standard Environment.
sku*name (pulumi.Input[str]) –
Specifies the SKU Name for this IoT Time Series Insights Standard Environment. It is string consisting of two parts separated by an underscore(*).The fist part is the name, valid values include: S1 and S2. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. S1_1). Changing this forces a new resource to be created.
storage_limit_exceeded_behavior (pulumi.Input[str]) – Specifies the behavior the IoT Time Series Insights service should take when the environment’s capacity has been exceeded. Valid values include PauseIngress and PurgeOldData. Defaults to PurgeOldData.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_azure.iot.get_dps(name=None, resource_group_name=None, tags=None, opts=None)¶

Use this data source to access information about an existing IotHub Device Provisioning Service.

import pulumi
import pulumi_azure as azure

example = azure.iot.get_dps(name="iot_hub_dps_test",
    resource_group_name="iothub_dps_rg")

Parameters

name (str) – Specifies the name of the Iot Device Provisioning Service resource.
resource_group_name (str) – The name of the resource group under which the Iot Device Provisioning Service is located in.

pulumi_azure.iot.get_dps_shared_access_policy(iothub_dps_name=None, name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing IotHub Device Provisioning Service Shared Access Policy

import pulumi
import pulumi_azure as azure

example = azure.iot.get_dps_shared_access_policy(name="example",
    resource_group_name=azurerm_resource_group["example"]["name"],
    iothub_dps_name=azurerm_iothub_dps["example"]["name"])

Parameters

iothub_dps_name (str) – Specifies the name of the IoT Hub Device Provisioning service to which the Shared Access Policy belongs.
name (str) – Specifies the name of the IotHub Shared Access Policy.
resource_group_name (str) – Specifies the name of the resource group under which the IotHub Shared Access Policy resource exists.

pulumi_azure.iot.get_shared_access_policy(iothub_name=None, name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing IotHub Shared Access Policy

import pulumi
import pulumi_azure as azure

example = azure.iot.get_shared_access_policy(name="example",
    resource_group_name=azurerm_resource_group["example"]["name"],
    iothub_name=azurerm_iothub["example"]["name"])

Parameters

iothub_name (str) – The name of the IoTHub to which this Shared Access Policy belongs.
name (str) – Specifies the name of the IotHub Shared Access Policy resource.
resource_group_name (str) – The name of the resource group under which the IotHub Shared Access Policy resource has to be created.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

iot¶

On This Page