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

Resources

Functions

Others

Resources

Resource ConsumerGroup

class ConsumerGroup extends CustomResource

Manages a Consumer Group within an IotHub

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "S1",
        capacity: "1",
    },
    tags: {
        purpose: "testing",
    },
});
const exampleConsumerGroup = new azure.iot.ConsumerGroup("exampleConsumerGroup", {
    iothubName: exampleIoTHub.name,
    eventhubEndpointName: "events",
    resourceGroupName: exampleResourceGroup.name,
});

constructor

new ConsumerGroup(name: string, args: ConsumerGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ConsumerGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConsumerGroupState, opts?: pulumi.CustomResourceOptions): ConsumerGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ConsumerGroup

Returns true if the given object is an instance of ConsumerGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property eventhubEndpointName

public eventhubEndpointName: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property iothubName

public iothubName: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group that contains the IoT hub. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource DpsSharedAccessPolicy

class DpsSharedAccessPolicy extends CustomResource

Manages an IotHub Device Provisioning Service Shared Access Policy

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleIotHubDps = new azure.iot.IotHubDps("exampleIotHubDps", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "S1",
        capacity: "1",
    },
});
const exampleDpsSharedAccessPolicy = new azure.iot.DpsSharedAccessPolicy("exampleDpsSharedAccessPolicy", {
    resourceGroupName: exampleResourceGroup.name,
    iothubDpsName: exampleIotHubDps.name,
    enrollmentWrite: true,
    enrollmentRead: true,
});

constructor

new DpsSharedAccessPolicy(name: string, args: DpsSharedAccessPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a DpsSharedAccessPolicy resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DpsSharedAccessPolicyState, opts?: pulumi.CustomResourceOptions): DpsSharedAccessPolicy

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DpsSharedAccessPolicy

Returns true if the given object is an instance of DpsSharedAccessPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property enrollmentRead

public enrollmentRead: pulumi.Output<boolean | undefined>;

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

property enrollmentWrite

public enrollmentWrite: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property iothubDpsName

public iothubDpsName: pulumi.Output<string>;

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.

property name

public name: pulumi.Output<string>;

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

property primaryConnectionString

public primaryConnectionString: pulumi.Output<string>;

The primary connection string of the Shared Access Policy.

property primaryKey

public primaryKey: pulumi.Output<string>;

The primary key used to create the authentication token.

property registrationRead

public registrationRead: pulumi.Output<boolean | undefined>;

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

property registrationWrite

public registrationWrite: pulumi.Output<boolean | undefined>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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.

property secondaryConnectionString

public secondaryConnectionString: pulumi.Output<string>;

The secondary connection string of the Shared Access Policy.

property secondaryKey

public secondaryKey: pulumi.Output<string>;

The secondary key used to create the authentication token.

property serviceConfig

public serviceConfig: pulumi.Output<boolean | undefined>;

Adds ServiceConfig permission to this Shared Access Account. It allows configuration of the Device Provisioning Service.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EndpointEventhub

class EndpointEventhub extends CustomResource

Manages an IotHub EventHub Endpoint

NOTE: Endpoints can be defined either directly on the azure.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 azure.iot.IoTHub resource is not supported.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "East US"});
const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("exampleEventHubNamespace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "Basic",
});
const exampleEventHub = new azure.eventhub.EventHub("exampleEventHub", {
    namespaceName: exampleEventHubNamespace.name,
    resourceGroupName: exampleResourceGroup.name,
    partitionCount: 2,
    messageRetention: 1,
});
const exampleAuthorizationRule = new azure.eventhub.AuthorizationRule("exampleAuthorizationRule", {
    namespaceName: exampleEventHubNamespace.name,
    eventhubName: exampleEventHub.name,
    resourceGroupName: exampleResourceGroup.name,
    listen: false,
    send: true,
    manage: false,
});
const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "B1",
        tier: "Basic",
        capacity: "1",
    },
    tags: {
        purpose: "example",
    },
});
const exampleEndpointEventhub = new azure.iot.EndpointEventhub("exampleEndpointEventhub", {
    resourceGroupName: exampleResourceGroup.name,
    iothubName: exampleIoTHub.name,
    connectionString: exampleAuthorizationRule.primaryConnectionString,
});

constructor

new EndpointEventhub(name: string, args: EndpointEventhubArgs, opts?: pulumi.CustomResourceOptions)

Create a EndpointEventhub resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EndpointEventhubState, opts?: pulumi.CustomResourceOptions): EndpointEventhub

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EndpointEventhub

Returns true if the given object is an instance of EndpointEventhub. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property connectionString

public connectionString: pulumi.Output<string>;

The connection string for the endpoint.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property iothubName

public iothubName: pulumi.Output<string>;

property name

public name: pulumi.Output<string>;

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EndpointServicebusQueue

class EndpointServicebusQueue extends CustomResource

Manages an IotHub ServiceBus Queue Endpoint

NOTE: Endpoints can be defined either directly on the azure.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 azure.iot.IoTHub resource is not supported.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "East US"});
const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "Standard",
});
const exampleQueue = new azure.servicebus.Queue("exampleQueue", {
    resourceGroupName: exampleResourceGroup.name,
    namespaceName: exampleNamespace.name,
    enablePartitioning: true,
});
const exampleQueueAuthorizationRule = new azure.servicebus.QueueAuthorizationRule("exampleQueueAuthorizationRule", {
    namespaceName: exampleNamespace.name,
    queueName: exampleQueue.name,
    resourceGroupName: exampleResourceGroup.name,
    listen: false,
    send: true,
    manage: false,
});
const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "B1",
        tier: "Basic",
        capacity: "1",
    },
    tags: {
        purpose: "example",
    },
});
const exampleEndpointServicebusQueue = new azure.iot.EndpointServicebusQueue("exampleEndpointServicebusQueue", {
    resourceGroupName: exampleResourceGroup.name,
    iothubName: exampleIoTHub.name,
    connectionString: exampleQueueAuthorizationRule.primaryConnectionString,
});

constructor

new EndpointServicebusQueue(name: string, args: EndpointServicebusQueueArgs, opts?: pulumi.CustomResourceOptions)

Create a EndpointServicebusQueue resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EndpointServicebusQueueState, opts?: pulumi.CustomResourceOptions): EndpointServicebusQueue

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EndpointServicebusQueue

Returns true if the given object is an instance of EndpointServicebusQueue. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property connectionString

public connectionString: pulumi.Output<string>;

The connection string for the endpoint.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property iothubName

public iothubName: pulumi.Output<string>;

property name

public name: pulumi.Output<string>;

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EndpointServicebusTopic

class EndpointServicebusTopic extends CustomResource

Manages an IotHub ServiceBus Topic Endpoint

NOTE: Endpoints can be defined either directly on the azure.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 azure.iot.IoTHub resource is not supported.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "East US"});
const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "Standard",
});
const exampleTopic = new azure.servicebus.Topic("exampleTopic", {
    resourceGroupName: exampleResourceGroup.name,
    namespaceName: exampleNamespace.name,
});
const exampleTopicAuthorizationRule = new azure.servicebus.TopicAuthorizationRule("exampleTopicAuthorizationRule", {
    namespaceName: exampleNamespace.name,
    topicName: exampleTopic.name,
    resourceGroupName: exampleResourceGroup.name,
    listen: false,
    send: true,
    manage: false,
});
const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "B1",
        tier: "Basic",
        capacity: "1",
    },
    tags: {
        purpose: "example",
    },
});
const exampleEndpointServicebusTopic = new azure.iot.EndpointServicebusTopic("exampleEndpointServicebusTopic", {
    resourceGroupName: exampleResourceGroup.name,
    iothubName: exampleIoTHub.name,
    connectionString: exampleTopicAuthorizationRule.primaryConnectionString,
});

constructor

new EndpointServicebusTopic(name: string, args: EndpointServicebusTopicArgs, opts?: pulumi.CustomResourceOptions)

Create a EndpointServicebusTopic resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EndpointServicebusTopicState, opts?: pulumi.CustomResourceOptions): EndpointServicebusTopic

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EndpointServicebusTopic

Returns true if the given object is an instance of EndpointServicebusTopic. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property connectionString

public connectionString: pulumi.Output<string>;

The connection string for the endpoint.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property iothubName

public iothubName: pulumi.Output<string>;

property name

public name: pulumi.Output<string>;

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EndpointStorageContainer

class EndpointStorageContainer extends CustomResource

Manages an IotHub Storage Container Endpoint

NOTE: Endpoints can be defined either directly on the azure.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 azure.iot.IoTHub resource is not supported.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleContainer = new azure.storage.Container("exampleContainer", {
    resourceGroupName: exampleResourceGroup.name,
    storageAccountName: exampleAccount.name,
    containerAccessType: "private",
});
const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "S1",
        capacity: "1",
    },
});
const exampleEndpointStorageContainer = new azure.iot.EndpointStorageContainer("exampleEndpointStorageContainer", {
    resourceGroupName: exampleResourceGroup.name,
    iothubName: exampleIoTHub.name,
    containerName: "acctestcont",
    connectionString: exampleAccount.primaryBlobConnectionString,
    fileNameFormat: "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
    batchFrequencyInSeconds: 60,
    maxChunkSizeInBytes: 10485760,
    encoding: "JSON",
});

constructor

new EndpointStorageContainer(name: string, args: EndpointStorageContainerArgs, opts?: pulumi.CustomResourceOptions)

Create a EndpointStorageContainer resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EndpointStorageContainerState, opts?: pulumi.CustomResourceOptions): EndpointStorageContainer

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EndpointStorageContainer

Returns true if the given object is an instance of EndpointStorageContainer. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property batchFrequencyInSeconds

public batchFrequencyInSeconds: pulumi.Output<number | undefined>;

Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.

property connectionString

public connectionString: pulumi.Output<string>;

The connection string for the endpoint.

property containerName

public containerName: pulumi.Output<string>;

The name of storage container in the storage account. *

property encoding

public encoding: pulumi.Output<string | undefined>;

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

property fileNameFormat

public fileNameFormat: pulumi.Output<string | undefined>;

File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property iothubName

public iothubName: pulumi.Output<string>;

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

property maxChunkSizeInBytes

public maxChunkSizeInBytes: pulumi.Output<number | undefined>;

Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).

property name

public name: pulumi.Output<string>;

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource FallbackRoute

class FallbackRoute extends CustomResource

Manages an IotHub Fallback Route

Disclaimers

Note: Fallback route can be defined either directly on the azure.iot.IoTHub resource, or using the azure.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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleContainer = new azure.storage.Container("exampleContainer", {
    resourceGroupName: exampleResourceGroup.name,
    storageAccountName: exampleAccount.name,
    containerAccessType: "private",
});
const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "S1",
        capacity: "1",
    },
    tags: {
        purpose: "testing",
    },
});
const exampleEndpointStorageContainer = new azure.iot.EndpointStorageContainer("exampleEndpointStorageContainer", {
    resourceGroupName: exampleResourceGroup.name,
    iothubName: exampleIoTHub.name,
    connectionString: exampleAccount.primaryBlobConnectionString,
    batchFrequencyInSeconds: 60,
    maxChunkSizeInBytes: 10485760,
    containerName: exampleContainer.name,
    encoding: "Avro",
    fileNameFormat: "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
});
const exampleFallbackRoute = new azure.iot.FallbackRoute("exampleFallbackRoute", {
    resourceGroupName: exampleResourceGroup.name,
    iothubName: exampleIoTHub.name,
    condition: "true",
    endpointNames: [exampleEndpointStorageContainer.name],
    enabled: true,
});

constructor

new FallbackRoute(name: string, args: FallbackRouteArgs, opts?: pulumi.CustomResourceOptions)

Create a FallbackRoute resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FallbackRouteState, opts?: pulumi.CustomResourceOptions): FallbackRoute

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is FallbackRoute

Returns true if the given object is an instance of FallbackRoute. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property condition

public condition: pulumi.Output<string | undefined>;

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.

property enabled

public enabled: pulumi.Output<boolean>;

Used to specify whether the fallback route is enabled.

property endpointNames

public endpointNames: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property iothubName

public iothubName: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource IoTHub

class IoTHub extends CustomResource

Manages an IotHub

