Get-AzIotHubDeployment

Reference

Module:: Az.IotHub

Lists all or a particular IoT Edge deployment.

Syntax

Get-AzIotHubDeployment
   [-ResourceGroupName] <String>
   [-IotHubName] <String>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzIotHubDeployment
   [-InputObject] <PSIotHub>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzIotHubDeployment
   [-ResourceId] <String>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Get the details of an IoT Edge deployment or List IoT Edge deployments in an IoT Hub. See https://learn.microsoft.com/azure/iot-edge/module-deployment-monitoring for more information.

Examples

Example 1

Get-AzIotHubDeployment -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "deploy1"

Get the details of an IoT Edge deployment.

Example 2

Get-AzIotHubDeployment -ResourceGroupName "myresourcegroup" -IotHubName "myiothub"

List all IoT Edge deployments in an IoT Hub.

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

-InputObject

IotHub object

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

-IotHubName

Name of the Iot Hub

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

-Name

Identifier for the deployment.

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

IotHub Resource Id

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

Inputs

PSIotHub

String

Outputs

PSDeployment

PSDeployments[]

Share via