Get-AzureRmIotHubCertificateVerificationCode
Generates a verification code for an Azure IoT Hub certificate.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Get-AzureRmIotHubCertificateVerificationCode
[-ResourceGroupName] <String>
[-Name] <String>
[-CertificateName] <String>
[-Etag] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmIotHubCertificateVerificationCode
[-InputObject] <PSCertificateDescription>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmIotHubCertificateVerificationCode
[-ResourceId] <String>
[-Etag] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
This verification code is used to complete the proof of possession step for a certificate. Use this verification code as the CN of a new certificate signed with the root certificates private key. For a detailed explanation of CA certificates in Azure IoT Hub, see https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-x509ca-overview
Examples
Example 1
PS C:\> Get-AzureRmIotHubCertificateVerificationCode -ResourceGroupName "myresourcegroup" -Name "myiothub" -CertificateName "mycertificate" -Etag "AAAAAAFPazE="
Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/IotHubs/myiothub/certificates/mycertificate
ResourceGroupName : myresourcegroup
Name : myiothub
CertificateName : mycertificate
Subject : CN=mycertificate
Thumbprint : 38303FC7371EC13DDE3E18D712C8414EE50969C7
VerificationCode : 47292AB6260DB02CCD2D07C601B7303DD49858B6
Status : Unverified
Expiry : 1/01/2027 16:01
Created : 1/01/2017 16:01
Etag : AAAAAAFpObE=Generates a verification code for MyCertificate
Parameters
-CertificateName
Name of the Certificate
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Etag
Etag of the Certificate
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Certificate Object
| Type: | PSCertificateDescription |
| 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: | True |
| 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
Certificate Resource Id
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
Parameters: InputObject (ByValue)