Get-AzIotHubKey

Reference

Module:: Az.IotHub

Gets an IotHub Key.

Syntax

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

Get-AzIotHubKey
   [-HubId] <String>
   [[-KeyName] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Gets an IotHub Key. You can either list all Keys or filter the list by a specific Key Name.

Examples

Example 1 Get all Keys

Get-AzIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub"

Gets all the Keys for the IotHub named "myiothub"

Example 2 Get information for a specific Key

Get-AzIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "iothubowner"

Gets the information for a key named "iothubowner" 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

-HubId

IotHub Resource Id

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

-KeyName

Name of the Key

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

-Name

Name of the IoT hub.

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

Share via