Get-AzIotHub

Reference

Module:: Az.IotHub

Gets information about the IotHubs in a subscription.

Syntax

Get-AzIotHub
   [[-ResourceGroupName] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

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

Description

Gets information about the IotHubs in a subscription. You can view all IotHub instances in a subscription, or filter your results by a resource group or a particular IotHub Name.

Examples

Example 1

Get-AzIotHub

Gets all the IotHubs in the subscription.

Example 2

Get-AzIotHub -ResourceGroupName "myresourcegroup"

Gets all the IotHubs in the subscription belonging to the resourcegroup named "myresourcegroup".

Example 3

Get-AzIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub"

Gets information about the IotHub named "myiothub".

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

-Name

Name of the IotHub

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

-ResourceGroupName

Name of the ResourceGroup

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

Inputs

String

Outputs

PSIotHub

Share via