DpsSharedAccessPolicy

class DpsSharedAccessPolicy : KotlinCustomResource

Manages an IotHub Device Provisioning Service Shared Access Policy

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,
sku: {
name: "S1",
capacity: 1,
},
});
const exampleDpsSharedAccessPolicy = new azure.iot.DpsSharedAccessPolicy("example", {
name: "example",
resourceGroupName: example.name,
iothubDpsName: exampleIotHubDps.name,
enrollmentWrite: true,
enrollmentRead: true,
});
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,
sku={
"name": "S1",
"capacity": 1,
})
example_dps_shared_access_policy = azure.iot.DpsSharedAccessPolicy("example",
name="example",
resource_group_name=example.name,
iothub_dps_name=example_iot_hub_dps.name,
enrollment_write=True,
enrollment_read=True)
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,
Sku = new Azure.Iot.Inputs.IotHubDpsSkuArgs
{
Name = "S1",
Capacity = 1,
},
});
var exampleDpsSharedAccessPolicy = new Azure.Iot.DpsSharedAccessPolicy("example", new()
{
Name = "example",
ResourceGroupName = example.Name,
IothubDpsName = exampleIotHubDps.Name,
EnrollmentWrite = true,
EnrollmentRead = true,
});
});
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
}
exampleIotHubDps, err := iot.NewIotHubDps(ctx, "example", &iot.IotHubDpsArgs{
Name: pulumi.String("example"),
ResourceGroupName: example.Name,
Location: example.Location,
Sku: &iot.IotHubDpsSkuArgs{
Name: pulumi.String("S1"),
Capacity: pulumi.Int(1),
},
})
if err != nil {
return err
}
_, err = iot.NewDpsSharedAccessPolicy(ctx, "example", &iot.DpsSharedAccessPolicyArgs{
Name: pulumi.String("example"),
ResourceGroupName: example.Name,
IothubDpsName: exampleIotHubDps.Name,
EnrollmentWrite: pulumi.Bool(true),
EnrollmentRead: pulumi.Bool(true),
})
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.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 com.pulumi.azure.iot.DpsSharedAccessPolicy;
import com.pulumi.azure.iot.DpsSharedAccessPolicyArgs;
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())
.sku(IotHubDpsSkuArgs.builder()
.name("S1")
.capacity(1)
.build())
.build());
var exampleDpsSharedAccessPolicy = new DpsSharedAccessPolicy("exampleDpsSharedAccessPolicy", DpsSharedAccessPolicyArgs.builder()
.name("example")
.resourceGroupName(example.name())
.iothubDpsName(exampleIotHubDps.name())
.enrollmentWrite(true)
.enrollmentRead(true)
.build());
}
}
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}
sku:
name: S1
capacity: '1'
exampleDpsSharedAccessPolicy:
type: azure:iot:DpsSharedAccessPolicy
name: example
properties:
name: example
resourceGroupName: ${example.name}
iothubDpsName: ${exampleIotHubDps.name}
enrollmentWrite: true
enrollmentRead: true

API Providers

This resource uses the following Azure API Providers:

  • Microsoft.Devices: 2022-02-05

Import

IoTHub Device Provisioning Service Shared Access Policies can be imported using the resource id, e.g.

$ pulumi import azure:iot/dpsSharedAccessPolicy:DpsSharedAccessPolicy shared_access_policy1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Devices/provisioningServices/dps1/keys/shared_access_policy1

Properties

Link copied to clipboard
val enrollmentRead: Output<Boolean>?

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

Link copied to clipboard
val enrollmentWrite: Output<Boolean>?

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

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val iothubDpsName: 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.

Link copied to clipboard
val name: Output<String>

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

Link copied to clipboard

The primary connection string of the Shared Access Policy.

Link copied to clipboard
val primaryKey: Output<String>

The primary key used to create the authentication token.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The secondary connection string of the Shared Access Policy.

Link copied to clipboard
val secondaryKey: Output<String>

The secondary key used to create the authentication token.

Link copied to clipboard
val serviceConfig: Output<Boolean>?

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

Link copied to clipboard
val urn: Output<String>