Get-AzIoTDeviceProvisioningServiceLinkedHub

Reference

Module:: Az.DeviceProvisioningServices

List all or show details of linked IoT hubs in an Azure IoT Hub device provisioning service.

Syntax

Get-AzIoTDeviceProvisioningServiceLinkedHub
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-LinkedHubName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzIoTDeviceProvisioningServiceLinkedHub
   [-DpsObject] <PSProvisioningServiceDescription>
   [-LinkedHubName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzIoTDeviceProvisioningServiceLinkedHub
   [-ResourceId] <String>
   [-LinkedHubName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<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

Get-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps"

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

List all linked IoT hubs in "myiotdps".

Example 2

Get-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub1"

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

Show details of linked IoT hub "myiothub1" in an Azure IoT Hub device provisioning service.

Parameters

-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

-LinkedHubName

Host name of linked IoT Hub

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

Inputs

PSProvisioningServiceDescription

String

Outputs

PSIotHubDefinitionDescription

PSIotHubDefinitions

Share via