Get-AzIoTDeviceProvisioningServiceAccessPolicy

Module:

Az.DeviceProvisioningServices Module

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

Syntax

ResourceSet (Default)

Get-AzIoTDeviceProvisioningServiceAccessPolicy
    [-ResourceGroupName] <String>
    [-Name] <String>
    [-KeyName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

InputObjectSet

Get-AzIoTDeviceProvisioningServiceAccessPolicy
    [-DpsObject] <PSProvisioningServiceDescription>
    [-KeyName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ResourceIdSet

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			: hy******vg=
SecondaryKey		: vb******pY=
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.

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DpsObject

IoT Device Provisioning Service Object

Parameter properties

Type:	PSProvisioningServiceDescription
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

InputObjectSet

Position:	0
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-KeyName

IoT Device Provisioning Service access policy key name

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

Name of the IoT Device Provisioning Service

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ResourceSet

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

Name of the Resource Group

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ResourceSet

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceId

IoT Device Provisioning Service Resource Id

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ResourceIdSet

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSProvisioningServiceDescription

String

Outputs

PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription