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_scope=None, location=None, name=None, resource_group_name=None, service_operations_host_name=None, tags=None, id=None)
class pulumi_azure.iot.AwaitableGetDpsSharedAccessPolicyResult(iothub_dps_name=None, name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, id=None)
class pulumi_azure.iot.AwaitableGetSharedAccessPolicyResult(iothub_name=None, name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, id=None)
class pulumi_azure.iot.Certificate(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 = None

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

iot_dps_name = 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 = None

Specifies the name of the Iot Device Provisioning Service Certificate resource. Changing this forces a new resource to be created.

resource_group_name = 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 Certificate 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.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

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 = None

The name of the Event Hub-compatible endpoint in the IoT hub. Changing this forces a new resource to be created.

iothub_name = None

The name of the IoT Hub. Changing this forces a new resource to be created.

name = None

The name of this Consumer Group. Changing this forces a new resource to be created.

resource_group_name = 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.Dps(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.

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])

  • applyAllocationPolicy (pulumi.Input[bool])

  • connection_string (pulumi.Input[str])

  • hostname (pulumi.Input[str])

  • 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.

The sku object supports the following:

  • capacity (pulumi.Input[float])

  • name (pulumi.Input[str]) - Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.

  • tier (pulumi.Input[str])

linked_hubs = None

A linked_hub block as defined below.

  • allocationWeight (float)

  • applyAllocationPolicy (bool)

  • connection_string (str)

  • hostname (str)

  • location (str) - Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.

location = None

Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.

name = None

Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.

resource_group_name = 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.

sku = None

A sku block as defined below.

  • capacity (float)

  • name (str) - Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.

  • tier (str)

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, linked_hubs=None, location=None, name=None, resource_group_name=None, sku=None, tags=None)

Get an existing Dps 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.

  • 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])

  • applyAllocationPolicy (pulumi.Input[bool])

  • connection_string (pulumi.Input[str])

  • hostname (pulumi.Input[str])

  • 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.

The sku object supports the following:

  • capacity (pulumi.Input[float])

  • name (pulumi.Input[str]) - Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.

  • tier (pulumi.Input[str])

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

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 = None

Adds EnrollmentRead permission to this Shared Access Account. It allows read access to enrollment data.

enrollment_write = None

Adds EnrollmentWrite permission to this Shared Access Account. It allows write access to enrollment data.

iothub_dps_name = 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 = None

Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.

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.

registration_read = None

Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.

registration_write = None

Adds RegistrationStatusWrite permission to this Shared Access Account. It allows write access to device registrations.

resource_group_name = 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 = None

The secondary connection string of the Shared Access Policy.

secondary_key = None

The secondary key used to create the authentication token.

service_config = 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.

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 = None

The connection string for the endpoint.

name = 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.

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 = None

The connection string for the endpoint.

name = 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.

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 = None

The connection string for the endpoint.

name = 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.

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 = 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 = None

The connection string for the endpoint.

container_name = None

The name of storage container in the storage account. *

encoding = None

Encoding that is used to serialize messages to blobs. Supported values are ‘avro’ and ‘avrodeflate’. Default value is ‘avro’.

file_name_format = 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 = 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 = 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 = 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 = 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.

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 = 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 = None

Used to specify whether the fallback route is enabled.

endpoint_names = None

The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.

iothub_name = None

The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.

resource_group_name = 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_scope=None, location=None, name=None, resource_group_name=None, service_operations_host_name=None, tags=None, id=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_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.

id = None

id is the provider-assigned unique ID for this managed resource.

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

A collection of values returned by getDpsSharedAccessPolicy.

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.

id = None

id is the provider-assigned unique ID for this managed resource.

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

A collection of values returned by getSharedAccessPolicy.

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.

id = None

id is the provider-assigned unique ID for this managed resource.

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.

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])

  • connection_string (pulumi.Input[str])

  • container_name (pulumi.Input[str])

  • encoding (pulumi.Input[str])

  • file_name_format (pulumi.Input[str])

  • max_chunk_size_in_bytes (pulumi.Input[float])

  • name (pulumi.Input[str]) - Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

  • type (pulumi.Input[str])

The fallback_route object supports the following:

  • condition (pulumi.Input[str])

  • enabled (pulumi.Input[bool])

  • endpoint_names (pulumi.Input[list])

  • source (pulumi.Input[str])

The file_upload object supports the following:

  • connection_string (pulumi.Input[str])

  • container_name (pulumi.Input[str])

  • default_ttl (pulumi.Input[str])

  • lock_duration (pulumi.Input[str])

  • max_delivery_count (pulumi.Input[float])

  • notifications (pulumi.Input[bool])

  • sasTtl (pulumi.Input[str])

The ip_filter_rules object supports the following:

  • action (pulumi.Input[str])

  • ipMask (pulumi.Input[str])

  • name (pulumi.Input[str]) - Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

The routes object supports the following:

  • condition (pulumi.Input[str])

  • enabled (pulumi.Input[bool])

  • endpoint_names (pulumi.Input[list])

  • name (pulumi.Input[str]) - Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

  • source (pulumi.Input[str])

The sku object supports the following:

  • capacity (pulumi.Input[float])

  • name (pulumi.Input[str]) - Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

  • tier (pulumi.Input[str])