NOTE: Endpoints can be defined either directly on the azure.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 azure.iot.IoTHub resource is not supported.

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

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "Canada Central"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleContainer = new azure.storage.Container("exampleContainer", {
    storageAccountName: exampleAccount.name,
    containerAccessType: "private",
});
const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("exampleEventHubNamespace", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: "Basic",
});
const exampleEventHub = new azure.eventhub.EventHub("exampleEventHub", {
    resourceGroupName: exampleResourceGroup.name,
    namespaceName: exampleEventHubNamespace.name,
    partitionCount: 2,
    messageRetention: 1,
});
const exampleAuthorizationRule = new azure.eventhub.AuthorizationRule("exampleAuthorizationRule", {
    resourceGroupName: exampleResourceGroup.name,
    namespaceName: exampleEventHubNamespace.name,
    eventhubName: exampleEventHub.name,
    send: true,
});
const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "S1",
        capacity: "1",
    },
    endpoint: [
        {
            type: "AzureIotHub.StorageContainer",
            connectionString: exampleAccount.primaryBlobConnectionString,
            name: "export",
            batchFrequencyInSeconds: 60,
            maxChunkSizeInBytes: 10485760,
            containerName: exampleContainer.name,
            encoding: "Avro",
            fileNameFormat: "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
        },
        {
            type: "AzureIotHub.EventHub",
            connectionString: exampleAuthorizationRule.primaryConnectionString,
            name: "export2",
        },
    ],
    route: [
        {
            name: "export",
            source: "DeviceMessages",
            condition: "true",
            endpointNames: ["export"],
            enabled: true,
        },
        {
            name: "export2",
            source: "DeviceMessages",
            condition: "true",
            endpointNames: ["export2"],
            enabled: true,
        },
    ],
    tags: {
        purpose: "testing",
    },
});

constructor

new IoTHub(name: string, args: IoTHubArgs, opts?: pulumi.CustomResourceOptions)

Create a IoTHub resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IoTHubState, opts?: pulumi.CustomResourceOptions): IoTHub

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

method getEventFunction

getEventFunction(name: string, args: EventHubCallback | GetIoTHubFunctionArgs): IoTHubFunction

Creates a new Function triggered by events in the given IoT Hub using the callback provided. The Function should be used as part of a [MultiCallbackFunctionApp].

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is IoTHub

Returns true if the given object is an instance of IoTHub. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method onEvent

onEvent(name: string, args: EventHubCallback | IoTHubSubscriptionArgs, opts?: pulumi.ComponentResourceOptions): IoTHubEventSubscription

Subscribes to events logged to this Event Hub to the handler provided, along with options to control the behavior of the subscription.

property endpoints

public endpoints: pulumi.Output<IoTHubEndpoint[]>;

An endpoint block as defined below.

property eventHubEventsEndpoint

public eventHubEventsEndpoint: pulumi.Output<string>;

The EventHub compatible endpoint for events data

property eventHubEventsPath

public eventHubEventsPath: pulumi.Output<string>;

The EventHub compatible path for events data

property eventHubOperationsEndpoint

public eventHubOperationsEndpoint: pulumi.Output<string>;

The EventHub compatible endpoint for operational data

property eventHubOperationsPath

public eventHubOperationsPath: pulumi.Output<string>;

The EventHub compatible path for operational data

property eventHubPartitionCount

public eventHubPartitionCount: pulumi.Output<number>;

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

property eventHubRetentionInDays

public eventHubRetentionInDays: pulumi.Output<number>;

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

property fallbackRoute

public fallbackRoute: pulumi.Output<IoTHubFallbackRoute>;

A fallbackRoute 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.

property fileUpload

public fileUpload: pulumi.Output<IoTHubFileUpload | undefined>;

A fileUpload block as defined below.

property hostname

public hostname: pulumi.Output<string>;

The hostname of the IotHub Resource.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipFilterRules

public ipFilterRules: pulumi.Output<IoTHubIpFilterRule[] | undefined>;

One or more ipFilterRule blocks as defined below.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.

property routes

public routes: pulumi.Output<IoTHubRoute[]>;

A route block as defined below.

property sharedAccessPolicies

public sharedAccessPolicies: pulumi.Output<IoTHubSharedAccessPolicy[]>;

One or more sharedAccessPolicy blocks as defined below.

property sku

public sku: pulumi.Output<IoTHubSku>;

A sku block as defined below.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property type

public type: pulumi.Output<string>;

The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource IotHubCertificate

class IotHubCertificate extends CustomResource

Manages an IotHub Device Provisioning Service Certificate.

constructor

new IotHubCertificate(name: string, args: IotHubCertificateArgs, opts?: pulumi.CustomResourceOptions)

Create a IotHubCertificate resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IotHubCertificateState, opts?: pulumi.CustomResourceOptions): IotHubCertificate

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is IotHubCertificate

Returns true if the given object is an instance of IotHubCertificate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property certificateContent

public certificateContent: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property iotDpsName

public iotDpsName: pulumi.Output<string>;

The name of the IoT Device Provisioning Service that this certificate will be attached to. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource IotHubDps

class IotHubDps extends CustomResource

Manages an IotHub Device Provisioning Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleIotHubDps = new azure.iot.IotHubDps("exampleIotHubDps", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "S1",
        capacity: "1",
    },
});

constructor

new IotHubDps(name: string, args: IotHubDpsArgs, opts?: pulumi.CustomResourceOptions)

Create a IotHubDps resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IotHubDpsState, opts?: pulumi.CustomResourceOptions): IotHubDps

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is IotHubDps

Returns true if the given object is an instance of IotHubDps. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allocationPolicy

public allocationPolicy: pulumi.Output<string>;

The allocation policy of the IoT Device Provisioning Service.

property deviceProvisioningHostName

public deviceProvisioningHostName: pulumi.Output<string>;

The device endpoint of the IoT Device Provisioning Service.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property idScope

public idScope: pulumi.Output<string>;

The unique identifier of the IoT Device Provisioning Service.

property linkedHubs

public linkedHubs: pulumi.Output<IotHubDpsLinkedHub[] | undefined>;

A linkedHub block as defined below.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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.

property serviceOperationsHostName

public serviceOperationsHostName: pulumi.Output<string>;

The service endpoint of the IoT Device Provisioning Service.

property sku

public sku: pulumi.Output<IotHubDpsSku>;

A sku block as defined below.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Route

class Route extends CustomResource

Manages an IotHub Route

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleContainer = new azure.storage.Container("exampleContainer", {
    resourceGroupName: exampleResourceGroup.name,
    storageAccountName: exampleAccount.name,
    containerAccessType: "private",
});
const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "S1",
        capacity: "1",
    },
    tags: {
        purpose: "testing",
    },
});
const exampleEndpointStorageContainer = new azure.iot.EndpointStorageContainer("exampleEndpointStorageContainer", {
    resourceGroupName: exampleResourceGroup.name,
    iothubName: exampleIoTHub.name,
    connectionString: exampleAccount.primaryBlobConnectionString,
    batchFrequencyInSeconds: 60,
    maxChunkSizeInBytes: 10485760,
    containerName: exampleContainer.name,
    encoding: "Avro",
    fileNameFormat: "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
});
const exampleRoute = new azure.iot.Route("exampleRoute", {
    resourceGroupName: exampleResourceGroup.name,
    iothubName: exampleIoTHub.name,
    source: "DeviceMessages",
    condition: "true",
    endpointNames: [exampleEndpointStorageContainer.name],
    enabled: true,
});

constructor

new Route(name: string, args: RouteArgs, opts?: pulumi.CustomResourceOptions)

Create a Route resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RouteState, opts?: pulumi.CustomResourceOptions): Route

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Route

Returns true if the given object is an instance of Route. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property condition

public condition: pulumi.Output<string | undefined>;

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.

property enabled

public enabled: pulumi.Output<boolean>;

Specifies whether a route is enabled.

property endpointNames

public endpointNames: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property iothubName

public iothubName: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

The name of the route.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.

property source

public source: pulumi.Output<string>;

The source that the routing rule is to be applied to. Possible values include: DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, Invalid, TwinChangeEvents.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource SharedAccessPolicy

class SharedAccessPolicy extends CustomResource

Manages an IotHub Shared Access Policy

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "S1",
        capacity: "1",
    },
});
const exampleSharedAccessPolicy = new azure.iot.SharedAccessPolicy("exampleSharedAccessPolicy", {
    resourceGroupName: exampleResourceGroup.name,
    iothubName: exampleIoTHub.name,
    registryRead: true,
    registryWrite: true,
});

constructor

new SharedAccessPolicy(name: string, args: SharedAccessPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a SharedAccessPolicy resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SharedAccessPolicyState, opts?: pulumi.CustomResourceOptions): SharedAccessPolicy

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SharedAccessPolicy

Returns true if the given object is an instance of SharedAccessPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property deviceConnect

public deviceConnect: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property iothubName

public iothubName: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property primaryConnectionString

public primaryConnectionString: pulumi.Output<string>;

The primary connection string of the Shared Access Policy.

property primaryKey

public primaryKey: pulumi.Output<string>;

The primary key used to create the authentication token.

property registryRead

public registryRead: pulumi.Output<boolean | undefined>;

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

property registryWrite

public registryWrite: pulumi.Output<boolean | undefined>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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.

property secondaryConnectionString

public secondaryConnectionString: pulumi.Output<string>;

The secondary connection string of the Shared Access Policy.

property secondaryKey

public secondaryKey: pulumi.Output<string>;

The secondary key used to create the authentication token.

property serviceConnect

public serviceConnect: pulumi.Output<boolean | undefined>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource TimeSeriesInsightsStandardEnvironment

class TimeSeriesInsightsStandardEnvironment extends CustomResource

Manages an Azure IoT Time Series Insights Standard Environment.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "northeurope"});
const exampleTimeSeriesInsightsStandardEnvironment = new azure.iot.TimeSeriesInsightsStandardEnvironment("exampleTimeSeriesInsightsStandardEnvironment", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    skuName: "S1_1",
    dataRetentionTime: "P30D",
});

constructor

new TimeSeriesInsightsStandardEnvironment(name: string, args: TimeSeriesInsightsStandardEnvironmentArgs, opts?: pulumi.CustomResourceOptions)

Create a TimeSeriesInsightsStandardEnvironment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TimeSeriesInsightsStandardEnvironmentState, opts?: pulumi.CustomResourceOptions): TimeSeriesInsightsStandardEnvironment

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is TimeSeriesInsightsStandardEnvironment

Returns true if the given object is an instance of TimeSeriesInsightsStandardEnvironment. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dataRetentionTime

public dataRetentionTime: pulumi.Output<string>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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.

property partitionKey

public partitionKey: pulumi.Output<string | undefined>;

The name of the event property which will be used to partition data. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Azure IoT Time Series Insights Standard Environment.

property skuName

public skuName: pulumi.Output<string>;

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.

property storageLimitExceededBehavior

public storageLimitExceededBehavior: pulumi.Output<string | undefined>;

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.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getDps

getDps(args: GetDpsArgs, opts?: pulumi.InvokeOptions): Promise<GetDpsResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = pulumi.output(azure.iot.getDps({
    name: "iotHubDpsTest",
    resourceGroupName: "iothubDpsRg",
}, { async: true }));

Function getDpsSharedAccessPolicy

getDpsSharedAccessPolicy(args: GetDpsSharedAccessPolicyArgs, opts?: pulumi.InvokeOptions): Promise<GetDpsSharedAccessPolicyResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.iot.getDpsSharedAccessPolicy({
    name: "example",
    resourceGroupName: azurerm_resource_group.example.name,
    iothubDpsName: azurerm_iothub_dps.example.name,
});

Function getSharedAccessPolicy

getSharedAccessPolicy(args: GetSharedAccessPolicyArgs, opts?: pulumi.InvokeOptions): Promise<GetSharedAccessPolicyResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.iot.getSharedAccessPolicy({
    name: "example",
    resourceGroupName: azurerm_resource_group.example.name,
    iothubName: azurerm_iothub.example.name,
});

Others

interface ConsumerGroupArgs

interface ConsumerGroupArgs

The set of arguments for constructing a ConsumerGroup resource.

property eventhubEndpointName

eventhubEndpointName: pulumi.Input<string>;

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

property iothubName

iothubName: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group that contains the IoT hub. Changing this forces a new resource to be created.

interface ConsumerGroupState

interface ConsumerGroupState

Input properties used for looking up and filtering ConsumerGroup resources.

property eventhubEndpointName

eventhubEndpointName?: pulumi.Input<string>;

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

property iothubName

iothubName?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group that contains the IoT hub. Changing this forces a new resource to be created.

interface DpsSharedAccessPolicyArgs

interface DpsSharedAccessPolicyArgs

The set of arguments for constructing a DpsSharedAccessPolicy resource.

property enrollmentRead

enrollmentRead?: pulumi.Input<boolean>;

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

property enrollmentWrite

enrollmentWrite?: pulumi.Input<boolean>;

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

property iothubDpsName

iothubDpsName: pulumi.Input<string>;

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.

property name

name?: pulumi.Input<string>;

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

property registrationRead

registrationRead?: pulumi.Input<boolean>;

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

property registrationWrite

registrationWrite?: pulumi.Input<boolean>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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.

property serviceConfig

serviceConfig?: pulumi.Input<boolean>;

Adds ServiceConfig permission to this Shared Access Account. It allows configuration of the Device Provisioning Service.

interface DpsSharedAccessPolicyState

interface DpsSharedAccessPolicyState

Input properties used for looking up and filtering DpsSharedAccessPolicy resources.

property enrollmentRead

enrollmentRead?: pulumi.Input<boolean>;

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

property enrollmentWrite

enrollmentWrite?: pulumi.Input<boolean>;

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

property iothubDpsName

iothubDpsName?: pulumi.Input<string>;

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.

property name

name?: pulumi.Input<string>;

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

property primaryConnectionString

primaryConnectionString?: pulumi.Input<string>;

The primary connection string of the Shared Access Policy.

property primaryKey

primaryKey?: pulumi.Input<string>;

The primary key used to create the authentication token.

property registrationRead

registrationRead?: pulumi.Input<boolean>;

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

property registrationWrite

registrationWrite?: pulumi.Input<boolean>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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.

property secondaryConnectionString

secondaryConnectionString?: pulumi.Input<string>;

The secondary connection string of the Shared Access Policy.

property secondaryKey

secondaryKey?: pulumi.Input<string>;

The secondary key used to create the authentication token.

property serviceConfig

serviceConfig?: pulumi.Input<boolean>;

Adds ServiceConfig permission to this Shared Access Account. It allows configuration of the Device Provisioning Service.

interface EndpointEventhubArgs

interface EndpointEventhubArgs

The set of arguments for constructing a EndpointEventhub resource.

property connectionString

connectionString: pulumi.Input<string>;

The connection string for the endpoint.

property iothubName

iothubName: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

interface EndpointEventhubState

interface EndpointEventhubState

Input properties used for looking up and filtering EndpointEventhub resources.

property connectionString

connectionString?: pulumi.Input<string>;

The connection string for the endpoint.

property iothubName

iothubName?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

interface EndpointServicebusQueueArgs

interface EndpointServicebusQueueArgs

The set of arguments for constructing a EndpointServicebusQueue resource.

property connectionString

connectionString: pulumi.Input<string>;

The connection string for the endpoint.

property iothubName

iothubName: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

interface EndpointServicebusQueueState

interface EndpointServicebusQueueState

Input properties used for looking up and filtering EndpointServicebusQueue resources.

property connectionString

connectionString?: pulumi.Input<string>;

The connection string for the endpoint.

property iothubName

iothubName?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

interface EndpointServicebusTopicArgs

interface EndpointServicebusTopicArgs

The set of arguments for constructing a EndpointServicebusTopic resource.

property connectionString

connectionString: pulumi.Input<string>;

The connection string for the endpoint.

property iothubName

iothubName: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

interface EndpointServicebusTopicState

interface EndpointServicebusTopicState

Input properties used for looking up and filtering EndpointServicebusTopic resources.

property connectionString

connectionString?: pulumi.Input<string>;

The connection string for the endpoint.

property iothubName

iothubName?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

interface EndpointStorageContainerArgs

interface EndpointStorageContainerArgs

The set of arguments for constructing a EndpointStorageContainer resource.

property batchFrequencyInSeconds

batchFrequencyInSeconds?: pulumi.Input<number>;

Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.

property connectionString

connectionString: pulumi.Input<string>;

The connection string for the endpoint.

property containerName

containerName: pulumi.Input<string>;

The name of storage container in the storage account. *

property encoding

encoding?: pulumi.Input<string>;

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

property fileNameFormat

fileNameFormat?: pulumi.Input<string>;

File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

property iothubName

iothubName: pulumi.Input<string>;

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

property maxChunkSizeInBytes

maxChunkSizeInBytes?: pulumi.Input<number>;

Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).

property name

name?: pulumi.Input<string>;

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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.

interface EndpointStorageContainerState

interface EndpointStorageContainerState

Input properties used for looking up and filtering EndpointStorageContainer resources.

property batchFrequencyInSeconds

batchFrequencyInSeconds?: pulumi.Input<number>;

Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.

property connectionString

connectionString?: pulumi.Input<string>;

The connection string for the endpoint.

property containerName

containerName?: pulumi.Input<string>;

The name of storage container in the storage account. *

property encoding

encoding?: pulumi.Input<string>;

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

property fileNameFormat

fileNameFormat?: pulumi.Input<string>;

File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

property iothubName

iothubName?: pulumi.Input<string>;

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

property maxChunkSizeInBytes

maxChunkSizeInBytes?: pulumi.Input<number>;

Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).

property name

name?: pulumi.Input<string>;

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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.

interface FallbackRouteArgs

interface FallbackRouteArgs

The set of arguments for constructing a FallbackRoute resource.

property condition

condition?: pulumi.Input<string>;

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

property enabled

enabled: pulumi.Input<boolean>;

Used to specify whether the fallback route is enabled.

property endpointNames

endpointNames: pulumi.Input<string>;

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

property iothubName

iothubName: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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.

interface FallbackRouteState

interface FallbackRouteState

Input properties used for looking up and filtering FallbackRoute resources.

property condition

condition?: pulumi.Input<string>;

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

property enabled

enabled?: pulumi.Input<boolean>;

Used to specify whether the fallback route is enabled.

property endpointNames

endpointNames?: pulumi.Input<string>;

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

property iothubName

iothubName?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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.

interface GetDpsArgs

interface GetDpsArgs

A collection of arguments for invoking getDps.

property name

name: string;

Specifies the name of the Iot Device Provisioning Service resource.

property resourceGroupName

resourceGroupName: string;

The name of the resource group under which the Iot Device Provisioning Service is located in.

property tags

tags?: undefined | {[key: string]: string};

interface GetDpsResult

interface GetDpsResult

A collection of values returned by getDps.

property allocationPolicy

allocationPolicy: string;

The allocation policy of the IoT Device Provisioning Service.

property deviceProvisioningHostName

deviceProvisioningHostName: string;

The device endpoint of the IoT Device Provisioning Service.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property idScope

idScope: string;

The unique identifier of the IoT Device Provisioning Service.

property location

location: string;

Specifies the supported Azure location where the IoT Device Provisioning Service exists.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property serviceOperationsHostName

serviceOperationsHostName: string;

The service endpoint of the IoT Device Provisioning Service.

property tags

tags?: undefined | {[key: string]: string};

interface GetDpsSharedAccessPolicyArgs

interface GetDpsSharedAccessPolicyArgs

A collection of arguments for invoking getDpsSharedAccessPolicy.

property iothubDpsName

iothubDpsName: string;

Specifies the name of the IoT Hub Device Provisioning service to which the Shared Access Policy belongs.

property name

name: string;

Specifies the name of the IotHub Shared Access Policy.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the resource group under which the IotHub Shared Access Policy resource exists.

interface GetDpsSharedAccessPolicyResult

interface GetDpsSharedAccessPolicyResult

A collection of values returned by getDpsSharedAccessPolicy.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property iothubDpsName

iothubDpsName: string;

property name

name: string;

property primaryConnectionString

primaryConnectionString: string;

The primary connection string of the Shared Access Policy.

property primaryKey

primaryKey: string;

The primary key used to create the authentication token.

property resourceGroupName

resourceGroupName: string;

property secondaryConnectionString

secondaryConnectionString: string;

The secondary connection string of the Shared Access Policy.

property secondaryKey

secondaryKey: string;

The secondary key used to create the authentication token.

interface GetIoTHubFunctionArgs

interface GetIoTHubFunctionArgs extends CallbackFunctionArgs<EventHubContext, any, appservice.FunctionDefaultResponse>

property callback

callback?: Callback<EventHubContext, any, appservice.FunctionDefaultResponse>;

The Javascript function instance to use as the entrypoint for the Azure FunctionApp. Either [callback] or [callbackFactory] must be provided.

property callbackFactory

callbackFactory?: CallbackFactory<EventHubContext, any, appservice.FunctionDefaultResponse>;

The Javascript function instance that will be called to produce the function that is the entrypoint for the Azure FunctionApp. Either [callback] or [callbackFactory] must be provided.

This form is useful when there is expensive initialization work that should only be executed once. The factory-function will be invoked once when the final Azure FunctionApp module is loaded. It can run whatever code it needs, and will end by returning the actual function that the Azure will call into each time the FunctionApp it is is invoked.

property cardinality

cardinality?: pulumi.Input<"many" | "one">;

Set to ‘many’ in order to enable batching. If omitted or set to ‘one’, single message passed to function.

property consumerGroup

consumerGroup?: ConsumerGroup;

Optional Consumer Group to subscribe the Function to. If not present, the default consumer group will be used.

property inputs

inputs?: InputBindingSettings[];

Input bindings.

property iotHub

iotHub: IoTHub;

IoT Hub to subscribe the Function to.

property outputs

outputs?: OutputBindingSettings[];

Output bindings.

interface GetSharedAccessPolicyArgs

interface GetSharedAccessPolicyArgs

A collection of arguments for invoking getSharedAccessPolicy.

property iothubName

iothubName: string;

The name of the IoTHub to which this Shared Access Policy belongs.

property name

name: string;

Specifies the name of the IotHub Shared Access Policy resource.

property resourceGroupName

resourceGroupName: string;

The name of the resource group under which the IotHub Shared Access Policy resource has to be created.

interface GetSharedAccessPolicyResult

interface GetSharedAccessPolicyResult

A collection of values returned by getSharedAccessPolicy.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property iothubName

iothubName: string;

property name

name: string;

property primaryConnectionString

primaryConnectionString: string;

The primary connection string of the Shared Access Policy.

property primaryKey

primaryKey: string;

The primary key used to create the authentication token.

property resourceGroupName

resourceGroupName: string;

property secondaryConnectionString

secondaryConnectionString: string;

The secondary connection string of the Shared Access Policy.

property secondaryKey

secondaryKey: string;

The secondary key used to create the authentication token.

interface IoTHubArgs

interface IoTHubArgs

The set of arguments for constructing a IoTHub resource.

property endpoints

endpoints?: pulumi.Input<pulumi.Input<IoTHubEndpoint>[]>;

An endpoint block as defined below.

property eventHubPartitionCount

eventHubPartitionCount?: pulumi.Input<number>;

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

property eventHubRetentionInDays

eventHubRetentionInDays?: pulumi.Input<number>;

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

property fallbackRoute

fallbackRoute?: pulumi.Input<IoTHubFallbackRoute>;

A fallbackRoute 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.

property fileUpload

fileUpload?: pulumi.Input<IoTHubFileUpload>;

A fileUpload block as defined below.

property ipFilterRules

ipFilterRules?: pulumi.Input<pulumi.Input<IoTHubIpFilterRule>[]>;

One or more ipFilterRule blocks as defined below.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.

property routes

routes?: pulumi.Input<pulumi.Input<IoTHubRoute>[]>;

A route block as defined below.

property sku

sku: pulumi.Input<IoTHubSku>;

A sku block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface IotHubCertificateArgs

interface IotHubCertificateArgs

The set of arguments for constructing a IotHubCertificate resource.

property certificateContent

certificateContent: pulumi.Input<string>;

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

property iotDpsName

iotDpsName: pulumi.Input<string>;

The name of the IoT Device Provisioning Service that this certificate will be attached to. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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.

interface IotHubCertificateState

interface IotHubCertificateState

Input properties used for looking up and filtering IotHubCertificate resources.

property certificateContent

certificateContent?: pulumi.Input<string>;

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

property iotDpsName

iotDpsName?: pulumi.Input<string>;

The name of the IoT Device Provisioning Service that this certificate will be attached to. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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.

interface IotHubDpsArgs

interface IotHubDpsArgs

The set of arguments for constructing a IotHubDps resource.

property linkedHubs

linkedHubs?: pulumi.Input<pulumi.Input<IotHubDpsLinkedHub>[]>;

A linkedHub block as defined below.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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.

property sku

sku: pulumi.Input<IotHubDpsSku>;

A sku block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface IotHubDpsState

interface IotHubDpsState

Input properties used for looking up and filtering IotHubDps resources.

property allocationPolicy

allocationPolicy?: pulumi.Input<string>;

The allocation policy of the IoT Device Provisioning Service.

property deviceProvisioningHostName

deviceProvisioningHostName?: pulumi.Input<string>;

The device endpoint of the IoT Device Provisioning Service.

property idScope

idScope?: pulumi.Input<string>;

The unique identifier of the IoT Device Provisioning Service.

property linkedHubs

linkedHubs?: pulumi.Input<pulumi.Input<IotHubDpsLinkedHub>[]>;

A linkedHub block as defined below.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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.

property serviceOperationsHostName

serviceOperationsHostName?: pulumi.Input<string>;

The service endpoint of the IoT Device Provisioning Service.

property sku

sku?: pulumi.Input<IotHubDpsSku>;

A sku block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

class IoTHubEventSubscription

class IoTHubEventSubscription extends EventSubscription<EventHubContext, string, appservice.FunctionDefaultResponse>

