Update-AzIoTDeviceProvisioningServiceLinkedHub

Reference

Module:: Az.DeviceProvisioningServices

Update a linked IoT hub in an Azure IoT Hub device provisioning service.

Syntax

Update-AzIoTDeviceProvisioningServiceLinkedHub
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-LinkedHubName] <String>
      [-AllocationWeight <Int32>]
      [-ApplyAllocationPolicy]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzIoTDeviceProvisioningServiceLinkedHub
      [-InputObject] <PSIotHubDefinitionDescription>
      [-AllocationWeight <Int32>]
      [-ApplyAllocationPolicy]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzIoTDeviceProvisioningServiceLinkedHub
      [-ResourceId] <String>
      [-LinkedHubName] <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

Update-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub" -AllocationWeight 10 -ApplyAllocationPolicy

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

Update linked IoT hub "myiothub.azure-devices.net" in an Azure IoT Hub device provisioning service.

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

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

-InputObject

IoT Device Provisioning Service Object

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

-LinkedHubName

Host name of linked IoT Hub

Type:	String
Position:	1
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

PSIotHubDefinitionDescription

String

Outputs