Add-AzureRmIotHubKey

NAME Add-AzureRmIotHubKey



SYNOPSIS

Creates an IotHub Key.





SYNTAX

Add-AzureRmIotHubKey [-ResourceGroupName] <String> [-Name] <String> [-KeyName] <String> [-DefaultProfile <IAzureContextContainer>] [-PrimaryKey

<String>] -Rights {RegistryRead | RegistryWrite | ServiceConnect | DeviceConnect} [-SecondaryKey <String>] [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-KeyName <String>

Name of the Key



Required? true

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Name of the IotHub



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PrimaryKey <String>

The primary key



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

Resource Group Name



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Rights <PSAccessRights>

The permissions for this IOTHub



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-SecondaryKey <String>

The Secondary Key



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



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





NOTES









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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... miothubkey