< Back
Get-AzureBatchSubtask
Post
NAME Get-AzureBatchSubtask
SYNOPSIS
Gets the subtask information of the specified task.
SYNTAX
Get-AzureBatchSubtask [-JobId] <String> [-TaskId] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>]
[-MaxCount <Int32>] [<CommonParameters>]
Get-AzureBatchSubtask [[-Task] <PSCloudTask>] -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-MaxCount <Int32>]
[<CommonParameters>]
DESCRIPTION
The Get-AzureBatchSubtask cmdlet retrieves the subtask information about the specified task. Subtasks provide parallel processing for individual
tasks, and enable precise monitoring of task execution and progress.
PARAMETERS
-BatchContext <BatchAccountContext>
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzureRmBatchAccount
cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To
use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys
populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the
BatchAccountContext.KeyInUse property.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-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>
Specifies the ID of the job that contains the task whose subtasks this cmdlet gets.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MaxCount <Int32>
Specifies the maximum number of subtasks to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The
default value is 1000.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Task <PSCloudTask>
Specifies an object reference to the task that contain the subtasks that this cmdlet returns. This object reference is created by using the
Get-AzureBatchTask cmdlet and storing the returned object in a variable.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-TaskId <String>
Specifies the ID of the task whose subtasks this cmdlet returns.
Required? true
Position? 1
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
BatchAccountContext
Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline
PSCloudTask
Parameter 'Task' accepts value of type 'PSCloudTask' from the pipeline
OUTPUTS
This cmdlet returns instances of the PSSubtaskInformation object.
NOTES
Example 1: Return all subtasks for a specified task
PS C:\\>$Context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount"
PS C:\\> Get-AzureBatchSubtask -JobId "Job-01" -TaskID "myTask" -BatchContext $Context
These commands return all the subtasks for the task with the ID myTask. To do this, the first command in the example creates an object reference
to the account keys for the batch account contosobatchaccount. This object reference is stored in a variable named $context.
The second command then uses that object reference and the Get-AzureBatchSubtask cmdlet to return all the subtasks for myTask, a task that runs as
part of job Job-01.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tchsubtask
Get-AzureBatchTask
SYNOPSIS
Gets the subtask information of the specified task.
SYNTAX
Get-AzureBatchSubtask [-JobId] <String> [-TaskId] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>]
[-MaxCount <Int32>] [<CommonParameters>]
Get-AzureBatchSubtask [[-Task] <PSCloudTask>] -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-MaxCount <Int32>]
[<CommonParameters>]
DESCRIPTION
The Get-AzureBatchSubtask cmdlet retrieves the subtask information about the specified task. Subtasks provide parallel processing for individual
tasks, and enable precise monitoring of task execution and progress.
PARAMETERS
-BatchContext <BatchAccountContext>
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzureRmBatchAccount
cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To
use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys
populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the
BatchAccountContext.KeyInUse property.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-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>
Specifies the ID of the job that contains the task whose subtasks this cmdlet gets.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MaxCount <Int32>
Specifies the maximum number of subtasks to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The
default value is 1000.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Task <PSCloudTask>
Specifies an object reference to the task that contain the subtasks that this cmdlet returns. This object reference is created by using the
Get-AzureBatchTask cmdlet and storing the returned object in a variable.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-TaskId <String>
Specifies the ID of the task whose subtasks this cmdlet returns.
Required? true
Position? 1
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
BatchAccountContext
Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline
PSCloudTask
Parameter 'Task' accepts value of type 'PSCloudTask' from the pipeline
OUTPUTS
This cmdlet returns instances of the PSSubtaskInformation object.
NOTES
Example 1: Return all subtasks for a specified task
PS C:\\>$Context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount"
PS C:\\> Get-AzureBatchSubtask -JobId "Job-01" -TaskID "myTask" -BatchContext $Context
These commands return all the subtasks for the task with the ID myTask. To do this, the first command in the example creates an object reference
to the account keys for the batch account contosobatchaccount. This object reference is stored in a variable named $context.
The second command then uses that object reference and the Get-AzureBatchSubtask cmdlet to return all the subtasks for myTask, a task that runs as
part of job Job-01.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tchsubtask
Get-AzureBatchTask