< Back
Get-AzureRmIotHubJob
Post
NAME Get-AzureRmIotHubJob
SYNOPSIS
Gets the information about an IotHub job.
SYNTAX
Get-AzureRmIotHubJob [-ResourceGroupName] <String> [-Name] <String> [[-JobId] <String>] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
DESCRIPTION
Gets the information about an IotHub Job. An IotHub Job gets created when an import or export operation is initialted using the
New-AzureRmIotHubExportDevices or New-AzureRmIotHubImportDevices commands. You can either list all the jobs or filter the jobs by the Job
Identifier.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-JobId <String>
The Job Identifier.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Name of the IoT hub.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Resource Group Name
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubJobResponse
System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubJobResponse, Microsoft.Azure.Commands.IotHub,
Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
NOTES
Example 1 List all Jobs
PS C:\\> Get-AzureRmIotHubJob -ResourceGroupName "myresourcegroup" -Name "myiothub"
Gets all the jobs for the IotHub named "myiothub"
Example 2 Get a specific Job
PS C:\\> Get-AzureRmIotHubJob -ResourceGroupName "myresourcegroup" -Name "myiothub" -JobId 3630fc31-4caa-43e8-a232-ea0577221cb2
Gets information about the job with the identifier "3630fc31-4caa-43e8-a232-ea0577221cb2" for the IotHub named "myiothub"
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... miothubjob
SYNOPSIS
Gets the information about an IotHub job.
SYNTAX
Get-AzureRmIotHubJob [-ResourceGroupName] <String> [-Name] <String> [[-JobId] <String>] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
DESCRIPTION
Gets the information about an IotHub Job. An IotHub Job gets created when an import or export operation is initialted using the
New-AzureRmIotHubExportDevices or New-AzureRmIotHubImportDevices commands. You can either list all the jobs or filter the jobs by the Job
Identifier.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-JobId <String>
The Job Identifier.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Name of the IoT hub.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Resource Group Name
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubJobResponse
System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubJobResponse, Microsoft.Azure.Commands.IotHub,
Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
NOTES
Example 1 List all Jobs
PS C:\\> Get-AzureRmIotHubJob -ResourceGroupName "myresourcegroup" -Name "myiothub"
Gets all the jobs for the IotHub named "myiothub"
Example 2 Get a specific Job
PS C:\\> Get-AzureRmIotHubJob -ResourceGroupName "myresourcegroup" -Name "myiothub" -JobId 3630fc31-4caa-43e8-a232-ea0577221cb2
Gets information about the job with the identifier "3630fc31-4caa-43e8-a232-ea0577221cb2" for the IotHub named "myiothub"
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... miothubjob