IotHubDps

Manages an IotHub Device Provisioning Service.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West US",
        });
        var exampleIotHubDps = new Azure.Iot.IotHubDps("exampleIotHubDps", new Azure.Iot.IotHubDpsArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            Sku = new Azure.Iot.Inputs.IotHubDpsSkuArgs
            {
                Name = "S1",
                Capacity = 1,
            },
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West US"),
        })
        if err != nil {
            return err
        }
        _, err = iot.NewIotHubDps(ctx, "exampleIotHubDps", &iot.IotHubDpsArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            Location:          exampleResourceGroup.Location,
            Sku: &iot.IotHubDpsSkuArgs{
                Name:     pulumi.String("S1"),
                Capacity: pulumi.Int(1),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

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

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",
    },
});

Create a IotHubDps Resource

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

def IotHubDps(resource_name, opts=None, linked_hubs=None, location=None, name=None, resource_group_name=None, sku=None, tags=None, __props__=None);

func NewIotHubDps(ctx *Context, name string, args IotHubDpsArgs, opts ...ResourceOption) (*IotHubDps, error)

public IotHubDps(string name, IotHubDpsArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args IotHubDpsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args IotHubDpsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IotHubDpsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

IotHubDps Resource Properties

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

Inputs

The IotHubDps resource accepts the following input properties:

ResourceGroupName 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 IotHubDpsSkuArgs: A sku block as defined below.
LinkedHubs List<IotHubDpsLinkedHubArgs>: A linked_hub block as defined below.
Location string: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
Name string: Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

ResourceGroupName 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 IotHubDpsSku: A sku block as defined below.
LinkedHubs []IotHubDpsLinkedHub: A linked_hub block as defined below.
Location string: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
Name string: Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

resourceGroupName 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 IotHubDpsSku: A sku block as defined below.
linkedHubs IotHubDpsLinkedHub[]: A linked_hub block as defined below.
location string: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
name string: Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

resource_group_name 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 Dict[IotHubDpsSku]: A sku block as defined below.
linked_hubs List[IotHubDpsLinkedHub]: A linked_hub block as defined below.
location str: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
name str: Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
tags Dict[str, str]: 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:

AllocationPolicy string: The allocation policy 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.

AllocationPolicy string: The allocation policy 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.

allocationPolicy string: The allocation policy 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.

allocation_policy str: The allocation policy 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.

Look up an 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

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

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)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AllocationPolicy string: The allocation policy of the IoT Device Provisioning Service.
DeviceProvisioningHostName string: The device endpoint of the IoT Device Provisioning Service.
IdScope string: The unique identifier of the IoT Device Provisioning Service.
LinkedHubs List<IotHubDpsLinkedHubArgs>: A linked_hub block as defined below.
Location string: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
Name string: Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
ResourceGroupName 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 Dictionary<string, string>: A mapping of tags to assign to the resource.

AllocationPolicy string: The allocation policy of the IoT Device Provisioning Service.
DeviceProvisioningHostName string: The device endpoint of the IoT Device Provisioning Service.
IdScope string: The unique identifier of the IoT Device Provisioning Service.
LinkedHubs []IotHubDpsLinkedHub: A linked_hub block as defined below.
Location string: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
Name string: Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
ResourceGroupName 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.
deviceProvisioningHostName string: The device endpoint of the IoT Device Provisioning Service.
idScope string: The unique identifier of the IoT Device Provisioning Service.
linkedHubs IotHubDpsLinkedHub[]: A linked_hub block as defined below.
location string: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
name string: Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
resourceGroupName 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.
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.
linked_hubs List[IotHubDpsLinkedHub]: A linked_hub block as defined below.
location str: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
name str: Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
resource_group_name 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 Dict[IotHubDpsSku]: A sku block as defined below.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Supporting Types

IotHubDpsLinkedHub

See the input and output API doc for this type.

ConnectionString string: The connection string to connect to the IoT Hub. Changing this forces a new resource.
Location string: The location of the IoT hub. Changing this forces a new resource.
AllocationWeight int: The weight applied to the IoT Hub. Defaults to 0.
ApplyAllocationPolicy bool: Determines whether to apply allocation policies to the IoT Hub. Defaults to false.
Hostname string: The IoT Hub hostname.

ConnectionString string: The connection string to connect to the IoT Hub. Changing this forces a new resource.
Location string: The location of the IoT hub. Changing this forces a new resource.
AllocationWeight int: The weight applied to the IoT Hub. Defaults to 0.
ApplyAllocationPolicy bool: Determines whether to apply allocation policies to the IoT Hub. Defaults to false.
Hostname string: The IoT Hub hostname.

connectionString string: The connection string to connect to the IoT Hub. Changing this forces a new resource.
location string: The location of the IoT hub. Changing this forces a new resource.
allocationWeight number: The weight applied to the IoT Hub. Defaults to 0.
applyAllocationPolicy boolean: Determines whether to apply allocation policies to the IoT Hub. Defaults to false.
hostname string: The IoT Hub hostname.

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

IotHubDpsSku

See the input and output API doc for this type.

Capacity int: The number of provisioned IoT Device Provisioning Service units.
Name string: The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

Capacity int: The number of provisioned IoT Device Provisioning Service units.
Name string: The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

capacity number: The number of provisioned IoT Device Provisioning Service units.
name string: The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

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

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud