Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. iot
  5. IotHubDps

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.iot.IotHubDps

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an IotHub Device Provisioning Service.

Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleIotHubDps = new azure.iot.IotHubDps("example", {
    name: "example",
    resourceGroupName: example.name,
    location: example.location,
    allocationPolicy: "Hashed",
    sku: {
        name: "S1",
        capacity: 1,
    },
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_iot_hub_dps = azure.iot.IotHubDps("example",
    name="example",
    resource_group_name=example.name,
    location=example.location,
    allocation_policy="Hashed",
    sku={
        "name": "S1",
        "capacity": 1,
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/iot"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = iot.NewIotHubDps(ctx, "example", &iot.IotHubDpsArgs{
			Name:              pulumi.String("example"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			AllocationPolicy:  pulumi.String("Hashed"),
			Sku: &iot.IotHubDpsSkuArgs{
				Name:     pulumi.String("S1"),
				Capacity: pulumi.Int(1),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleIotHubDps = new Azure.Iot.IotHubDps("example", new()
    {
        Name = "example",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AllocationPolicy = "Hashed",
        Sku = new Azure.Iot.Inputs.IotHubDpsSkuArgs
        {
            Name = "S1",
            Capacity = 1,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.iot.IotHubDps;
import com.pulumi.azure.iot.IotHubDpsArgs;
import com.pulumi.azure.iot.inputs.IotHubDpsSkuArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleIotHubDps = new IotHubDps("exampleIotHubDps", IotHubDpsArgs.builder()
            .name("example")
            .resourceGroupName(example.name())
            .location(example.location())
            .allocationPolicy("Hashed")
            .sku(IotHubDpsSkuArgs.builder()
                .name("S1")
                .capacity("1")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleIotHubDps:
    type: azure:iot:IotHubDps
    name: example
    properties:
      name: example
      resourceGroupName: ${example.name}
      location: ${example.location}
      allocationPolicy: Hashed
      sku:
        name: S1
        capacity: '1'
Copy

Create IotHubDps Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IotHubDps(name: string, args: IotHubDpsArgs, opts?: CustomResourceOptions);
@overload
def IotHubDps(resource_name: str,
              args: IotHubDpsArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def IotHubDps(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              resource_group_name: Optional[str] = None,
              sku: Optional[IotHubDpsSkuArgs] = None,
              allocation_policy: Optional[str] = None,
              data_residency_enabled: Optional[bool] = None,
              ip_filter_rules: Optional[Sequence[IotHubDpsIpFilterRuleArgs]] = None,
              linked_hubs: Optional[Sequence[IotHubDpsLinkedHubArgs]] = None,
              location: Optional[str] = None,
              name: Optional[str] = None,
              public_network_access_enabled: Optional[bool] = None,
              tags: Optional[Mapping[str, str]] = None)
func NewIotHubDps(ctx *Context, name string, args IotHubDpsArgs, opts ...ResourceOption) (*IotHubDps, error)
public IotHubDps(string name, IotHubDpsArgs args, CustomResourceOptions? opts = null)
public IotHubDps(String name, IotHubDpsArgs args)
public IotHubDps(String name, IotHubDpsArgs args, CustomResourceOptions options)

type: azure:iot:IotHubDps
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IotHubDpsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IotHubDpsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IotHubDpsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IotHubDpsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IotHubDpsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var iotHubDpsResource = new Azure.Iot.IotHubDps("iotHubDpsResource", new()
{
    ResourceGroupName = "string",
    Sku = new Azure.Iot.Inputs.IotHubDpsSkuArgs
    {
        Capacity = 0,
        Name = "string",
    },
    AllocationPolicy = "string",
    DataResidencyEnabled = false,
    IpFilterRules = new[]
    {
        new Azure.Iot.Inputs.IotHubDpsIpFilterRuleArgs
        {
            Action = "string",
            IpMask = "string",
            Name = "string",
            Target = "string",
        },
    },
    LinkedHubs = new[]
    {
        new Azure.Iot.Inputs.IotHubDpsLinkedHubArgs
        {
            ConnectionString = "string",
            Location = "string",
            AllocationWeight = 0,
            ApplyAllocationPolicy = false,
            Hostname = "string",
        },
    },
    Location = "string",
    Name = "string",
    PublicNetworkAccessEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := iot.NewIotHubDps(ctx, "iotHubDpsResource", &iot.IotHubDpsArgs{
	ResourceGroupName: pulumi.String("string"),
	Sku: &iot.IotHubDpsSkuArgs{
		Capacity: pulumi.Int(0),
		Name:     pulumi.String("string"),
	},
	AllocationPolicy:     pulumi.String("string"),
	DataResidencyEnabled: pulumi.Bool(false),
	IpFilterRules: iot.IotHubDpsIpFilterRuleArray{
		&iot.IotHubDpsIpFilterRuleArgs{
			Action: pulumi.String("string"),
			IpMask: pulumi.String("string"),
			Name:   pulumi.String("string"),
			Target: pulumi.String("string"),
		},
	},
	LinkedHubs: iot.IotHubDpsLinkedHubArray{
		&iot.IotHubDpsLinkedHubArgs{
			ConnectionString:      pulumi.String("string"),
			Location:              pulumi.String("string"),
			AllocationWeight:      pulumi.Int(0),
			ApplyAllocationPolicy: pulumi.Bool(false),
			Hostname:              pulumi.String("string"),
		},
	},
	Location:                   pulumi.String("string"),
	Name:                       pulumi.String("string"),
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var iotHubDpsResource = new IotHubDps("iotHubDpsResource", IotHubDpsArgs.builder()
    .resourceGroupName("string")
    .sku(IotHubDpsSkuArgs.builder()
        .capacity(0)
        .name("string")
        .build())
    .allocationPolicy("string")
    .dataResidencyEnabled(false)
    .ipFilterRules(IotHubDpsIpFilterRuleArgs.builder()
        .action("string")
        .ipMask("string")
        .name("string")
        .target("string")
        .build())
    .linkedHubs(IotHubDpsLinkedHubArgs.builder()
        .connectionString("string")
        .location("string")
        .allocationWeight(0)
        .applyAllocationPolicy(false)
        .hostname("string")
        .build())
    .location("string")
    .name("string")
    .publicNetworkAccessEnabled(false)
    .tags(Map.of("string", "string"))
    .build());
Copy
iot_hub_dps_resource = azure.iot.IotHubDps("iotHubDpsResource",
    resource_group_name="string",
    sku={
        "capacity": 0,
        "name": "string",
    },
    allocation_policy="string",
    data_residency_enabled=False,
    ip_filter_rules=[{
        "action": "string",
        "ip_mask": "string",
        "name": "string",
        "target": "string",
    }],
    linked_hubs=[{
        "connection_string": "string",
        "location": "string",
        "allocation_weight": 0,
        "apply_allocation_policy": False,
        "hostname": "string",
    }],
    location="string",
    name="string",
    public_network_access_enabled=False,
    tags={
        "string": "string",
    })
Copy
const iotHubDpsResource = new azure.iot.IotHubDps("iotHubDpsResource", {
    resourceGroupName: "string",
    sku: {
        capacity: 0,
        name: "string",
    },
    allocationPolicy: "string",
    dataResidencyEnabled: false,
    ipFilterRules: [{
        action: "string",
        ipMask: "string",
        name: "string",
        target: "string",
    }],
    linkedHubs: [{
        connectionString: "string",
        location: "string",
        allocationWeight: 0,
        applyAllocationPolicy: false,
        hostname: "string",
    }],
    location: "string",
    name: "string",
    publicNetworkAccessEnabled: false,
    tags: {
        string: "string",
    },
});
Copy
type: azure:iot:IotHubDps
properties:
    allocationPolicy: string
    dataResidencyEnabled: false
    ipFilterRules:
        - action: string
          ipMask: string
          name: string
          target: string
    linkedHubs:
        - allocationWeight: 0
          applyAllocationPolicy: false
          connectionString: string
          hostname: string
          location: string
    location: string
    name: string
    publicNetworkAccessEnabled: false
    resourceGroupName: string
    sku:
        capacity: 0
        name: string
    tags:
        string: string
Copy

IotHubDps Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The IotHubDps resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
Sku This property is required. IotHubDpsSku
A sku block as defined below.
AllocationPolicy string
The allocation policy of the IoT Device Provisioning Service (Hashed, GeoLatency or Static). Defaults to Hashed.
DataResidencyEnabled Changes to this property will trigger replacement. bool
Specifies if the IoT Device Provisioning Service has data residency and disaster recovery enabled. Defaults to false. Changing this forces a new resource to be created.
IpFilterRules List<IotHubDpsIpFilterRule>
An ip_filter_rule block as defined below.
LinkedHubs List<IotHubDpsLinkedHub>
A linked_hub block as defined below.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
PublicNetworkAccessEnabled bool
Whether requests from Public Network are allowed. Defaults to true.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
Sku This property is required. IotHubDpsSkuArgs
A sku block as defined below.
AllocationPolicy string
The allocation policy of the IoT Device Provisioning Service (Hashed, GeoLatency or Static). Defaults to Hashed.
DataResidencyEnabled Changes to this property will trigger replacement. bool
Specifies if the IoT Device Provisioning Service has data residency and disaster recovery enabled. Defaults to false. Changing this forces a new resource to be created.
IpFilterRules []IotHubDpsIpFilterRuleArgs
An ip_filter_rule block as defined below.
LinkedHubs []IotHubDpsLinkedHubArgs
A linked_hub block as defined below.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
PublicNetworkAccessEnabled bool
Whether requests from Public Network are allowed. Defaults to true.
Tags map[string]string
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
sku This property is required. IotHubDpsSku
A sku block as defined below.
allocationPolicy String
The allocation policy of the IoT Device Provisioning Service (Hashed, GeoLatency or Static). Defaults to Hashed.
dataResidencyEnabled Changes to this property will trigger replacement. Boolean
Specifies if the IoT Device Provisioning Service has data residency and disaster recovery enabled. Defaults to false. Changing this forces a new resource to be created.
ipFilterRules List<IotHubDpsIpFilterRule>
An ip_filter_rule block as defined below.
linkedHubs List<IotHubDpsLinkedHub>
A linked_hub block as defined below.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
publicNetworkAccessEnabled Boolean
Whether requests from Public Network are allowed. Defaults to true.
tags Map<String,String>
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
sku This property is required. IotHubDpsSku
A sku block as defined below.
allocationPolicy string
The allocation policy of the IoT Device Provisioning Service (Hashed, GeoLatency or Static). Defaults to Hashed.
dataResidencyEnabled Changes to this property will trigger replacement. boolean
Specifies if the IoT Device Provisioning Service has data residency and disaster recovery enabled. Defaults to false. Changing this forces a new resource to be created.
ipFilterRules IotHubDpsIpFilterRule[]
An ip_filter_rule block as defined below.
linkedHubs IotHubDpsLinkedHub[]
A linked_hub block as defined below.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
publicNetworkAccessEnabled boolean
Whether requests from Public Network are allowed. Defaults to true.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group under which the Iot Device Provisioning Service resource has to be created. Changing this forces a new resource to be created.
sku This property is required. IotHubDpsSkuArgs
A sku block as defined below.
allocation_policy str
The allocation policy of the IoT Device Provisioning Service (Hashed, GeoLatency or Static). Defaults to Hashed.
data_residency_enabled Changes to this property will trigger replacement. bool
Specifies if the IoT Device Provisioning Service has data residency and disaster recovery enabled. Defaults to false. Changing this forces a new resource to be created.
ip_filter_rules Sequence[IotHubDpsIpFilterRuleArgs]
An ip_filter_rule block as defined below.
linked_hubs Sequence[IotHubDpsLinkedHubArgs]
A linked_hub block as defined below.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
public_network_access_enabled bool
Whether requests from Public Network are allowed. Defaults to true.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
sku This property is required. Property Map
A sku block as defined below.
allocationPolicy String
The allocation policy of the IoT Device Provisioning Service (Hashed, GeoLatency or Static). Defaults to Hashed.
dataResidencyEnabled Changes to this property will trigger replacement. Boolean
Specifies if the IoT Device Provisioning Service has data residency and disaster recovery enabled. Defaults to false. Changing this forces a new resource to be created.
ipFilterRules List<Property Map>
An ip_filter_rule block as defined below.
linkedHubs List<Property Map>
A linked_hub block as defined below.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
publicNetworkAccessEnabled Boolean
Whether requests from Public Network are allowed. Defaults to true.
tags Map<String>
A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the IotHubDps resource produces the following output properties:

DeviceProvisioningHostName string
The device endpoint of the IoT Device Provisioning Service.
Id string
The provider-assigned unique ID for this managed resource.
IdScope string
The unique identifier of the IoT Device Provisioning Service.
ServiceOperationsHostName string
The service endpoint of the IoT Device Provisioning Service.
DeviceProvisioningHostName string
The device endpoint of the IoT Device Provisioning Service.
Id string
The provider-assigned unique ID for this managed resource.
IdScope string
The unique identifier of the IoT Device Provisioning Service.
ServiceOperationsHostName string
The service endpoint of the IoT Device Provisioning Service.
deviceProvisioningHostName String
The device endpoint of the IoT Device Provisioning Service.
id String
The provider-assigned unique ID for this managed resource.
idScope String
The unique identifier of the IoT Device Provisioning Service.
serviceOperationsHostName String
The service endpoint of the IoT Device Provisioning Service.
deviceProvisioningHostName string
The device endpoint of the IoT Device Provisioning Service.
id string
The provider-assigned unique ID for this managed resource.
idScope string
The unique identifier of the IoT Device Provisioning Service.
serviceOperationsHostName string
The service endpoint of the IoT Device Provisioning Service.
device_provisioning_host_name str
The device endpoint of the IoT Device Provisioning Service.
id str
The provider-assigned unique ID for this managed resource.
id_scope str
The unique identifier of the IoT Device Provisioning Service.
service_operations_host_name str
The service endpoint of the IoT Device Provisioning Service.
deviceProvisioningHostName String
The device endpoint of the IoT Device Provisioning Service.
id String
The provider-assigned unique ID for this managed resource.
idScope String
The unique identifier of the IoT Device Provisioning Service.
serviceOperationsHostName String
The service endpoint of the IoT Device Provisioning Service.

Look up Existing IotHubDps Resource

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

public static get(name: string, id: Input<ID>, state?: IotHubDpsState, opts?: CustomResourceOptions): IotHubDps
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocation_policy: Optional[str] = None,
        data_residency_enabled: Optional[bool] = None,
        device_provisioning_host_name: Optional[str] = None,
        id_scope: Optional[str] = None,
        ip_filter_rules: Optional[Sequence[IotHubDpsIpFilterRuleArgs]] = None,
        linked_hubs: Optional[Sequence[IotHubDpsLinkedHubArgs]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        resource_group_name: Optional[str] = None,
        service_operations_host_name: Optional[str] = None,
        sku: Optional[IotHubDpsSkuArgs] = None,
        tags: Optional[Mapping[str, str]] = None) -> IotHubDps
func GetIotHubDps(ctx *Context, name string, id IDInput, state *IotHubDpsState, opts ...ResourceOption) (*IotHubDps, error)
public static IotHubDps Get(string name, Input<string> id, IotHubDpsState? state, CustomResourceOptions? opts = null)
public static IotHubDps get(String name, Output<String> id, IotHubDpsState state, CustomResourceOptions options)
resources:  _:    type: azure:iot:IotHubDps    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AllocationPolicy string
The allocation policy of the IoT Device Provisioning Service (Hashed, GeoLatency or Static). Defaults to Hashed.
DataResidencyEnabled Changes to this property will trigger replacement. bool
Specifies if the IoT Device Provisioning Service has data residency and disaster recovery enabled. Defaults to false. Changing this forces a new resource to be created.
DeviceProvisioningHostName string
The device endpoint of the IoT Device Provisioning Service.
IdScope string
The unique identifier of the IoT Device Provisioning Service.
IpFilterRules List<IotHubDpsIpFilterRule>
An ip_filter_rule block as defined below.
LinkedHubs List<IotHubDpsLinkedHub>
A linked_hub block as defined below.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
PublicNetworkAccessEnabled bool
Whether requests from Public Network are allowed. Defaults to true.
ResourceGroupName Changes to this property will trigger replacement. 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.
ServiceOperationsHostName string
The service endpoint of the IoT Device Provisioning Service.
Sku IotHubDpsSku
A sku block as defined below.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
AllocationPolicy string
The allocation policy of the IoT Device Provisioning Service (Hashed, GeoLatency or Static). Defaults to Hashed.
DataResidencyEnabled Changes to this property will trigger replacement. bool
Specifies if the IoT Device Provisioning Service has data residency and disaster recovery enabled. Defaults to false. Changing this forces a new resource to be created.
DeviceProvisioningHostName string
The device endpoint of the IoT Device Provisioning Service.
IdScope string
The unique identifier of the IoT Device Provisioning Service.
IpFilterRules []IotHubDpsIpFilterRuleArgs
An ip_filter_rule block as defined below.
LinkedHubs []IotHubDpsLinkedHubArgs
A linked_hub block as defined below.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
PublicNetworkAccessEnabled bool
Whether requests from Public Network are allowed. Defaults to true.
ResourceGroupName Changes to this property will trigger replacement. 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.
ServiceOperationsHostName string
The service endpoint of the IoT Device Provisioning Service.
Sku IotHubDpsSkuArgs
A sku block as defined below.
Tags map[string]string
A mapping of tags to assign to the resource.
allocationPolicy String
The allocation policy of the IoT Device Provisioning Service (Hashed, GeoLatency or Static). Defaults to Hashed.
dataResidencyEnabled Changes to this property will trigger replacement. Boolean
Specifies if the IoT Device Provisioning Service has data residency and disaster recovery enabled. Defaults to false. Changing this forces a new resource to be created.
deviceProvisioningHostName String
The device endpoint of the IoT Device Provisioning Service.
idScope String
The unique identifier of the IoT Device Provisioning Service.
ipFilterRules List<IotHubDpsIpFilterRule>
An ip_filter_rule block as defined below.
linkedHubs List<IotHubDpsLinkedHub>
A linked_hub block as defined below.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
publicNetworkAccessEnabled Boolean
Whether requests from Public Network are allowed. Defaults to true.
resourceGroupName Changes to this property will trigger replacement. 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.
serviceOperationsHostName String
The service endpoint of the IoT Device Provisioning Service.
sku IotHubDpsSku
A sku block as defined below.
tags Map<String,String>
A mapping of tags to assign to the resource.
allocationPolicy string
The allocation policy of the IoT Device Provisioning Service (Hashed, GeoLatency or Static). Defaults to Hashed.
dataResidencyEnabled Changes to this property will trigger replacement. boolean
Specifies if the IoT Device Provisioning Service has data residency and disaster recovery enabled. Defaults to false. Changing this forces a new resource to be created.
deviceProvisioningHostName string
The device endpoint of the IoT Device Provisioning Service.
idScope string
The unique identifier of the IoT Device Provisioning Service.
ipFilterRules IotHubDpsIpFilterRule[]
An ip_filter_rule block as defined below.
linkedHubs IotHubDpsLinkedHub[]
A linked_hub block as defined below.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
publicNetworkAccessEnabled boolean
Whether requests from Public Network are allowed. Defaults to true.
resourceGroupName Changes to this property will trigger replacement. 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.
serviceOperationsHostName string
The service endpoint of the IoT Device Provisioning Service.
sku IotHubDpsSku
A sku block as defined below.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
allocation_policy str
The allocation policy of the IoT Device Provisioning Service (Hashed, GeoLatency or Static). Defaults to Hashed.
data_residency_enabled Changes to this property will trigger replacement. bool
Specifies if the IoT Device Provisioning Service has data residency and disaster recovery enabled. Defaults to false. Changing this forces a new resource to be created.
device_provisioning_host_name str
The device endpoint of the IoT Device Provisioning Service.
id_scope str
The unique identifier of the IoT Device Provisioning Service.
ip_filter_rules Sequence[IotHubDpsIpFilterRuleArgs]
An ip_filter_rule block as defined below.
linked_hubs Sequence[IotHubDpsLinkedHubArgs]
A linked_hub block as defined below.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
public_network_access_enabled bool
Whether requests from Public Network are allowed. Defaults to true.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group under which the Iot Device Provisioning Service resource has to be created. Changing this forces a new resource to be created.
service_operations_host_name str
The service endpoint of the IoT Device Provisioning Service.
sku IotHubDpsSkuArgs
A sku block as defined below.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
allocationPolicy String
The allocation policy of the IoT Device Provisioning Service (Hashed, GeoLatency or Static). Defaults to Hashed.
dataResidencyEnabled Changes to this property will trigger replacement. Boolean
Specifies if the IoT Device Provisioning Service has data residency and disaster recovery enabled. Defaults to false. Changing this forces a new resource to be created.
deviceProvisioningHostName String
The device endpoint of the IoT Device Provisioning Service.
idScope String
The unique identifier of the IoT Device Provisioning Service.
ipFilterRules List<Property Map>
An ip_filter_rule block as defined below.
linkedHubs List<Property Map>
A linked_hub block as defined below.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
publicNetworkAccessEnabled Boolean
Whether requests from Public Network are allowed. Defaults to true.
resourceGroupName Changes to this property will trigger replacement. 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.
serviceOperationsHostName String
The service endpoint of the IoT Device Provisioning Service.
sku Property Map
A sku block as defined below.
tags Map<String>
A mapping of tags to assign to the resource.

Supporting Types

IotHubDpsIpFilterRule
, IotHubDpsIpFilterRuleArgs

Action This property is required. string
The desired action for requests captured by this rule. Possible values are Accept, Reject
IpMask This property is required. string
The IP address range in CIDR notation for the rule.
Name This property is required. string
The name of the filter.
Target string
Target for requests captured by this rule. Possible values are all, deviceApi and serviceApi.
Action This property is required. string
The desired action for requests captured by this rule. Possible values are Accept, Reject
IpMask This property is required. string
The IP address range in CIDR notation for the rule.
Name This property is required. string
The name of the filter.
Target string
Target for requests captured by this rule. Possible values are all, deviceApi and serviceApi.
action This property is required. String
The desired action for requests captured by this rule. Possible values are Accept, Reject
ipMask This property is required. String
The IP address range in CIDR notation for the rule.
name This property is required. String
The name of the filter.
target String
Target for requests captured by this rule. Possible values are all, deviceApi and serviceApi.
action This property is required. string
The desired action for requests captured by this rule. Possible values are Accept, Reject
ipMask This property is required. string
The IP address range in CIDR notation for the rule.
name This property is required. string
The name of the filter.
target string
Target for requests captured by this rule. Possible values are all, deviceApi and serviceApi.
action This property is required. str
The desired action for requests captured by this rule. Possible values are Accept, Reject
ip_mask This property is required. str
The IP address range in CIDR notation for the rule.
name This property is required. str
The name of the filter.
target str
Target for requests captured by this rule. Possible values are all, deviceApi and serviceApi.
action This property is required. String
The desired action for requests captured by this rule. Possible values are Accept, Reject
ipMask This property is required. String
The IP address range in CIDR notation for the rule.
name This property is required. String
The name of the filter.
target String
Target for requests captured by this rule. Possible values are all, deviceApi and serviceApi.

IotHubDpsLinkedHub
, IotHubDpsLinkedHubArgs

ConnectionString This property is required. string
The connection string to connect to the IoT Hub.
Location This property is required. string
The location of the IoT hub.
AllocationWeight int
The weight applied to the IoT Hub. Defaults to 1.
ApplyAllocationPolicy bool
Determines whether to apply allocation policies to the IoT Hub. Defaults to true.
Hostname string
The IoT Hub hostname.
ConnectionString This property is required. string
The connection string to connect to the IoT Hub.
Location This property is required. string
The location of the IoT hub.
AllocationWeight int
The weight applied to the IoT Hub. Defaults to 1.
ApplyAllocationPolicy bool
Determines whether to apply allocation policies to the IoT Hub. Defaults to true.
Hostname string
The IoT Hub hostname.
connectionString This property is required. String
The connection string to connect to the IoT Hub.
location This property is required. String
The location of the IoT hub.
allocationWeight Integer
The weight applied to the IoT Hub. Defaults to 1.
applyAllocationPolicy Boolean
Determines whether to apply allocation policies to the IoT Hub. Defaults to true.
hostname String
The IoT Hub hostname.
connectionString This property is required. string
The connection string to connect to the IoT Hub.
location This property is required. string
The location of the IoT hub.
allocationWeight number
The weight applied to the IoT Hub. Defaults to 1.
applyAllocationPolicy boolean
Determines whether to apply allocation policies to the IoT Hub. Defaults to true.
hostname string
The IoT Hub hostname.
connection_string This property is required. str
The connection string to connect to the IoT Hub.
location This property is required. str
The location of the IoT hub.
allocation_weight int
The weight applied to the IoT Hub. Defaults to 1.
apply_allocation_policy bool
Determines whether to apply allocation policies to the IoT Hub. Defaults to true.
hostname str
The IoT Hub hostname.
connectionString This property is required. String
The connection string to connect to the IoT Hub.
location This property is required. String
The location of the IoT hub.
allocationWeight Number
The weight applied to the IoT Hub. Defaults to 1.
applyAllocationPolicy Boolean
Determines whether to apply allocation policies to the IoT Hub. Defaults to true.
hostname String
The IoT Hub hostname.

IotHubDpsSku
, IotHubDpsSkuArgs

Capacity This property is required. int
The number of provisioned IoT Device Provisioning Service units.
Name This property is required. string
The name of the sku. Currently can only be set to S1.
Capacity This property is required. int
The number of provisioned IoT Device Provisioning Service units.
Name This property is required. string
The name of the sku. Currently can only be set to S1.
capacity This property is required. Integer
The number of provisioned IoT Device Provisioning Service units.
name This property is required. String
The name of the sku. Currently can only be set to S1.
capacity This property is required. number
The number of provisioned IoT Device Provisioning Service units.
name This property is required. string
The name of the sku. Currently can only be set to S1.
capacity This property is required. int
The number of provisioned IoT Device Provisioning Service units.
name This property is required. str
The name of the sku. Currently can only be set to S1.
capacity This property is required. Number
The number of provisioned IoT Device Provisioning Service units.
name This property is required. String
The name of the sku. Currently can only be set to S1.

Import

IoT Device Provisioning Service can be imported using the resource id, e.g.

$ pulumi import azure:iot/iotHubDps:IotHubDps example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Devices/provisioningServices/example
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure