Class DpsSharedAccessPolicy

Manages an IotHub Device Provisioning Service Shared Access Policy

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 Europe",
    });
    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",
        },
    });
    var exampleDpsSharedAccessPolicy = new Azure.Iot.DpsSharedAccessPolicy("exampleDpsSharedAccessPolicy", new Azure.Iot.DpsSharedAccessPolicyArgs
    {
        ResourceGroupName = exampleResourceGroup.Name,
        IothubDpsName = exampleIotHubDps.Name,
        EnrollmentWrite = true,
        EnrollmentRead = true,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

DpsSharedAccessPolicy

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Iot

Assembly: Pulumi.Azure.dll

Syntax

public class DpsSharedAccessPolicy : CustomResource

Constructors

DpsSharedAccessPolicy(String, DpsSharedAccessPolicyArgs, CustomResourceOptions)

Create a DpsSharedAccessPolicy resource with the given unique name, arguments, and options.

Declaration

public DpsSharedAccessPolicy(string name, DpsSharedAccessPolicyArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
DpsSharedAccessPolicyArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

EnrollmentRead

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

Declaration

public Output<bool?> EnrollmentRead { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

EnrollmentWrite

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

Declaration

public Output<bool?> EnrollmentWrite { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

IothubDpsName

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.

Declaration

public Output<string> IothubDpsName { get; }

Property Value

Type	Description
Output<System.String>

Name

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

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

PrimaryConnectionString

The primary connection string of the Shared Access Policy.

Declaration

public Output<string> PrimaryConnectionString { get; }

Property Value

Type	Description
Output<System.String>

PrimaryKey

The primary key used to create the authentication token.

Declaration

public Output<string> PrimaryKey { get; }

Property Value

Type	Description
Output<System.String>

RegistrationRead

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

Declaration

public Output<bool?> RegistrationRead { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

RegistrationWrite

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

Declaration

public Output<bool?> RegistrationWrite { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

ResourceGroupName

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.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

SecondaryConnectionString

The secondary connection string of the Shared Access Policy.

Declaration

public Output<string> SecondaryConnectionString { get; }

Property Value

Type	Description
Output<System.String>

SecondaryKey

The secondary key used to create the authentication token.

Declaration

public Output<string> SecondaryKey { get; }

Property Value

Type	Description
Output<System.String>

ServiceConfig

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

Declaration

public Output<bool?> ServiceConfig { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Methods

Get(String, Input<String>, DpsSharedAccessPolicyState, CustomResourceOptions)

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

Declaration

public static DpsSharedAccessPolicy Get(string name, Input<string> id, DpsSharedAccessPolicyState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
DpsSharedAccessPolicyState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
DpsSharedAccessPolicy