Add-AzIotHubKey

Reference

Module:: Az.IotHub

Creates an IotHub Key.

Syntax

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

Add-AzIotHubKey
   [-HubId] <String>
   [-KeyName] <String>
   [-PrimaryKey <String>]
   [-SecondaryKey <String>]
   -Rights <PSAccessRights>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<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

Add-AzIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "newkey" -PrimaryKey "primarykey" -SecondaryKey "secondarykey" -Rights RegistryRead

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

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-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:	True
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

-PrimaryKey

The primary key

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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

-Rights

The permissions for this IOTHub

Type:	PSAccessRights
Accepted values:	RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SecondaryKey

The Secondary Key

Type:	String
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Outputs

PSSharedAccessSignatureAuthorizationRule

Dela via