< Back

Get-AzureRmIotHub

Tue Jan 29, 2019 9:49 pm

NAME Get-AzureRmIotHub



SYNOPSIS

Gets information about the IotHubs in a subscription.





SYNTAX

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



Get-AzureRmIotHub [[-ResourceGroupName] <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.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Name of the IotHub



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Name of the ResourceGroup



Required? false

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String







OUTPUTS

Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub

System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub, Microsoft.Azure.Commands.IotHub,

Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]





NOTES









Example 1



PS C:\\> Get-AzureRmIotHub



Gets all the IotHubs in the subscription.





Example 2



PS C:\\> Get-AzureRmIotHub -ResourceGroupName "myresourcegroup"



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





Example 3



PS C:\\> Get-AzureRmIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub"



Gets information about the IotHub named "myiothub".







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... rermiothub