Azure Classic v5.37.0, Mar 15 23

azure.iot.getDps

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.Iot.GetDps.Invoke(new()
    {
        Name = "iot_hub_dps_test",
        ResourceGroupName = "iothub_dps_rg",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iot.GetDps(ctx, &iot.GetDpsArgs{
			Name:              "iot_hub_dps_test",
			ResourceGroupName: "iothub_dps_rg",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.iot.IotFunctions;
import com.pulumi.azure.iot.inputs.GetDpsArgs;
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) {
        final var example = IotFunctions.getDps(GetDpsArgs.builder()
            .name("iot_hub_dps_test")
            .resourceGroupName("iothub_dps_rg")
            .build());

    }
}

import pulumi
import pulumi_azure as azure

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

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

const example = azure.iot.getDps({
    name: "iot_hub_dps_test",
    resourceGroupName: "iothub_dps_rg",
});

variables:
  example:
    fn::invoke:
      Function: azure:iot:getDps
      Arguments:
        name: iot_hub_dps_test
        resourceGroupName: iothub_dps_rg

Using getDps

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDps(args: GetDpsArgs, opts?: InvokeOptions): Promise<GetDpsResult>
function getDpsOutput(args: GetDpsOutputArgs, opts?: InvokeOptions): Output<GetDpsResult>

def get_dps(name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            opts: Optional[InvokeOptions] = None) -> GetDpsResult
def get_dps_output(name: Optional[pulumi.Input[str]] = None,
            resource_group_name: Optional[pulumi.Input[str]] = None,
            tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetDpsResult]

func GetDps(ctx *Context, args *GetDpsArgs, opts ...InvokeOption) (*GetDpsResult, error)
func GetDpsOutput(ctx *Context, args *GetDpsOutputArgs, opts ...InvokeOption) GetDpsResultOutput

> Note: This function is named GetDps in the Go SDK.

public static class GetDps 
{
    public static Task<GetDpsResult> InvokeAsync(GetDpsArgs args, InvokeOptions? opts = null)
    public static Output<GetDpsResult> Invoke(GetDpsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDpsResult> getDps(GetDpsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure:iot/getDps:getDps
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Specifies the name of the Iot Device Provisioning Service resource.
ResourceGroupName string: The name of the resource group under which the Iot Device Provisioning Service is located in.
Tags Dictionary<string, string>

Name string: Specifies the name of the Iot Device Provisioning Service resource.
ResourceGroupName string: The name of the resource group under which the Iot Device Provisioning Service is located in.
Tags map[string]string

name String: Specifies the name of the Iot Device Provisioning Service resource.
resourceGroupName String: The name of the resource group under which the Iot Device Provisioning Service is located in.
tags Map<String,String>

name string: Specifies the name of the Iot Device Provisioning Service resource.
resourceGroupName string: The name of the resource group under which the Iot Device Provisioning Service is located in.
tags {[key: string]: string}

name str: Specifies the name of the Iot Device Provisioning Service resource.
resource_group_name str: The name of the resource group under which the Iot Device Provisioning Service is located in.
tags Mapping[str, str]

name String: Specifies the name of the Iot Device Provisioning Service resource.
resourceGroupName String: The name of the resource group under which the Iot Device Provisioning Service is located in.
tags Map<String>

getDps Result

The following output properties are available:

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.
Location string: Specifies the supported Azure location where the IoT Device Provisioning Service exists.
Name string
ResourceGroupName string
ServiceOperationsHostName string: The service endpoint of the IoT Device Provisioning Service.
Tags Dictionary<string, string>

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.
Location string: Specifies the supported Azure location where the IoT Device Provisioning Service exists.
Name string
ResourceGroupName string
ServiceOperationsHostName string: The service endpoint of the IoT Device Provisioning Service.
Tags map[string]string

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.
location String: Specifies the supported Azure location where the IoT Device Provisioning Service exists.
name String
resourceGroupName String
serviceOperationsHostName String: The service endpoint of the IoT Device Provisioning Service.
tags Map<String,String>

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.
location string: Specifies the supported Azure location where the IoT Device Provisioning Service exists.
name string
resourceGroupName string
serviceOperationsHostName string: The service endpoint of the IoT Device Provisioning Service.
tags {[key: string]: string}

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.
location str: Specifies the supported Azure location where the IoT Device Provisioning Service exists.
name str
resource_group_name str
service_operations_host_name str: The service endpoint of the IoT Device Provisioning Service.
tags Mapping[str, str]

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.
location String: Specifies the supported Azure location where the IoT Device Provisioning Service exists.
name String
resourceGroupName String
serviceOperationsHostName String: The service endpoint of the IoT Device Provisioning Service.
tags Map<String>

Package Details

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

azure.iot.getDps

Example Usage

Using getDps

getDps Result

Package Details

Contents