Get-AzureRmIotHubConnectionString

NAME Get-AzureRmIotHubConnectionString



SYNOPSIS

Gets the IotHub connectionstrings.





SYNTAX

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

[<CommonParameters>]





DESCRIPTION

Gets the IotHub connectionstrings. You can either get connectionstrings for all the keys or filter them by a specific key 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



-KeyName <String>

Name of the Key



Required? false

Position? 2

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>

Resource Group Name



Required? true

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.PSSharedAccessSignatureAuthorizationRule

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

Microsoft.Azure.Commands.IotHub, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]





NOTES









Example 1 Get All IotHub connectionstrings



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



Gets the connectionstrings for all keys for the iothub named "myiothub"





Example 2 Get the IotHub connectionstrings for a specific key



PS C:\\> Get-AzureRmIotHubConnectionString -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "mykey"



Gets the connectionstrings for the key named "mykey" for the iothub named "myiothub"







RELATED LINKS

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