Get-AzIotHubDevice
Lists all devices or a particular device contained within an Azure IoT Hub.
Syntax
Get-AzIotHubDevice
[-ResourceGroupName] <String>
[-IotHubName] <String>
[-DeviceId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzIotHubDevice
[-InputObject] <PSIotHub>
[-DeviceId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzIotHubDevice
[-ResourceId] <String>
[-DeviceId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Get the details of an Iot Hub device or list all devices in an Iot Hub.
Examples
Example 1
Get-AzIotHubDevice -ResourceGroupName "myresourcegroup" -IotHubName "myiothub"
Device Id Status Connection State Authentication Edge Enabled Last Activity Time
--------- ------ ---------------- -------------- ------------ ------------------
device1 Enabled Disconnected CertificateAuthority True 1/1/0001 12:00:00 AM
device2 Disabled Disconnected Sas False 1/1/0001 12:00:00 AM
device3 Enabled Disconnected SelfSigned False 1/1/0001 12:00:00 AM
Show all devices in an Iot Hub.
Example 2
Get-AzIotHubDevice -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1"
DeviceId : myDevice1
GenerationId : 637148941292917073
ETag : "NzIyMDI4MTk3"
LastActivityTime : 1/1/0001 12:00:00 AM
ConnectionState : Disconnected
ConnectionStateUpdatedTime : 1/1/0001 12:00:00 AM
Status : Disabled
StatusReason : Reason1
StatusUpdatedTime : 1/17/2020 10:15:04 PM
CloudToDeviceMessageCount : 0
Authentication : Sas
EdgeEnabled : False
DeviceScope :
Get the details of an IoT Hub device.
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 |
-DeviceId
Target Device Id.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
IotHub object
Type: | PSIotHub |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-IotHubName
Name of the Iot Hub
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
IotHub Resource Id
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Outputs
Samarbeta med oss på GitHub
Källan för det här innehållet finns på GitHub, där du även kan skapa och granska ärenden och pull-begäranden. Se vår deltagarguide för mer information.
Azure PowerShell