Add-​Azure​Rm​Iot​Hub​Key

Creates an IotHub Key.

Syntax

Add-AzureRmIotHubKey
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-KeyName] <String>
   [[-PrimaryKey] <String>]
   [[-SecondaryKey] <String>]
   [-Rights] <PSAccessRights>
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

Creates a Key for the provided IotHub. KeyNames are not unique and need to be managed carefully.

Examples

Example 1 Add a Key to an IotHub

PS C:\> Add-AzureRmIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "newkey" -PrimaryKey "primarykey" -SecondaryKey "secondarykey" -Rights RegistryRead

Creates a key named "mykey" for the iothub "myiothub" with RegistryRead permissions.

Required Parameters

-KeyName

Name of the Key

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Name of the IotHub

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Resource Group Name

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Rights

The permissions for this IOTHub

Type:PSAccessRights
Parameter Sets:RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect
Position:5
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-PrimaryKey

The primary key

Type:String
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SecondaryKey

The Secondary Key

Type:String
Position:4
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.String

Microsoft.Azure.Commands.Management.IotHub.Models.PSAccessRights

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]]