Edit

Share via

Add-AzIoTDeviceProvisioningServiceLinkedHub

  • Reference
Module:
Az.DeviceProvisioningServices

Linked IoT hub to an Azure IoT Hub device provisioning service.

Syntax

Add-AzIoTDeviceProvisioningServiceLinkedHub
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-IotHubConnectionString] <String>
   [-IotHubLocation] <String>
   [-AllocationWeight <Int32>]
   [-ApplyAllocationPolicy]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AzIoTDeviceProvisioningServiceLinkedHub
   [-DpsObject] <PSProvisioningServiceDescription>
   [-IotHubConnectionString] <String>
   [-IotHubLocation] <String>
   [-AllocationWeight <Int32>]
   [-ApplyAllocationPolicy]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AzIoTDeviceProvisioningServiceLinkedHub
   [-ResourceId] <String>
   [-IotHubConnectionString] <String>
   [-IotHubLocation] <String>
   [-AllocationWeight <Int32>]
   [-ApplyAllocationPolicy]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps.

Examples

Example 1

Add-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -IotHubConnectionString $hubConnectionString -IotHubLocation "eastus"

ResourceGroupName     : myresourcegroup
Name                  : myiotdps
LinkedHubName         : myiothub.azure-devices.net
ConnectionString      : HostName=myiothub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=****
AllocationWeight      : 
ApplyAllocationPolicy : 
Location              : eastus

Linked IoT hub to an Azure IoT Hub device provisioning service.

Example 2

Add-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -IotHubConnectionString $hubConnectionString -IotHubLocation "eastus" -AllocationWeight 10 -ApplyAllocationPolicy

LinkedHubName					Location	AllocationWeight	ApplyAllocationPolicy
-------------					--------	----------------	---------------------
myiothub1.azure-devices.net		eastus		2					true
myiothub2.azure-devices.net		westus2		10					false

Linked IoT hub to an Azure IoT Hub device provisioning service with AllocationWeight and ApplyAllocationPolicy.

Parameters

-AllocationWeight

Allocation weight of the IoT Hub

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ApplyAllocationPolicy

A boolean indicating whether to apply allocation policy to the IoT Hub

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
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

-DpsObject

IoT Device Provisioning Service Object

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

-IotHubConnectionString

Connection String of the Iot Hub resource.

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

-IotHubLocation

Location of the Iot Hub

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

-Name

Name of the IoT Device Provisioning Service

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

-ResourceGroupName

Name of the Resource Group

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

-ResourceId

IoT Device Provisioning Service Resource Id

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:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSProvisioningServiceDescription

String

Outputs

PSIotHubDefinitionDescription

PSIotHubDefinitions