Get-AzIotHubCertificate

Reference

Module:: Az.IotHub

Lists all certificates or a particular certificate contained within an Azure IoT Hub.

Syntax

Get-AzIotHubCertificate
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-CertificateName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzIotHubCertificate
   [-InputObject] <PSIotHub>
   [-CertificateName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzIotHubCertificate
   [-ResourceId] <String>
   [-CertificateName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

For a detailed explanation of CA certificates in Azure IoT Hub, see https://learn.microsoft.com/azure/iot-hub/iot-hub-x509ca-overview

Examples

Example 1

Get-AzIotHubCertificate -ResourceGroupName "myresourcegroup" -Name "myiothub"

ResourceGroupName	Name		CertificateName Status     Expiry
-----------------	----        ---------------	------     ------
myresourcegroup		myiothub3	mycert1         Unverified 12/04/2027 13:12
myresourcegroup     myiothub	mycert2         Unverified 12/04/2027 13:12

List all certificates in MyIotHub

Example 2

Get-AzIotHubCertificate -ResourceGroupName "myresourcegroup" -Name "myiothub" -CertificateName "mycertificate"

Id					: /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/IotHubs/myiothub/certificates/mycertificate
ResourceGroupName	: myresourcegroup
Name				: myiothub
CertificateName		: mycertificate
Subject				: CN=mycertificate
Thumbprint			: 38303FC7371EC13DDE3E18D712C8414EE50969C7
Status				: Unverified
Expiry				: 1/01/2027 16:01
Created				: 1/01/2017 16:01
Etag				: AAAAAAFpObE=

Show details about MyCertificate

Parameters

-CertificateName

Name of the Certificate

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

IotHub Object

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

-Name

Name of the Iot Hub

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:	True
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

PSCertificateDescription

Share via