Get-AzIoTDeviceProvisioningServiceRegistration

Reference

Module:: Az.DeviceProvisioningServices

Gets the device registration state.

Syntax

Get-AzIoTDeviceProvisioningServiceRegistration
   [-ResourceGroupName] <String>
   [-DpsName] <String>
   [-RegistrationId <String>]
   [-EnrollmentId <String>]
   [-Query <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzIoTDeviceProvisioningServiceRegistration
   [-DpsObject] <PSProvisioningServiceDescription>
   [-RegistrationId <String>]
   [-EnrollmentId <String>]
   [-Query <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzIoTDeviceProvisioningServiceRegistration
   [-ResourceId] <String>
   [-RegistrationId <String>]
   [-EnrollmentId <String>]
   [-Query <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Get the device registration state or the registration state of devices under the enrollmentGroup in an Azure IoT Hub Device Provisioning Service.

Examples

Example 1

Get-AzIoTDeviceProvisioningServiceRegistration -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1"

Get the device registration state details in an Azure IoT Hub Device Provisioning Service.

Example 2

Get-AzIoTDeviceProvisioningServiceRegistration -ResourceGroupName "myresourcegroup" -DpsName "mydps" -EnrollmentId "grp-enroll1"

List all the registration state of devices in this enrollmentGroup.

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

-DpsName

Name of the IoT Device Provisioning Service

Type:	String
Position:	1
Default value:	None
Required:	True
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

-EnrollmentId

ID of enrollment group.

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

-Query

Sql query.

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

-RegistrationId

ID of device registration.

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

PSDeviceRegistrationState

PSDeviceRegistrationStates[]

Share via