Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. iot
  5. SharedAccessPolicy

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.iot.SharedAccessPolicy

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an IotHub 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 exampleIoTHub = new azure.iot.IoTHub("example", {
    name: "example",
    resourceGroupName: example.name,
    location: example.location,
    sku: {
        name: "S1",
        capacity: 1,
    },
});
const exampleSharedAccessPolicy = new azure.iot.SharedAccessPolicy("example", {
    name: "example",
    resourceGroupName: example.name,
    iothubName: exampleIoTHub.name,
    registryRead: true,
    registryWrite: true,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_io_t_hub = azure.iot.IoTHub("example",
    name="example",
    resource_group_name=example.name,
    location=example.location,
    sku={
        "name": "S1",
        "capacity": 1,
    })
example_shared_access_policy = azure.iot.SharedAccessPolicy("example",
    name="example",
    resource_group_name=example.name,
    iothub_name=example_io_t_hub.name,
    registry_read=True,
    registry_write=True)
Copy
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
		}
		exampleIoTHub, err := iot.NewIoTHub(ctx, "example", &iot.IoTHubArgs{
			Name:              pulumi.String("example"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			Sku: &iot.IoTHubSkuArgs{
				Name:     pulumi.String("S1"),
				Capacity: pulumi.Int(1),
			},
		})
		if err != nil {
			return err
		}
		_, err = iot.NewSharedAccessPolicy(ctx, "example", &iot.SharedAccessPolicyArgs{
			Name:              pulumi.String("example"),
			ResourceGroupName: example.Name,
			IothubName:        exampleIoTHub.Name,
			RegistryRead:      pulumi.Bool(true),
			RegistryWrite:     pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 exampleIoTHub = new Azure.Iot.IoTHub("example", new()
    {
        Name = "example",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
        {
            Name = "S1",
            Capacity = 1,
        },
    });

    var exampleSharedAccessPolicy = new Azure.Iot.SharedAccessPolicy("example", new()
    {
        Name = "example",
        ResourceGroupName = example.Name,
        IothubName = exampleIoTHub.Name,
        RegistryRead = true,
        RegistryWrite = true,
    });

});
Copy
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.IoTHub;
import com.pulumi.azure.iot.IoTHubArgs;
import com.pulumi.azure.iot.inputs.IoTHubSkuArgs;
import com.pulumi.azure.iot.SharedAccessPolicy;
import com.pulumi.azure.iot.SharedAccessPolicyArgs;
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 exampleIoTHub = new IoTHub("exampleIoTHub", IoTHubArgs.builder()
            .name("example")
            .resourceGroupName(example.name())
            .location(example.location())
            .sku(IoTHubSkuArgs.builder()
                .name("S1")
                .capacity("1")
                .build())
            .build());

        var exampleSharedAccessPolicy = new SharedAccessPolicy("exampleSharedAccessPolicy", SharedAccessPolicyArgs.builder()
            .name("example")
            .resourceGroupName(example.name())
            .iothubName(exampleIoTHub.name())
            .registryRead(true)
            .registryWrite(true)
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleIoTHub:
    type: azure:iot:IoTHub
    name: example
    properties:
      name: example
      resourceGroupName: ${example.name}
      location: ${example.location}
      sku:
        name: S1
        capacity: '1'
  exampleSharedAccessPolicy:
    type: azure:iot:SharedAccessPolicy
    name: example
    properties:
      name: example
      resourceGroupName: ${example.name}
      iothubName: ${exampleIoTHub.name}
      registryRead: true
      registryWrite: true
Copy

Create SharedAccessPolicy Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SharedAccessPolicy(name: string, args: SharedAccessPolicyArgs, opts?: CustomResourceOptions);
@overload
def SharedAccessPolicy(resource_name: str,
                       args: SharedAccessPolicyArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def SharedAccessPolicy(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       iothub_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       device_connect: Optional[bool] = None,
                       name: Optional[str] = None,
                       registry_read: Optional[bool] = None,
                       registry_write: Optional[bool] = None,
                       service_connect: Optional[bool] = None)
func NewSharedAccessPolicy(ctx *Context, name string, args SharedAccessPolicyArgs, opts ...ResourceOption) (*SharedAccessPolicy, error)
public SharedAccessPolicy(string name, SharedAccessPolicyArgs args, CustomResourceOptions? opts = null)
public SharedAccessPolicy(String name, SharedAccessPolicyArgs args)
public SharedAccessPolicy(String name, SharedAccessPolicyArgs args, CustomResourceOptions options)

type: azure:iot:SharedAccessPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SharedAccessPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SharedAccessPolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SharedAccessPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SharedAccessPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SharedAccessPolicyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sharedAccessPolicyResource = new Azure.Iot.SharedAccessPolicy("sharedAccessPolicyResource", new()
{
    IothubName = "string",
    ResourceGroupName = "string",
    DeviceConnect = false,
    Name = "string",
    RegistryRead = false,
    RegistryWrite = false,
    ServiceConnect = false,
});
Copy
example, err := iot.NewSharedAccessPolicy(ctx, "sharedAccessPolicyResource", &iot.SharedAccessPolicyArgs{
	IothubName:        pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	DeviceConnect:     pulumi.Bool(false),
	Name:              pulumi.String("string"),
	RegistryRead:      pulumi.Bool(false),
	RegistryWrite:     pulumi.Bool(false),
	ServiceConnect:    pulumi.Bool(false),
})
Copy
var sharedAccessPolicyResource = new SharedAccessPolicy("sharedAccessPolicyResource", SharedAccessPolicyArgs.builder()
    .iothubName("string")
    .resourceGroupName("string")
    .deviceConnect(false)
    .name("string")
    .registryRead(false)
    .registryWrite(false)
    .serviceConnect(false)
    .build());
Copy
shared_access_policy_resource = azure.iot.SharedAccessPolicy("sharedAccessPolicyResource",
    iothub_name="string",
    resource_group_name="string",
    device_connect=False,
    name="string",
    registry_read=False,
    registry_write=False,
    service_connect=False)
Copy
const sharedAccessPolicyResource = new azure.iot.SharedAccessPolicy("sharedAccessPolicyResource", {
    iothubName: "string",
    resourceGroupName: "string",
    deviceConnect: false,
    name: "string",
    registryRead: false,
    registryWrite: false,
    serviceConnect: false,
});
Copy
type: azure:iot:SharedAccessPolicy
properties:
    deviceConnect: false
    iothubName: string
    name: string
    registryRead: false
    registryWrite: false
    resourceGroupName: string
    serviceConnect: false
Copy

SharedAccessPolicy Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SharedAccessPolicy resource accepts the following input properties:

IothubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
DeviceConnect bool

Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

NOTE At least one of registry_read, registry_write, service_connect, device_connect permissions must be set to true.

Name Changes to this property will trigger replacement. string
Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
RegistryRead bool
Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.
RegistryWrite bool

Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.

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

ServiceConnect bool
Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.
IothubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
DeviceConnect bool

Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

NOTE At least one of registry_read, registry_write, service_connect, device_connect permissions must be set to true.

Name Changes to this property will trigger replacement. string
Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
RegistryRead bool
Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.
RegistryWrite bool

Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.

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

ServiceConnect bool
Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.
iothubName
This property is required.
Changes to this property will trigger replacement.
String
The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
deviceConnect Boolean

Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

NOTE At least one of registry_read, registry_write, service_connect, device_connect permissions must be set to true.

name Changes to this property will trigger replacement. String
Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
registryRead Boolean
Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.
registryWrite Boolean

Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.

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

serviceConnect Boolean
Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.
iothubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
deviceConnect boolean

Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

NOTE At least one of registry_read, registry_write, service_connect, device_connect permissions must be set to true.

name Changes to this property will trigger replacement. string
Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
registryRead boolean
Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.
registryWrite boolean

Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.

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

serviceConnect boolean
Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.
iothub_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
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.
device_connect bool

Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

NOTE At least one of registry_read, registry_write, service_connect, device_connect permissions must be set to true.

name Changes to this property will trigger replacement. str
Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
registry_read bool
Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.
registry_write bool

Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.

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

service_connect bool
Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.
iothubName
This property is required.
Changes to this property will trigger replacement.
String
The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
deviceConnect Boolean

Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

NOTE At least one of registry_read, registry_write, service_connect, device_connect permissions must be set to true.

name Changes to this property will trigger replacement. String
Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
registryRead Boolean
Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.
registryWrite Boolean

Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.

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

serviceConnect Boolean
Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.

Outputs

All input properties are implicitly available as output properties. Additionally, the SharedAccessPolicy 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 SharedAccessPolicy Resource

Get an existing SharedAccessPolicy 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?: SharedAccessPolicyState, opts?: CustomResourceOptions): SharedAccessPolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device_connect: Optional[bool] = None,
        iothub_name: Optional[str] = None,
        name: Optional[str] = None,
        primary_connection_string: Optional[str] = None,
        primary_key: Optional[str] = None,
        registry_read: Optional[bool] = None,
        registry_write: Optional[bool] = None,
        resource_group_name: Optional[str] = None,
        secondary_connection_string: Optional[str] = None,
        secondary_key: Optional[str] = None,
        service_connect: Optional[bool] = None) -> SharedAccessPolicy
func GetSharedAccessPolicy(ctx *Context, name string, id IDInput, state *SharedAccessPolicyState, opts ...ResourceOption) (*SharedAccessPolicy, error)
public static SharedAccessPolicy Get(string name, Input<string> id, SharedAccessPolicyState? state, CustomResourceOptions? opts = null)
public static SharedAccessPolicy get(String name, Output<String> id, SharedAccessPolicyState state, CustomResourceOptions options)
resources:  _:    type: azure:iot:SharedAccessPolicy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
DeviceConnect bool

Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

NOTE At least one of registry_read, registry_write, service_connect, device_connect permissions must be set to true.

IothubName Changes to this property will trigger replacement. string
The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. 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.
RegistryRead bool
Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.
RegistryWrite bool

Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.

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

ResourceGroupName Changes to this property will trigger replacement. 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.
ServiceConnect bool
Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.
DeviceConnect bool

Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

NOTE At least one of registry_read, registry_write, service_connect, device_connect permissions must be set to true.

IothubName Changes to this property will trigger replacement. string
The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. 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.
RegistryRead bool
Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.
RegistryWrite bool

Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.

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

ResourceGroupName Changes to this property will trigger replacement. 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.
ServiceConnect bool
Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.
deviceConnect Boolean

Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

NOTE At least one of registry_read, registry_write, service_connect, device_connect permissions must be set to true.

iothubName Changes to this property will trigger replacement. String
The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. 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.
registryRead Boolean
Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.
registryWrite Boolean

Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.

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

resourceGroupName Changes to this property will trigger replacement. 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.
serviceConnect Boolean
Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.
deviceConnect boolean

Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

NOTE At least one of registry_read, registry_write, service_connect, device_connect permissions must be set to true.

iothubName Changes to this property will trigger replacement. string
The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. 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.
registryRead boolean
Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.
registryWrite boolean

Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.

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

resourceGroupName Changes to this property will trigger replacement. 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.
serviceConnect boolean
Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.
device_connect bool

Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

NOTE At least one of registry_read, registry_write, service_connect, device_connect permissions must be set to true.

iothub_name Changes to this property will trigger replacement. str
The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. 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.
registry_read bool
Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.
registry_write bool

Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.

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

resource_group_name Changes to this property will trigger replacement. 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_connect bool
Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.
deviceConnect Boolean

Adds DeviceConnect permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

NOTE At least one of registry_read, registry_write, service_connect, device_connect permissions must be set to true.

iothubName Changes to this property will trigger replacement. String
The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. 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.
registryRead Boolean
Adds RegistryRead permission to this Shared Access Account. It allows read access to the identity registry.
registryWrite Boolean

Adds RegistryWrite permission to this Shared Access Account. It allows write access to the identity registry.

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

resourceGroupName Changes to this property will trigger replacement. 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.
serviceConnect Boolean
Adds ServiceConnect permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.

Import

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

$ pulumi import azure:iot/sharedAccessPolicy:SharedAccessPolicy shared_access_policy1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Devices/iotHubs/hub1/iotHubKeys/shared_access_policy1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure