Edit

Share via

Get-AzIoTDeviceProvisioningServiceAccessPolicy

  • Reference
Module:
Az.DeviceProvisioningServices

List all or show details of shared access policies in an Azure IoT Hub device provisioning service.

Syntax

Get-AzIoTDeviceProvisioningServiceAccessPolicy
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-KeyName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzIoTDeviceProvisioningServiceAccessPolicy
   [-DpsObject] <PSProvisioningServiceDescription>
   [-KeyName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzIoTDeviceProvisioningServiceAccessPolicy
   [-ResourceId] <String>
   [-KeyName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<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

Get-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps"

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

List all shared access policies in "myiotdps".

Example 2

Get-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy"

ResourceGroupName	: myresourcegroup
Name				: myiotdps
KeyName				: mypolicy
PrimaryKey			: hyZJm8W7rra9O7eKhkLu9m/CIPPt9x1NXVMbMJa1rvg=
SecondaryKey		: vbIwGCBQCIbS5BKFKdddM6uZHLhNTuz9r8CZYgmTmpY=
Rights				: ServiceConfig, DeviceConnect, EnrollmentWrite

Show details of shared access policy "mypolicy" in an Azure IoT Hub device provisioning service.

Parameters

-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:Named
Default value:None
Required:False
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

-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

Inputs

PSProvisioningServiceDescription

String

Outputs

PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription