Add-AzIoTDeviceProvisioningServiceAccessPolicy

Reference

Module:: Az.DeviceProvisioningServices

Add a new shared access policy in an Azure IoT Hub device provisioning service.

Syntax

Add-AzIoTDeviceProvisioningServiceAccessPolicy
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-KeyName] <String>
   [-Permissions] <String[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-AzIoTDeviceProvisioningServiceAccessPolicy
   [-DpsObject] <PSProvisioningServiceDescription>
   [-KeyName] <String>
   [-Permissions] <String[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-AzIoTDeviceProvisioningServiceAccessPolicy
   [-ResourceId] <String>
   [-KeyName] <String>
   [-Permissions] <String[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps.

Examples

Example 1

Add-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" -Permissions "ServiceConfig", "EnrollmentWrite"

ResourceGroupName	: myresourcegroup
Name				: myiotdps
KeyName				: mypolicy
PrimaryKey			: hy******vg=
SecondaryKey		: vb******pY=
Rights				: ServiceConfig, EnrollmentWrite

Add a new shared access policy in an Azure IoT Hub device provisioning service with EnrollmentWrite and ServiceConfig rights.

Example 2

Add-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy2" -Permissions "EnrollmentRead"

KeyName		Rights
-------		------
mypolicy1	ServiceConfig, EnrollmentWrite
mypolicy2	EnrollmentRead

Add a new shared access policy in an Azure IoT Hub device provisioning service with EnrollmentRead right.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DpsObject

IoT Device Provisioning Service Object

Type:	PSProvisioningServiceDescription
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-KeyName

IoT Device Provisioning Service access policy key name

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Name of the IoT Device Provisioning Service

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Permissions

IoT Device Provisioning Service access policy permissions

Type:	String[]
Accepted values:	ServiceConfig, EnrollmentRead, EnrollmentWrite, DeviceConnect, RegistrationStatusRead, RegistrationStatusWrite
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Name of the Resource Group

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

IoT Device Provisioning Service Resource Id

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PSProvisioningServiceDescription

String

Outputs

PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription

Share via