1. Packages
  2. Azure Classic
  3. API Docs
  4. iot
  5. DpsSharedAccessPolicy

We recommend using Azure Native.

Azure Classic v5.67.0 published on Wednesday, Feb 21, 2024 by Pulumi

azure.iot.DpsSharedAccessPolicy

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.67.0 published on Wednesday, Feb 21, 2024 by Pulumi

    Manages an IotHub Device Provisioning Service Shared Access Policy

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
        {
            Location = "West Europe",
        });
    
        var exampleIotHubDps = new Azure.Iot.IotHubDps("exampleIotHubDps", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            Sku = new Azure.Iot.Inputs.IotHubDpsSkuArgs
            {
                Name = "S1",
                Capacity = 1,
            },
        });
    
        var exampleDpsSharedAccessPolicy = new Azure.Iot.DpsSharedAccessPolicy("exampleDpsSharedAccessPolicy", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            IothubDpsName = exampleIotHubDps.Name,
            EnrollmentWrite = true,
            EnrollmentRead = true,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"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 {
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleIotHubDps, 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
    		}
    		_, err = iot.NewDpsSharedAccessPolicy(ctx, "exampleDpsSharedAccessPolicy", &iot.DpsSharedAccessPolicyArgs{
    			ResourceGroupName: exampleResourceGroup.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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
                .location("West Europe")
                .build());
    
            var exampleIotHubDps = new IotHubDps("exampleIotHubDps", IotHubDpsArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .location(exampleResourceGroup.location())
                .sku(IotHubDpsSkuArgs.builder()
                    .name("S1")
                    .capacity("1")
                    .build())
                .build());
    
            var exampleDpsSharedAccessPolicy = new DpsSharedAccessPolicy("exampleDpsSharedAccessPolicy", DpsSharedAccessPolicyArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .iothubDpsName(exampleIotHubDps.name())
                .enrollmentWrite(true)
                .enrollmentRead(true)
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    example_iot_hub_dps = azure.iot.IotHubDps("exampleIotHubDps",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.location,
        sku=azure.iot.IotHubDpsSkuArgs(
            name="S1",
            capacity=1,
        ))
    example_dps_shared_access_policy = azure.iot.DpsSharedAccessPolicy("exampleDpsSharedAccessPolicy",
        resource_group_name=example_resource_group.name,
        iothub_dps_name=example_iot_hub_dps.name,
        enrollment_write=True,
        enrollment_read=True)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const exampleIotHubDps = new azure.iot.IotHubDps("exampleIotHubDps", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.location,
        sku: {
            name: "S1",
            capacity: 1,
        },
    });
    const exampleDpsSharedAccessPolicy = new azure.iot.DpsSharedAccessPolicy("exampleDpsSharedAccessPolicy", {
        resourceGroupName: exampleResourceGroup.name,
        iothubDpsName: exampleIotHubDps.name,
        enrollmentWrite: true,
        enrollmentRead: true,
    });
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        properties:
          location: West Europe
      exampleIotHubDps:
        type: azure:iot:IotHubDps
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          location: ${exampleResourceGroup.location}
          sku:
            name: S1
            capacity: '1'
      exampleDpsSharedAccessPolicy:
        type: azure:iot:DpsSharedAccessPolicy
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          iothubDpsName: ${exampleIotHubDps.name}
          enrollmentWrite: true
          enrollmentRead: true
    

    Create DpsSharedAccessPolicy Resource

    new DpsSharedAccessPolicy(name: string, args: DpsSharedAccessPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def DpsSharedAccessPolicy(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              enrollment_read: Optional[bool] = None,
                              enrollment_write: Optional[bool] = None,
                              iothub_dps_name: Optional[str] = None,
                              name: Optional[str] = None,
                              registration_read: Optional[bool] = None,
                              registration_write: Optional[bool] = None,
                              resource_group_name: Optional[str] = None,
                              service_config: Optional[bool] = None)
    @overload
    def DpsSharedAccessPolicy(resource_name: str,
                              args: DpsSharedAccessPolicyArgs,
                              opts: Optional[ResourceOptions] = None)
    func NewDpsSharedAccessPolicy(ctx *Context, name string, args DpsSharedAccessPolicyArgs, opts ...ResourceOption) (*DpsSharedAccessPolicy, error)
    public DpsSharedAccessPolicy(string name, DpsSharedAccessPolicyArgs args, CustomResourceOptions? opts = null)
    public DpsSharedAccessPolicy(String name, DpsSharedAccessPolicyArgs args)
    public DpsSharedAccessPolicy(String name, DpsSharedAccessPolicyArgs args, CustomResourceOptions options)
    
    type: azure:iot:DpsSharedAccessPolicy
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DpsSharedAccessPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DpsSharedAccessPolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DpsSharedAccessPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DpsSharedAccessPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DpsSharedAccessPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DpsSharedAccessPolicy Resource Properties

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

    Inputs

    The DpsSharedAccessPolicy resource accepts the following input properties:

    IothubDpsName 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.
    ResourceGroupName string
    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.
    EnrollmentRead bool

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

    NOTE When enrollment_read is set to true, registration_read must also be set to true. This is a limitation of the Azure REST API

    EnrollmentWrite bool

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

    NOTE When registration_write is set to true, enrollment_read, registration_read, and registration_write must also be set to true. This is a requirement of the Azure API.

    Name string
    Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
    RegistrationRead bool
    Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.
    RegistrationWrite bool

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

    NOTE When registration_write is set to true, registration_read must also be set to true. This is a requirement of the Azure API.

    ServiceConfig bool

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

    NOTE At least one of registration_read, registration_write, service_config, enrollment_read, enrollment_write permissions must be set to true.

    IothubDpsName 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.
    ResourceGroupName string
    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.
    EnrollmentRead bool

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

    NOTE When enrollment_read is set to true, registration_read must also be set to true. This is a limitation of the Azure REST API

    EnrollmentWrite bool

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

    NOTE When registration_write is set to true, enrollment_read, registration_read, and registration_write must also be set to true. This is a requirement of the Azure API.

    Name string
    Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
    RegistrationRead bool
    Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.
    RegistrationWrite bool

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

    NOTE When registration_write is set to true, registration_read must also be set to true. This is a requirement of the Azure API.

    ServiceConfig bool

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

    NOTE At least one of registration_read, registration_write, service_config, enrollment_read, enrollment_write permissions must be set to true.

    iothubDpsName 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.
    resourceGroupName String
    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.
    enrollmentRead Boolean

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

    NOTE When enrollment_read is set to true, registration_read must also be set to true. This is a limitation of the Azure REST API

    enrollmentWrite Boolean

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

    NOTE When registration_write is set to true, enrollment_read, registration_read, and registration_write must also be set to true. This is a requirement of the Azure API.

    name String
    Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
    registrationRead Boolean
    Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.
    registrationWrite Boolean

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

    NOTE When registration_write is set to true, registration_read must also be set to true. This is a requirement of the Azure API.

    serviceConfig Boolean

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

    NOTE At least one of registration_read, registration_write, service_config, enrollment_read, enrollment_write permissions must be set to true.

    iothubDpsName 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.
    resourceGroupName string
    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.
    enrollmentRead boolean

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

    NOTE When enrollment_read is set to true, registration_read must also be set to true. This is a limitation of the Azure REST API

    enrollmentWrite boolean

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

    NOTE When registration_write is set to true, enrollment_read, registration_read, and registration_write must also be set to true. This is a requirement of the Azure API.

    name string
    Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
    registrationRead boolean
    Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.
    registrationWrite boolean

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

    NOTE When registration_write is set to true, registration_read must also be set to true. This is a requirement of the Azure API.

    serviceConfig boolean

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

    NOTE At least one of registration_read, registration_write, service_config, enrollment_read, enrollment_write permissions must be set to true.

    iothub_dps_name str
    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.
    resource_group_name str
    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.
    enrollment_read bool

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

    NOTE When enrollment_read is set to true, registration_read must also be set to true. This is a limitation of the Azure REST API

    enrollment_write bool

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

    NOTE When registration_write is set to true, enrollment_read, registration_read, and registration_write must also be set to true. This is a requirement of the Azure API.

    name str
    Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
    registration_read bool
    Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.
    registration_write bool

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

    NOTE When registration_write is set to true, registration_read must also be set to true. This is a requirement of the Azure API.

    service_config bool

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

    NOTE At least one of registration_read, registration_write, service_config, enrollment_read, enrollment_write permissions must be set to true.

    iothubDpsName 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.
    resourceGroupName String
    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.
    enrollmentRead Boolean

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

    NOTE When enrollment_read is set to true, registration_read must also be set to true. This is a limitation of the Azure REST API

    enrollmentWrite Boolean

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

    NOTE When registration_write is set to true, enrollment_read, registration_read, and registration_write must also be set to true. This is a requirement of the Azure API.

    name String
    Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
    registrationRead Boolean
    Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.
    registrationWrite Boolean

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

    NOTE When registration_write is set to true, registration_read must also be set to true. This is a requirement of the Azure API.

    serviceConfig Boolean

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

    NOTE At least one of registration_read, registration_write, service_config, enrollment_read, enrollment_write permissions must be set to true.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DpsSharedAccessPolicy resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryConnectionString string
    The primary connection string of the Shared Access Policy.
    PrimaryKey string
    The primary key used to create the authentication token.
    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.
    PrimaryConnectionString string
    The primary connection string of the Shared Access Policy.
    PrimaryKey string
    The primary key used to create the authentication token.
    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.
    primaryConnectionString String
    The primary connection string of the Shared Access Policy.
    primaryKey String
    The primary key used to create the authentication token.
    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.
    primaryConnectionString string
    The primary connection string of the Shared Access Policy.
    primaryKey string
    The primary key used to create the authentication token.
    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.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryConnectionString String
    The primary connection string of the Shared Access Policy.
    primaryKey String
    The primary key used to create the authentication token.
    secondaryConnectionString String
    The secondary connection string of the Shared Access Policy.
    secondaryKey String
    The secondary key used to create the authentication token.

    Look up Existing DpsSharedAccessPolicy Resource

    Get an existing DpsSharedAccessPolicy 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?: DpsSharedAccessPolicyState, opts?: CustomResourceOptions): DpsSharedAccessPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enrollment_read: Optional[bool] = None,
            enrollment_write: Optional[bool] = None,
            iothub_dps_name: Optional[str] = None,
            name: Optional[str] = None,
            primary_connection_string: Optional[str] = None,
            primary_key: Optional[str] = None,
            registration_read: Optional[bool] = None,
            registration_write: Optional[bool] = None,
            resource_group_name: Optional[str] = None,
            secondary_connection_string: Optional[str] = None,
            secondary_key: Optional[str] = None,
            service_config: Optional[bool] = None) -> DpsSharedAccessPolicy
    func GetDpsSharedAccessPolicy(ctx *Context, name string, id IDInput, state *DpsSharedAccessPolicyState, opts ...ResourceOption) (*DpsSharedAccessPolicy, error)
    public static DpsSharedAccessPolicy Get(string name, Input<string> id, DpsSharedAccessPolicyState? state, CustomResourceOptions? opts = null)
    public static DpsSharedAccessPolicy get(String name, Output<String> id, DpsSharedAccessPolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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:
    EnrollmentRead bool

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

    NOTE When enrollment_read is set to true, registration_read must also be set to true. This is a limitation of the Azure REST API

    EnrollmentWrite bool

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

    NOTE When registration_write is set to true, enrollment_read, registration_read, and registration_write must also be set to true. This is a requirement of the Azure API.

    IothubDpsName 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.
    Name string
    Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
    PrimaryConnectionString string
    The primary connection string of the Shared Access Policy.
    PrimaryKey string
    The primary key used to create the authentication token.
    RegistrationRead bool
    Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.
    RegistrationWrite bool

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

    NOTE When registration_write is set to true, registration_read must also be set to true. This is a requirement of the Azure API.

    ResourceGroupName string
    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.
    SecondaryConnectionString string
    The secondary connection string of the Shared Access Policy.
    SecondaryKey string
    The secondary key used to create the authentication token.
    ServiceConfig bool

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

    NOTE At least one of registration_read, registration_write, service_config, enrollment_read, enrollment_write permissions must be set to true.

    EnrollmentRead bool

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

    NOTE When enrollment_read is set to true, registration_read must also be set to true. This is a limitation of the Azure REST API

    EnrollmentWrite bool

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

    NOTE When registration_write is set to true, enrollment_read, registration_read, and registration_write must also be set to true. This is a requirement of the Azure API.

    IothubDpsName 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.
    Name string
    Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
    PrimaryConnectionString string
    The primary connection string of the Shared Access Policy.
    PrimaryKey string
    The primary key used to create the authentication token.
    RegistrationRead bool
    Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.
    RegistrationWrite bool

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

    NOTE When registration_write is set to true, registration_read must also be set to true. This is a requirement of the Azure API.

    ResourceGroupName string
    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.
    SecondaryConnectionString string
    The secondary connection string of the Shared Access Policy.
    SecondaryKey string
    The secondary key used to create the authentication token.
    ServiceConfig bool

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

    NOTE At least one of registration_read, registration_write, service_config, enrollment_read, enrollment_write permissions must be set to true.

    enrollmentRead Boolean

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

    NOTE When enrollment_read is set to true, registration_read must also be set to true. This is a limitation of the Azure REST API

    enrollmentWrite Boolean

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

    NOTE When registration_write is set to true, enrollment_read, registration_read, and registration_write must also be set to true. This is a requirement of the Azure API.

    iothubDpsName 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.
    name String
    Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
    primaryConnectionString String
    The primary connection string of the Shared Access Policy.
    primaryKey String
    The primary key used to create the authentication token.
    registrationRead Boolean
    Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.
    registrationWrite Boolean

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

    NOTE When registration_write is set to true, registration_read must also be set to true. This is a requirement of the Azure API.

    resourceGroupName String
    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.
    secondaryConnectionString String
    The secondary connection string of the Shared Access Policy.
    secondaryKey String
    The secondary key used to create the authentication token.
    serviceConfig Boolean

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

    NOTE At least one of registration_read, registration_write, service_config, enrollment_read, enrollment_write permissions must be set to true.

    enrollmentRead boolean

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

    NOTE When enrollment_read is set to true, registration_read must also be set to true. This is a limitation of the Azure REST API

    enrollmentWrite boolean

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

    NOTE When registration_write is set to true, enrollment_read, registration_read, and registration_write must also be set to true. This is a requirement of the Azure API.

    iothubDpsName 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.
    name string
    Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
    primaryConnectionString string
    The primary connection string of the Shared Access Policy.
    primaryKey string
    The primary key used to create the authentication token.
    registrationRead boolean
    Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.
    registrationWrite boolean

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

    NOTE When registration_write is set to true, registration_read must also be set to true. This is a requirement of the Azure API.

    resourceGroupName string
    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.
    secondaryConnectionString string
    The secondary connection string of the Shared Access Policy.
    secondaryKey string
    The secondary key used to create the authentication token.
    serviceConfig boolean

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

    NOTE At least one of registration_read, registration_write, service_config, enrollment_read, enrollment_write permissions must be set to true.

    enrollment_read bool

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

    NOTE When enrollment_read is set to true, registration_read must also be set to true. This is a limitation of the Azure REST API

    enrollment_write bool

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

    NOTE When registration_write is set to true, enrollment_read, registration_read, and registration_write must also be set to true. This is a requirement of the Azure API.

    iothub_dps_name str
    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.
    name str
    Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
    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.
    registration_read bool
    Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.
    registration_write bool

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

    NOTE When registration_write is set to true, registration_read must also be set to true. This is a requirement of the Azure API.

    resource_group_name str
    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.
    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.
    service_config bool

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

    NOTE At least one of registration_read, registration_write, service_config, enrollment_read, enrollment_write permissions must be set to true.

    enrollmentRead Boolean

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

    NOTE When enrollment_read is set to true, registration_read must also be set to true. This is a limitation of the Azure REST API

    enrollmentWrite Boolean

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

    NOTE When registration_write is set to true, enrollment_read, registration_read, and registration_write must also be set to true. This is a requirement of the Azure API.

    iothubDpsName 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.
    name String
    Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
    primaryConnectionString String
    The primary connection string of the Shared Access Policy.
    primaryKey String
    The primary key used to create the authentication token.
    registrationRead Boolean
    Adds RegistrationStatusRead permission to this Shared Access Account. It allows read access to device registrations.
    registrationWrite Boolean

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

    NOTE When registration_write is set to true, registration_read must also be set to true. This is a requirement of the Azure API.

    resourceGroupName String
    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.
    secondaryConnectionString String
    The secondary connection string of the Shared Access Policy.
    secondaryKey String
    The secondary key used to create the authentication token.
    serviceConfig Boolean

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

    NOTE At least one of registration_read, registration_write, service_config, enrollment_read, enrollment_write permissions must be set to true.

    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
    

    Package Details

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

    We recommend using Azure Native.

    Azure Classic v5.67.0 published on Wednesday, Feb 21, 2024 by Pulumi