endpoints = None

An endpoint block as defined below.

  • batch_frequency_in_seconds (float)

  • connection_string (str)

  • container_name (str)

  • encoding (str)

  • file_name_format (str)

  • max_chunk_size_in_bytes (float)

  • name (str) - Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

  • type (str)

event_hub_events_endpoint = None

The EventHub compatible endpoint for events data

event_hub_events_path = None

The EventHub compatible path for events data

event_hub_operations_endpoint = None

The EventHub compatible endpoint for operational data

event_hub_operations_path = None

The EventHub compatible path for operational data

event_hub_partition_count = None

The number of device-to-cloud partitions used by backing event hubs. Must be between 2 and 128.

event_hub_retention_in_days = None

The event hub retention to use in days. Must be between 1 and 7.

fallback_route = 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)

  • enabled (bool)

  • endpoint_names (list)

  • source (str)

file_upload = None

A file_upload block as defined below.

  • connection_string (str)

  • container_name (str)

  • default_ttl (str)

  • lock_duration (str)

  • max_delivery_count (float)

  • notifications (bool)

  • sasTtl (str)

hostname = None

The hostname of the IotHub Resource.

ip_filter_rules = None

One or more ip_filter_rule blocks as defined below.

  • action (str)

  • ipMask (str)

  • name (str) - Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

location = None

Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.

name = None

Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

resource_group_name = 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 = None

A route block as defined below.

  • condition (str)

  • enabled (bool)

  • endpoint_names (list)

  • name (str) - Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

  • source (str)

shared_access_policies = None

One or more shared_access_policy blocks as defined below.

  • keyName (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 = None

A sku block as defined below.

  • capacity (float)

  • name (str) - Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

  • tier (str)

tags = None

A mapping of tags to assign to the resource.

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.

The endpoints object supports the following:

  • batch_frequency_in_seconds (pulumi.Input[float])

  • connection_string (pulumi.Input[str])

  • container_name (pulumi.Input[str])

  • encoding (pulumi.Input[str])

  • file_name_format (pulumi.Input[str])

  • max_chunk_size_in_bytes (pulumi.Input[float])

  • name (pulumi.Input[str]) - Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

  • type (pulumi.Input[str])

The fallback_route object supports the following:

  • condition (pulumi.Input[str])

  • enabled (pulumi.Input[bool])

  • endpoint_names (pulumi.Input[list])

  • source (pulumi.Input[str])

The file_upload object supports the following:

  • connection_string (pulumi.Input[str])

  • container_name (pulumi.Input[str])

  • default_ttl (pulumi.Input[str])

  • lock_duration (pulumi.Input[str])

  • max_delivery_count (pulumi.Input[float])

  • notifications (pulumi.Input[bool])

  • sasTtl (pulumi.Input[str])

The ip_filter_rules object supports the following:

  • action (pulumi.Input[str])

  • ipMask (pulumi.Input[str])

  • name (pulumi.Input[str]) - Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

The routes object supports the following:

  • condition (pulumi.Input[str])

  • enabled (pulumi.Input[bool])

  • endpoint_names (pulumi.Input[list])

  • name (pulumi.Input[str]) - Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

  • source (pulumi.Input[str])

The shared_access_policies object supports the following:

  • keyName (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])

  • name (pulumi.Input[str]) - Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

  • tier (pulumi.Input[str])

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 = None

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

iot_dps_name = 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 = None

Specifies the name of the Iot Device Provisioning Service Certificate resource. Changing this forces a new resource to be created.

resource_group_name = 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.

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])

  • applyAllocationPolicy (pulumi.Input[bool])

  • connection_string (pulumi.Input[str])

  • hostname (pulumi.Input[str])

  • 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.

The sku object supports the following:

  • capacity (pulumi.Input[float])

  • name (pulumi.Input[str]) - Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.

  • tier (pulumi.Input[str])

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_scope = None

The unique identifier of the IoT Device Provisioning Service.

linked_hubs = None

A linked_hub block as defined below.

  • allocationWeight (float)

  • applyAllocationPolicy (bool)

  • connection_string (str)

  • hostname (str)

  • location (str) - Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.

location = None

Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.

name = None

Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.

resource_group_name = 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 = None

The service endpoint of the IoT Device Provisioning Service.

sku = None

A sku block as defined below.

  • capacity (float)

  • name (str) - Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.

  • tier (str)

tags = 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])

  • applyAllocationPolicy (pulumi.Input[bool])

  • connection_string (pulumi.Input[str])

  • hostname (pulumi.Input[str])

  • 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.

The sku object supports the following:

  • capacity (pulumi.Input[float])

  • name (pulumi.Input[str]) - Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.

  • tier (pulumi.Input[str])

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.

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 = 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 = None

Specifies whether a route is enabled.

endpoint_names = None

The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.

iothub_name = None

The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.

name = None

The name of the route.

resource_group_name = 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 = 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

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 = None

Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

iothub_name = None

The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.

name = None

Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.

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.

registry_read = None

Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.

registry_write = None

Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.

resource_group_name = 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 = None

The secondary connection string of the Shared Access Policy.

secondary_key = None

The secondary key used to create the authentication token.

service_connect = 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

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.

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

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

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.