1. Docs
  2. Reference
  3. API
  4. Azure
  5. iot
  6. GetDpsSharedAccessPolicy

GetDpsSharedAccessPolicy

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Iot.GetDpsSharedAccessPolicy.InvokeAsync(new Azure.Iot.GetDpsSharedAccessPolicyArgs
        {
            Name = "example",
            ResourceGroupName = azurerm_resource_group.Example.Name,
            IothubDpsName = azurerm_iothub_dps.Example.Name,
        }));
    }

}

package main

import (
    "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 {
        _, err := iot.LookupDpsSharedAccessPolicy(ctx, &iot.LookupDpsSharedAccessPolicyArgs{
            Name:              "example",
            ResourceGroupName: azurerm_resource_group.Example.Name,
            IothubDpsName:     azurerm_iothub_dps.Example.Name,
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure as azure

example = azure.iot.get_dps_shared_access_policy(name="example",
    resource_group_name=azurerm_resource_group["example"]["name"],
    iothub_dps_name=azurerm_iothub_dps["example"]["name"])
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,
});

Using GetDpsSharedAccessPolicy

function getDpsSharedAccessPolicy(args: GetDpsSharedAccessPolicyArgs, opts?: InvokeOptions): Promise<GetDpsSharedAccessPolicyResult>
function  get_dps_shared_access_policy(iothub_dps_name=None, name=None, resource_group_name=None, opts=None)
func LookupDpsSharedAccessPolicy(ctx *Context, args *LookupDpsSharedAccessPolicyArgs, opts ...InvokeOption) (*LookupDpsSharedAccessPolicyResult, error)

Note: This function is named LookupDpsSharedAccessPolicy in the Go SDK.

public static class GetDpsSharedAccessPolicy {
    public static Task<GetDpsSharedAccessPolicyResult> InvokeAsync(GetDpsSharedAccessPolicyArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

IothubDpsName string

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

Name string

Specifies the name of the IotHub Shared Access Policy.

ResourceGroupName string

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

IothubDpsName string

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

Name string

Specifies the name of the IotHub Shared Access Policy.

ResourceGroupName string

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

iothubDpsName string

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

name string

Specifies the name of the IotHub Shared Access Policy.

resourceGroupName string

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

iothub_dps_name str

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

name str

Specifies the name of the IotHub Shared Access Policy.

resource_group_name str

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

GetDpsSharedAccessPolicy Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

IothubDpsName string
Name string
PrimaryConnectionString string

The primary connection string of the Shared Access Policy.

PrimaryKey string

The primary key used to create the authentication token.

ResourceGroupName string
SecondaryConnectionString string

The secondary connection string of the Shared Access Policy.

SecondaryKey string

The secondary key used to create the authentication token.

Id string

The provider-assigned unique ID for this managed resource.

IothubDpsName string
Name string
PrimaryConnectionString string

The primary connection string of the Shared Access Policy.

PrimaryKey string

The primary key used to create the authentication token.

ResourceGroupName string
SecondaryConnectionString string

The secondary connection string of the Shared Access Policy.

SecondaryKey string

The secondary key used to create the authentication token.

id string

The provider-assigned unique ID for this managed resource.

iothubDpsName string
name string
primaryConnectionString string

The primary connection string of the Shared Access Policy.

primaryKey string

The primary key used to create the authentication token.

resourceGroupName string
secondaryConnectionString string

The secondary connection string of the Shared Access Policy.

secondaryKey string

The secondary key used to create the authentication token.

id str

The provider-assigned unique ID for this managed resource.

iothub_dps_name str
name str
primary_connection_string str

The primary connection string of the Shared Access Policy.

primary_key str

The primary key used to create the authentication token.

resource_group_name str
secondary_connection_string str

The secondary connection string of the Shared Access Policy.

secondary_key str

The secondary key used to create the authentication token.

Package Details

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