constructor

new IoTHubEventSubscription(name: string, iotHub: IoTHub, args: IoTHubSubscriptionArgs, opts: ComponentResourceOptions)

method getData

protected getData(): Promise<TData>

Retrieves the data produces by [initialize]. The data is immediately available in a derived class’s constructor after the super(...) call to ComponentResource.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method initialize

protected initialize(args: Inputs): Promise<TData>

Can be overridden by a subclass to asynchronously initialize data for this Component automatically when constructed. The data will be available immediately for subclass constructors to use. To access the data use .getData.

method isInstance

static isInstance(obj: any): obj is ComponentResource

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method registerOutputs

protected registerOutputs(outputs?: Inputs | Promise<Inputs> | Output<Inputs>): void

registerOutputs registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.

ComponentResources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.

property functionApp

public functionApp: CallbackFunctionApp<EventHubContext, string, appservice.FunctionDefaultResponse>;

property iotHub

iotHub: IoTHub;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class IoTHubFunction

class IoTHubFunction extends Function<EventHubContext, string, appservice.FunctionDefaultResponse>

Azure Function triggered by an IoT Hub.

constructor

new IoTHubFunction(name: string, args: IoTHubFunctionArgs)

property appSettings

public appSettings?: pulumi.Input<{[key: string]: string}>;

Application settings required by the function.

property bindings

public bindings: pulumi.Input<BindingDefinition[]>;

An array of function binding definitions.

property callback

public callback: CallbackArgs<EventHubContext, string, appservice.FunctionDefaultResponse>;

Function callback.

property name

public name: string;

Function name.

interface IoTHubFunctionArgs

interface IoTHubFunctionArgs extends GetIoTHubFunctionArgs

property callback

callback?: Callback<EventHubContext, any, appservice.FunctionDefaultResponse>;

The Javascript function instance to use as the entrypoint for the Azure FunctionApp. Either [callback] or [callbackFactory] must be provided.

property callbackFactory

callbackFactory?: CallbackFactory<EventHubContext, any, appservice.FunctionDefaultResponse>;

The Javascript function instance that will be called to produce the function that is the entrypoint for the Azure FunctionApp. Either [callback] or [callbackFactory] must be provided.

This form is useful when there is expensive initialization work that should only be executed once. The factory-function will be invoked once when the final Azure FunctionApp module is loaded. It can run whatever code it needs, and will end by returning the actual function that the Azure will call into each time the FunctionApp it is is invoked.

property cardinality

cardinality?: pulumi.Input<"many" | "one">;

Set to ‘many’ in order to enable batching. If omitted or set to ‘one’, single message passed to function.

property consumerGroup

consumerGroup?: ConsumerGroup;

Optional Consumer Group to subscribe the Function to. If not present, the default consumer group will be used.

property inputs

inputs?: InputBindingSettings[];

Input bindings.

property iotHub

iotHub: IoTHub;

IoT Hub to subscribe the Function to.

property outputs

outputs?: OutputBindingSettings[];

Output bindings.

interface IoTHubState

interface IoTHubState

Input properties used for looking up and filtering IoTHub resources.

property endpoints

endpoints?: pulumi.Input<pulumi.Input<IoTHubEndpoint>[]>;

An endpoint block as defined below.

property eventHubEventsEndpoint

eventHubEventsEndpoint?: pulumi.Input<string>;

The EventHub compatible endpoint for events data

property eventHubEventsPath

eventHubEventsPath?: pulumi.Input<string>;

The EventHub compatible path for events data

property eventHubOperationsEndpoint

eventHubOperationsEndpoint?: pulumi.Input<string>;

The EventHub compatible endpoint for operational data

property eventHubOperationsPath

eventHubOperationsPath?: pulumi.Input<string>;

The EventHub compatible path for operational data

property eventHubPartitionCount

eventHubPartitionCount?: pulumi.Input<number>;

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

property eventHubRetentionInDays

eventHubRetentionInDays?: pulumi.Input<number>;

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

property fallbackRoute

fallbackRoute?: pulumi.Input<IoTHubFallbackRoute>;

A fallbackRoute 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.

property fileUpload

fileUpload?: pulumi.Input<IoTHubFileUpload>;

A fileUpload block as defined below.

property hostname

hostname?: pulumi.Input<string>;

The hostname of the IotHub Resource.

property ipFilterRules

ipFilterRules?: pulumi.Input<pulumi.Input<IoTHubIpFilterRule>[]>;

One or more ipFilterRule blocks as defined below.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.

property routes

routes?: pulumi.Input<pulumi.Input<IoTHubRoute>[]>;

A route block as defined below.

property sharedAccessPolicies

sharedAccessPolicies?: pulumi.Input<pulumi.Input<IoTHubSharedAccessPolicy>[]>;

One or more sharedAccessPolicy blocks as defined below.

property sku

sku?: pulumi.Input<IoTHubSku>;

A sku block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property type

type?: pulumi.Input<string>;

The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

interface IoTHubSubscriptionArgs

interface IoTHubSubscriptionArgs extends GetIoTHubFunctionArgs, CallbackFunctionAppArgs<EventHubContext, any, appservice.FunctionDefaultResponse>

property account

account?: storageForTypesOnly.Account;

The storage account to use where the zip-file blob for the FunctionApp will be located. If not provided, a new storage account will create. It will be a ‘Standard’, ‘LRS’, ‘StorageV2’ account.

property appSettings

appSettings?: pulumi.Input<{[key: string]: any}>;

A key-value pair of App Settings.

property authSettings

authSettings?: pulumi.Input<FunctionAppAuthSettings>;

A authSettings block as defined below.

property callback

callback?: Callback<EventHubContext, any, appservice.FunctionDefaultResponse>;

The Javascript function instance to use as the entrypoint for the Azure FunctionApp. Either [callback] or [callbackFactory] must be provided.

property callbackFactory

callbackFactory?: CallbackFactory<EventHubContext, any, appservice.FunctionDefaultResponse>;

The Javascript function instance that will be called to produce the function that is the entrypoint for the Azure FunctionApp. Either [callback] or [callbackFactory] must be provided.

This form is useful when there is expensive initialization work that should only be executed once. The factory-function will be invoked once when the final Azure FunctionApp module is loaded. It can run whatever code it needs, and will end by returning the actual function that the Azure will call into each time the FunctionApp it is is invoked.

property cardinality

cardinality?: pulumi.Input<"many" | "one">;

Set to ‘many’ in order to enable batching. If omitted or set to ‘one’, single message passed to function.

property clientAffinityEnabled

clientAffinityEnabled?: pulumi.Input<boolean>;

Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?

property codePathOptions

codePathOptions?: pulumi.runtime.CodePathOptions;

Options to control which files and packages are included with the serialized FunctionApp code.

property connectionStrings

connectionStrings?: pulumi.Input<pulumi.Input<{
    name: pulumi.Input<string>;
    type: pulumi.Input<string>;
    value: pulumi.Input<string>;
}>[]>;

An connection_string block as defined below.

property consumerGroup

consumerGroup?: ConsumerGroup;

Optional Consumer Group to subscribe the Function to. If not present, the default consumer group will be used.

property container

container?: storageForTypesOnly.Container;

The container to use where the zip-file blob for the FunctionApp will be located. If not provided, the root container of the storage account will be used.

property dailyMemoryTimeQuota

dailyMemoryTimeQuota?: pulumi.Input<number>;

The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to 0.

property enableBuiltinLogging

enableBuiltinLogging?: pulumi.Input<boolean>;

Should the built-in logging of this Function App be enabled? Defaults to true.

property enabled

enabled?: pulumi.Input<boolean>;

Is the Function App enabled?

property hostSettings

hostSettings?: HostSettings;

Host configuration options.

property httpsOnly

httpsOnly?: pulumi.Input<boolean>;

Can the Function App only be accessed via HTTPS? Defaults to false.

property identity

identity?: pulumi.Input<FunctionAppIdentity>;

An identity block as defined below.

property inputs

inputs?: InputBindingSettings[];

Input bindings.

property iotHub

iotHub: IoTHub;

IoT Hub to subscribe the Function to.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the Function App.

property nodeVersion

nodeVersion?: pulumi.Input<string>;

Controls the value of WEBSITE_NODE_DEFAULT_VERSION in appSettings. If not provided, defaults to ~12.

property osType

osType?: pulumi.Input<string>;

A string indicating the Operating System type for this function app.

property outputs

outputs?: OutputBindingSettings[];

Output bindings.

property plan

plan?: appservice.Plan;

The App Service Plan within which to create this Function App. Changing this forces a new resource to be created.

If not provided, a default “Consumption” plan will be created. See: https://docs.microsoft.com/en-us/azure/azure-functions/functions-scale#consumption-plan for more details.

property resourceGroup

resourceGroup?: core.ResourceGroup;

The resource group in which to create the event subscription. [resourceGroup] takes precedence over [resourceGroupName].

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the event subscription. [resourceGroup] takes precedence over [resourceGroupName]. If none of the two is supplied, the IoT Hub’s resource group will be used.

property siteConfig

siteConfig?: pulumi.Input<FunctionAppSiteConfig>;

A site_config object as defined below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property version

version?: pulumi.Input<string>;

The runtime version associated with the Function App. Defaults to ~3.

interface RouteArgs

interface RouteArgs

The set of arguments for constructing a Route resource.

property condition

condition?: pulumi.Input<string>;

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

property enabled

enabled: pulumi.Input<boolean>;

Specifies whether a route is enabled.

property endpointNames

endpointNames: pulumi.Input<string>;

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

property iothubName

iothubName: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the route.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.

property source

source: pulumi.Input<string>;

The source that the routing rule is to be applied to. Possible values include: DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, Invalid, TwinChangeEvents.

interface RouteState

interface RouteState

Input properties used for looking up and filtering Route resources.

property condition

condition?: pulumi.Input<string>;

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

property enabled

enabled?: pulumi.Input<boolean>;

Specifies whether a route is enabled.

property endpointNames

endpointNames?: pulumi.Input<string>;

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

property iothubName

iothubName?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the route.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.

property source

source?: pulumi.Input<string>;

The source that the routing rule is to be applied to. Possible values include: DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, Invalid, TwinChangeEvents.

interface SharedAccessPolicyArgs

interface SharedAccessPolicyArgs

The set of arguments for constructing a SharedAccessPolicy resource.

property deviceConnect

deviceConnect?: pulumi.Input<boolean>;

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

property iothubName

iothubName: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property registryRead

registryRead?: pulumi.Input<boolean>;

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

property registryWrite

registryWrite?: pulumi.Input<boolean>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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.

property serviceConnect

serviceConnect?: pulumi.Input<boolean>;

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

interface SharedAccessPolicyState

interface SharedAccessPolicyState

Input properties used for looking up and filtering SharedAccessPolicy resources.

property deviceConnect

deviceConnect?: pulumi.Input<boolean>;

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

property iothubName

iothubName?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property primaryConnectionString

primaryConnectionString?: pulumi.Input<string>;

The primary connection string of the Shared Access Policy.

property primaryKey

primaryKey?: pulumi.Input<string>;

The primary key used to create the authentication token.

property registryRead

registryRead?: pulumi.Input<boolean>;

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

property registryWrite

registryWrite?: pulumi.Input<boolean>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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.

property secondaryConnectionString

secondaryConnectionString?: pulumi.Input<string>;

The secondary connection string of the Shared Access Policy.

property secondaryKey

secondaryKey?: pulumi.Input<string>;

The secondary key used to create the authentication token.

property serviceConnect

serviceConnect?: pulumi.Input<boolean>;

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

interface TimeSeriesInsightsStandardEnvironmentArgs

interface TimeSeriesInsightsStandardEnvironmentArgs

The set of arguments for constructing a TimeSeriesInsightsStandardEnvironment resource.

property dataRetentionTime

dataRetentionTime: pulumi.Input<string>;

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.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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.

property partitionKey

partitionKey?: pulumi.Input<string>;

The name of the event property which will be used to partition data. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Azure IoT Time Series Insights Standard Environment.

property skuName

skuName: pulumi.Input<string>;

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.

property storageLimitExceededBehavior

storageLimitExceededBehavior?: pulumi.Input<string>;

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.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface TimeSeriesInsightsStandardEnvironmentState

interface TimeSeriesInsightsStandardEnvironmentState

Input properties used for looking up and filtering TimeSeriesInsightsStandardEnvironment resources.

property dataRetentionTime

dataRetentionTime?: pulumi.Input<string>;

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.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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.

property partitionKey

partitionKey?: pulumi.Input<string>;

The name of the event property which will be used to partition data. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Azure IoT Time Series Insights Standard Environment.

property skuName

skuName?: pulumi.Input<string>;

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.

property storageLimitExceededBehavior

storageLimitExceededBehavior?: pulumi.Input<string>;

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.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.