New-AzIotHubKey

Reference

Module:: Az.IotHub

Generate an Azure IoT Hub key.

Syntax

New-AzIotHubKey
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-KeyName] <String>
   [-RenewKey] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzIotHubKey
   [-HubId] <String>
   [-KeyName] <String>
   [-RenewKey] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Generate an Azure IoT Hub key.

Examples

Example 1 Regenerate primary key

New-AzIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "testKey" -RenewKey "primary"

KeyName		PrimaryKey										SecondaryKey										Rights
-------		----------										------------										------
test		********************************            	********************************            		ServiceConnect

Regenerated primary key for the authorization policy "testKey" of an azure iot hub.

Example 2 Swapping keys

New-AzIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "testKey" -RenewKey "swap"

KeyName		PrimaryKey										SecondaryKey										Rights
-------		----------										------------										------
test		********************************            	********************************            		ServiceConnect

Swapping keys for the authorization policy "testKey" of an azure iot hub.

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

-RenewKey

Regenerate Key.

Type:	String
Position:	2
Default value:	None
Required:	True
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

-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

Share via