Get-AzIotHubConnectionString

  • Reference
Module:
Az.IotHub

Gets the IotHub connectionstrings.

Syntax

Get-AzIotHubConnectionString
   [-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.

Examples

Example 1 Get All IotHub connectionstrings

Get-AzIotHubConnectionString -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

Get-AzIotHubConnectionString -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "mykey"

Gets the connectionstrings for the key named "mykey" for 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

-KeyName

Name of the Key

Type:String
Position:2
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

Resource Group Name

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

Inputs

String

Outputs

PSSharedAccessSignatureAuthorizationRule