diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Microsoft.Azure.Commands.Batch.dll-Help.xml b/src/ResourceManager/AzureBatch/Commands.Batch/Microsoft.Azure.Commands.Batch.dll-Help.xml index 6aff666f5694..4c6686d00a52 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/Microsoft.Azure.Commands.Batch.dll-Help.xml +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Microsoft.Azure.Commands.Batch.dll-Help.xml @@ -1,6 +1,6 @@  - + Disable-AzureBatchAutoScale @@ -135,6 +135,287 @@ + + + Disable-AzureBatchComputeNodeScheduling + + Disables task scheduling on the specified compute node. + + + + + Disable + AzureBatchComputeNodeScheduling + + + + The Disable-AzureBatchComputeNodeScheduling cmdlet disables task scheduling on the specified compute node. (A compute node is an Azure virtual machine dedicated to a specific application workload.) When you disable task scheduling on a compute node you will also have the option of determining what to do about jobs currently in the node's task queue. Disable-AzureBatchComputeNodeScheduling allows you to: + -- Terminate the tasks and put them back in the job queue. This enables those tasks to be rescheduled on another compute node. + -- Terminate the tasks and remove them from the job queue. Tasks terminated in this fashion will not be rescheduled. + -- Wait for all the tasks currently being executed to complete and then disable task scheduling on the compute node. + -- Wait for all the running tasks to complete and all the data retention periods to expire, then disable task scheduling on the compute node. + + + + Disable-AzureBatchComputeNodeScheduling + + PoolId + + Specifies the ID of the batch pool containing the compute node where task scheduling will be disabled. You can return the IDs for all your batch pools by using commands similar to the following: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + Get-AzureBatchPool -BatchContext $context | Select-Object Id + If you use the PoolId parameter then you cannot use the ComputeNode parameter in that same command. + + String + + + Id + + Specifies the ID of the compute node where task scheduling will be disabled. You can return the IDs for all the compute nodes in a pool by using commands similar to the following: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + Get-AzureBatchComputeNode -PoolId "Pool06" -BatchContext $context | Select-Object Id + If you use the Id parameter then you cannot use the ComputeNode parameter in that same command. + + String + + + DisableSchedulingOption + + Specifies how Disable-AzureBatchComputeNodeScheduling deals with any tasks currently running on the computer node where scheduling is being disabled. Allowed options are: + -- Requeue. Tasks are terminated immediately and returned to the job queue. This enables the tasks to be rescheduled on another compute node. This is the default value. + -- Terminate. Tasks are terminated immediately and removed from the job queue. These tasks will not be rescheduled. + -- TaskCompletion. Currently running tasks will be allowed to complete before task scheduling is disabled on the compute node. No new tasks will be scheduled on this node. + -- RetainedData. Currently running tasks will be allowed to complete and data retention periods will be allowed to expire before task scheduling is disabled on the compute node. No new tasks will be scheduled on this node. + For example: + -DisableSchedulingOption "TaskCompletion" + + DisableComputeNodeSchedulingOption] + + + BatchContext + + Specifies an object reference to the batch account context that will be used for disabling task scheduling. This object reference is created by using the Get-AzureRmBatchAccountKeys cmdlet and storing the returned batch account keys object in a variable. For example, this command creates an object reference ($context) to the batch account keys for the batch account named contosobatchaccount: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + The variable $context can then be used as the parameter value for the BatchContext parameter: + -BatchContext $context + + BatchAccountContext + + + + Disable-AzureBatchComputeNodeScheduling + + ComputeNode + + Specifies an object reference to the compute node where task scheduling will be disabled. This object reference is created by using the Get-AzureBatchComputeNode cmdlet and storing the returned compute node object in a variable. For example, these commands create an object reference ($node) to the computer node tvm-2316545714_1-20150725t213220z in pool Pool06: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + $node = Get-AzureBatchComputeNode -PoolId "Pool06" -Id "tvm-2316545714_1-20150725t213220z" -BatchContext $Context + The variable $node can then be used as the parameter value for the ComputeNode parameter: + -ComputeNode $node + If you use the ComputeNode parameter then you cannot use the Id or the PoolId parameters in that same command. + + PSComputeNode + + + DisableSchedulingOption + + Specifies how Disable-AzureBatchComputeNodeScheduling deals with any tasks currently running on the computer node where scheduling is being disabled. Allowed options are: + -- Requeue. Tasks are terminated immediately and returned to the job queue. This enables the tasks to be rescheduled on another compute node. This is the default value. + -- Terminate. Tasks are terminated immediately and removed from the job queue. These tasks will not be rescheduled. + -- TaskCompletion. Currently running tasks will be allowed to complete before task scheduling is disabled on the compute node. No new tasks will be scheduled on this node. + -- RetainedData. Currently running tasks will be allowed to complete and data retention periods will be allowed to expire before task scheduling is disabled on the compute node. No new tasks will be scheduled on this node. + For example: + -DisableSchedulingOption "TaskCompletion" + + DisableComputeNodeSchedulingOption] + + + BatchContext + + Specifies an object reference to the batch account context that will be used for disabling task scheduling. This object reference is created by using the Get-AzureRmBatchAccountKeys cmdlet and storing the returned batch account keys object in a variable. For example, this command creates an object reference ($context) to the batch account keys for the batch account named contosobatchaccount: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + The variable $context can then be used as the parameter value for the BatchContext parameter: + -BatchContext $context + + BatchAccountContext + + + + + + BatchContext + + Specifies an object reference to the batch account context that will be used for disabling task scheduling. This object reference is created by using the Get-AzureRmBatchAccountKeys cmdlet and storing the returned batch account keys object in a variable. For example, this command creates an object reference ($context) to the batch account keys for the batch account named contosobatchaccount: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + The variable $context can then be used as the parameter value for the BatchContext parameter: + -BatchContext $context + + BatchAccountContext + + BatchAccountContext + + + none + + + ComputeNode + + Specifies an object reference to the compute node where task scheduling will be disabled. This object reference is created by using the Get-AzureBatchComputeNode cmdlet and storing the returned compute node object in a variable. For example, these commands create an object reference ($node) to the computer node tvm-2316545714_1-20150725t213220z in pool Pool06: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + $node = Get-AzureBatchComputeNode -PoolId "Pool06" -Id "tvm-2316545714_1-20150725t213220z" -BatchContext $Context + The variable $node can then be used as the parameter value for the ComputeNode parameter: + -ComputeNode $node + If you use the ComputeNode parameter then you cannot use the Id or the PoolId parameters in that same command. + + PSComputeNode + + PSComputeNode + + + none + + + DisableSchedulingOption + + Specifies how Disable-AzureBatchComputeNodeScheduling deals with any tasks currently running on the computer node where scheduling is being disabled. Allowed options are: + -- Requeue. Tasks are terminated immediately and returned to the job queue. This enables the tasks to be rescheduled on another compute node. This is the default value. + -- Terminate. Tasks are terminated immediately and removed from the job queue. These tasks will not be rescheduled. + -- TaskCompletion. Currently running tasks will be allowed to complete before task scheduling is disabled on the compute node. No new tasks will be scheduled on this node. + -- RetainedData. Currently running tasks will be allowed to complete and data retention periods will be allowed to expire before task scheduling is disabled on the compute node. No new tasks will be scheduled on this node. + For example: + -DisableSchedulingOption "TaskCompletion" + + DisableComputeNodeSchedulingOption] + + DisableComputeNodeSchedulingOption] + + + none + + + Id + + Specifies the ID of the compute node where task scheduling will be disabled. You can return the IDs for all the compute nodes in a pool by using commands similar to the following: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + Get-AzureBatchComputeNode -PoolId "Pool06" -BatchContext $context | Select-Object Id + If you use the Id parameter then you cannot use the ComputeNode parameter in that same command. + + String + + String + + + none + + + PoolId + + Specifies the ID of the batch pool containing the compute node where task scheduling will be disabled. You can return the IDs for all your batch pools by using commands similar to the following: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + Get-AzureBatchPool -BatchContext $context | Select-Object Id + If you use the PoolId parameter then you cannot use the ComputeNode parameter in that same command. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Example 1: Disable task scheduling on a compute node + + + + + + PS C:\> $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + PS C:\> Disable-AzureBatchComputeNodeScheduling -PoolId "myPool" -Id "tvm-1783593343_34-20151117t222514z" -BatchContext $context + + + These commands disable task schedule on the compute node tvm-1783593343_34-20151117t222514z. 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 this object reference and the Disable-AzureBatchComputeNodeScheduling cmdlet to connect to the pool myPool and disable task scheduling on node tvm-1783593343_34-20151117t222514z. + Because the DisableComputeNodeSchedulingOptions parameter was not included any tasks currently running on the compute node will be requeued. + + + + + + + + + + + Example 2: Disable task scheduling on all compute nodes in a pool + + + + + + PS C:\> $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + PS C:\> Get-AzureBatchComputeNode -PoolId "Pool06" -BatchContext $Context | Disable-AzureBatchComputeNodeScheduling -BatchContext $context + + + + + These commands disable task scheduling on all the computer nodes in the batch pool Pool06. To carry out this task, 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 in the example then uses this object reference and Get-AzureBatchComputeNode to return a collection of all the compute nodes found in Pool06. That collection is then piped to then Disable-AzureBatchComputeNodeScheduling cmdlet to disable task scheduling on each compute node in the collection. + Because the DisableComputeNodeSchedulingOptions parameter was not included any tasks currently running on the compute nodes will be requeued. + + + + + + + + + + + + + Enable-AzureBatchComputeNodeScheduling + + + + Disable-AzureBatchJob @@ -496,19 +777,19 @@ String - - AutoScaleEvaluationInterval - - Specifies time interval at which to automatically adjust the pool size according to the AutoScale formula. The default value is 15 minutes. The minimum allowed value is 5 minutes. - - TimeSpan - AutoScaleFormula Specifies the formula for the desired number of compute nodes in the pool. - String + String + + + AutoScaleEvaluationInterval + + Specifies the amount of time (in minutes) that elapses before the pool size is automatically adjusted according to the AutoScale formula. The default value is 15 minutes, and the minimum value is 5 minutes. + + Nullable [System.TimeSpan] BatchContext @@ -523,11 +804,11 @@ AutoScaleEvaluationInterval - Specifies time interval at which to automatically adjust the pool size according to the AutoScale formula. The default value is 15 minutes. The minimum allowed value is 5 minutes. + Specifies the amount of time (in minutes) that elapses before the pool size is automatically adjusted according to the AutoScale formula. The default value is 15 minutes, and the minimum value is 5 minutes. - TimeSpan + Nullable [System.TimeSpan] - TimeSpan + Nullable [System.TimeSpan] none @@ -537,7 +818,7 @@ Specifies the formula for the desired number of compute nodes in the pool. - String + String String @@ -646,34 +927,74 @@ - Enable-AzureBatchJob + Enable-AzureBatchComputeNodeScheduling - Enables a Batch job. + Enables task scheduling on the specified compute node. Enable - AzureBatchJob + AzureBatchComputeNodeScheduling - The Enable-AzureBatchJob cmdlet enables an Azure Batch job. After you enable a job, new tasks can run. + The Enable-AzureBatchComputeNodeScheduling cmdlet enables task scheduling on the specified compute node. A compute node is an Azure virtual machine dedicated to a specific application workload. - Enable-AzureBatchJob - + Enable-AzureBatchComputeNodeScheduling + + PoolId + + Specifies the ID of the batch pool containing the compute node where task scheduling will be enabled. You can return the IDs for all your batch pools by using commands similar to the following: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + Get-AzureBatchPool -BatchContext $context | Select-Object Id + If you use the PoolId parameter then you cannot use the ComputeNode parameter in that same command. + + String + + Id - Specifies the ID of the job that this cmdlet enables. + Specifies the ID of the compute node where task scheduling will be enabled. You can return the IDs for all the compute nodes in a pool by using commands similar to the following: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + Get-AzureBatchComputeNode -PoolId "Pool06" -BatchContext $context | Select-Object Id + If you use the Id parameter then you cannot use the ComputeNode parameter in that same command. String BatchContext - Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. + Specifies an object reference to the batch account context that will be used to enable task scheduling. This object reference is created by using the Get-AzureRmBatchAccountKeys cmdlet and storing the returned batched account keys object in a variable. For example, this command creates an object reference ($context) to the batch account keys for the batch account named contosobatchaccount: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + The variable $context can then be used as the parameter value for the BatchContext parameter: + -BatchContext $context + + BatchAccountContext + + + + Enable-AzureBatchComputeNodeScheduling + + ComputeNode + + Specifies an object reference to the compute node where task scheduling will be disabled. This object reference is created by using the Get-AzureBatchComputeNode cmdlet and storing the returned compute node object in a variable. For example, this command creates an object reference ($node) to the computer node tvm-2316545714_1-20150725t213220z in pool Pool06: + $node = Get-AzureBatchComputeNode -PoolId "Pool06" -Id "tvm-2316545714_1-20150725t213220z" -BatchContext $Context + The variable $node can then be used as the parameter value for the ComputeNode parameter: + -ComputeNode $node + If you use the ComputeNode parameter then you cannot use the Id or the PoolId parameters in that same command. + + PSComputeNode + + + BatchContext + + Specifies an object reference to the batch account context that will be used to enable task scheduling. This object reference is created by using the Get-AzureRmBatchAccountKeys cmdlet and storing the returned batched account keys object in a variable. For example, this command creates an object reference ($context) to the batch account keys for the batch account named contosobatchaccount: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + The variable $context can then be used as the parameter value for the BatchContext parameter: + -BatchContext $context BatchAccountContext @@ -683,7 +1004,10 @@ BatchContext - Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. + Specifies an object reference to the batch account context that will be used to enable task scheduling. This object reference is created by using the Get-AzureRmBatchAccountKeys cmdlet and storing the returned batched account keys object in a variable. For example, this command creates an object reference ($context) to the batch account keys for the batch account named contosobatchaccount: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + The variable $context can then be used as the parameter value for the BatchContext parameter: + -BatchContext $context BatchAccountContext @@ -692,20 +1016,204 @@ none - - Id + + ComputeNode - Specifies the ID of the job that this cmdlet enables. + Specifies an object reference to the compute node where task scheduling will be disabled. This object reference is created by using the Get-AzureBatchComputeNode cmdlet and storing the returned compute node object in a variable. For example, this command creates an object reference ($node) to the computer node tvm-2316545714_1-20150725t213220z in pool Pool06: + $node = Get-AzureBatchComputeNode -PoolId "Pool06" -Id "tvm-2316545714_1-20150725t213220z" -BatchContext $Context + The variable $node can then be used as the parameter value for the ComputeNode parameter: + -ComputeNode $node + If you use the ComputeNode parameter then you cannot use the Id or the PoolId parameters in that same command. - String + PSComputeNode - String + PSComputeNode none - - + + Id + + Specifies the ID of the compute node where task scheduling will be enabled. You can return the IDs for all the compute nodes in a pool by using commands similar to the following: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + Get-AzureBatchComputeNode -PoolId "Pool06" -BatchContext $context | Select-Object Id + If you use the Id parameter then you cannot use the ComputeNode parameter in that same command. + + String + + String + + + none + + + PoolId + + Specifies the ID of the batch pool containing the compute node where task scheduling will be enabled. You can return the IDs for all your batch pools by using commands similar to the following: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + Get-AzureBatchPool -BatchContext $context | Select-Object Id + If you use the PoolId parameter then you cannot use the ComputeNode parameter in that same command. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Example 1: Enable task scheduling on a compute node + + + + + + PS C:\> $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + PS C:\> Enable-AzureBatchComputeNodeScheduling -PoolId "myPool" -Id "tvm-1783593343_34-20151117t222514z" -BatchContext $context + + + These commands enable task scheduling on the compute node tvm-1783593343_34-20151117t222514z. To do this, the first command in the example creates an object reference containing the account keys for the batch account contosobatchaccount. This object reference is stored in a variable named $context. + The second command then uses this object reference and the Enable-AzureBatchComputeNodeScheduling cmdlet to connect to the pool myPool and enable task scheduling on tvm-1783593343_34-20151117t222514z. + + + + + + + + + + + Example 2: Enable task scheduling on acompute nodes in a pool + + + + + + PS C:\> $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + PS C:\> Get-AzureBatchComputeNode -PoolId "Pool06" -BatchContext $Context | Enable-AzureBatchComputeNodeScheduling -BatchContext $context + + + These commands enable task scheduling on all the compute nodes found in the pool Pool06. To carry out this task, the first command in the example creates an object reference containing the account keys for the batch account contosobatchaccount. This object reference is stored in a variable named $context. + The second command in the example then uses this object reference and Get-AzureBatchComputeNode to return a collection of all the compute nodes found in Pool06. That collection is then piped to the Enable-AzureBatchComputeNodeScheduling cmdlet, which enables task scheduling on each compute node in the collection. + + + + + + + + + + + + + Disable-AzureBatchComputeNodeScheduling + + + + + + + Enable-AzureBatchJob + + Enables a Batch job. + + + + + Enable + AzureBatchJob + + + + The Enable-AzureBatchJob cmdlet enables an Azure Batch job. After you enable a job, new tasks can run. + + + + Enable-AzureBatchJob + + Id + + Specifies the ID of the job that this cmdlet enables. + + String + + + BatchContext + + Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. + + BatchAccountContext + + + + + + BatchContext + + Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. + + BatchAccountContext + + BatchAccountContext + + + none + + + Id + + Specifies the ID of the job that this cmdlet enables. + + String + + String + + + none + + + @@ -4139,126 +4647,370 @@ - Get-AzureBatchTask + Get-AzureBatchSubtask - Gets the Batch tasks for a job. + Gets the subtask information of the specified task. Get - AzureBatchTask + AzureBatchSubtask - The Get-AzureBatchTask cmdlet gets Azure Batch tasks for a Batch job. Specify a job by either the JobId parameter or the Job parameter. To get a single task, specify the Id parameter. You can specify the Filter parameter to get the tasks that match an Open Data Protocol (OData) filter. + The Get-AzureBatchSubtask cmdlet retrieves the subtask information of the specified task. Subtasks provide parallel processing for individual tasks, and enable more-granular monitoring of task execution and progress. - Get-AzureBatchTask - + Get-AzureBatchSubtask + JobId - Specifies the ID of the job that contains the tasks that this cmdlet gets. + + + Specifies the ID of the job containing the task whose subtasks will be returned. You can return the IDs of all your batch jobs by using commands similar to these: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + Get-AzureBatchJob -BatchContext $context | Select-Object ID String - - Expand - - Specifies an OData expand clause. Specify a value for this parameter to get associated entities of the main entity to get. - - String - - - Filter + + TaskId - Specifies an OData filter clause for tasks. If you do not specify a filter, this cmdlet returns all tasks for the Batch account or job. + + + Specifies the ID of the task whose subtasks will be returned. You can retrieve the IDs of all the tasks associated with a job by using commands similar to these: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + Get-AzureBatchTask -JobId "Job01" -BatchContext $context | Select-Object ID - String + String MaxCount - Specifies the maximum number of tasks 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. + Specifies the maximum number of subtasks to return. For example: + -MaxCount 100 + If MaxCount is set to 0 then no limit will be placed on the number of subtasks returned by the cmdlet. If this parameter is not included then the command will return a maximum of 1000 tasks, the default value. Int32 - - Select - - Specifies an OData select clause. Specify a value for this parameter to get specific properties rather than all object properties. - - String - - + BatchContext - Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. + Specifies an object reference to the batch account context that will be used for retrieving task information. This object reference is created by using the Get-AzureRmBatchAccountKeys cmdlet and storing the returned batch account keys object in a variable. For example, this command creates an object reference ($context) to the batch account keys for the batch account named contosobatchaccount: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + The variable $context can then be used as the parameter value for the BatchContext parameter: + -BatchContext $context BatchAccountContext - Get-AzureBatchTask - - JobId - - Specifies the ID of the job that contains the tasks that this cmdlet gets. - - String - - - Id - - Specifies the ID of the task that this cmdlet gets. You cannot specify wildcard characters. - - String - - - Expand + Get-AzureBatchSubtask + + Task - Specifies an OData expand clause. Specify a value for this parameter to get associated entities of the main entity to get. + Specifies an object reference to the task containing the subtasks to be returned. This object reference is created by using the Get-AzureBatchTask cmdlet and storing the returned object in a variable. For example, these commands create an object reference ($task) to the task Task03 running in conjunction with job Job01: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + $task = Get-AzureBatchTask -JobId "Job01" -Id "Task03" -BatchContext $context + The variable $task can then be used as the parameter value for the Task parameter: + -Task $task + If you use the Task parameter then you cannot use the JobId and TaskId parameters in that same command. - String + PSCloudTask - Select + MaxCount - Specifies an OData select clause. Specify a value for this parameter to get specific properties rather than all object properties. + Specifies the maximum number of subtasks to return. For example: + -MaxCount 100 + If MaxCount is set to 0 then no limit will be placed on the number of subtasks returned by the cmdlet. If this parameter is not included then the command will return a maximum of 1000 tasks, the default value. - String + Int32 - + BatchContext - Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. + Specifies an object reference to the batch account context that will be used for retrieving task information. This object reference is created by using the Get-AzureRmBatchAccountKeys cmdlet and storing the returned batch account keys object in a variable. For example, this command creates an object reference ($context) to the batch account keys for the batch account named contosobatchaccount: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + The variable $context can then be used as the parameter value for the BatchContext parameter: + -BatchContext $context BatchAccountContext - - Get-AzureBatchTask - - Job - - Specifies the job that contains tasks that this cmdlet gets. To obtain a PSCloudJob object, use the Get-AzureBatchJob cmdlet. - - PSCloudJob - - - Expand - - Specifies an OData expand clause. Specify a value for this parameter to get associated entities of the main entity to get. - - String - - - Filter - - Specifies an OData filter clause for tasks. If you do not specify a filter, this cmdlet returns all tasks for the Batch account or job. - - String + + + + BatchContext + + Specifies an object reference to the batch account context that will be used for retrieving task information. This object reference is created by using the Get-AzureRmBatchAccountKeys cmdlet and storing the returned batch account keys object in a variable. For example, this command creates an object reference ($context) to the batch account keys for the batch account named contosobatchaccount: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + The variable $context can then be used as the parameter value for the BatchContext parameter: + -BatchContext $context + + BatchAccountContext + + BatchAccountContext + + + none + + + JobId + + + + Specifies the ID of the job containing the task whose subtasks will be returned. You can return the IDs of all your batch jobs by using commands similar to these: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + Get-AzureBatchJob -BatchContext $context | Select-Object ID + + String + + String + + + none + + + MaxCount + + Specifies the maximum number of subtasks to return. For example: + -MaxCount 100 + If MaxCount is set to 0 then no limit will be placed on the number of subtasks returned by the cmdlet. If this parameter is not included then the command will return a maximum of 1000 tasks, the default value. + + Int32 + + Int32 + + + none + + + Task + + Specifies an object reference to the task containing the subtasks to be returned. This object reference is created by using the Get-AzureBatchTask cmdlet and storing the returned object in a variable. For example, these commands create an object reference ($task) to the task Task03 running in conjunction with job Job01: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + $task = Get-AzureBatchTask -JobId "Job01" -Id "Task03" -BatchContext $context + The variable $task can then be used as the parameter value for the Task parameter: + -Task $task + If you use the Task parameter then you cannot use the JobId and TaskId parameters in that same command. + + PSCloudTask + + PSCloudTask + + + none + + + TaskId + + + + Specifies the ID of the task whose subtasks will be returned. You can retrieve the IDs of all the tasks associated with a job by using commands similar to these: + $context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" + Get-AzureBatchTask -JobId "Job01" -BatchContext $context | Select-Object ID + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get-AzureBatchSubtask returns instances of the PSSubtaskInformation object. + + + + + + + + + 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. + + + + + + + + + + + + + Get-AzureBatchTask + + + + + + + Get-AzureBatchTask + + Gets the Batch tasks for a job. + + + + + Get + AzureBatchTask + + + + The Get-AzureBatchTask cmdlet gets Azure Batch tasks for a Batch job. Specify a job by either the JobId parameter or the Job parameter. To get a single task, specify the Id parameter. You can specify the Filter parameter to get the tasks that match an Open Data Protocol (OData) filter. + + + + Get-AzureBatchTask + + JobId + + Specifies the ID of the job that contains the tasks that this cmdlet gets. + + String + + + Expand + + Specifies an OData expand clause. Specify a value for this parameter to get associated entities of the main entity to get. + + String + + + Filter + + Specifies an OData filter clause for tasks. If you do not specify a filter, this cmdlet returns all tasks for the Batch account or job. + + String + + + MaxCount + + Specifies the maximum number of tasks 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. + + Int32 + + + Select + + Specifies an OData select clause. Specify a value for this parameter to get specific properties rather than all object properties. + + String + + + BatchContext + + Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. + + BatchAccountContext + + + + Get-AzureBatchTask + + JobId + + Specifies the ID of the job that contains the tasks that this cmdlet gets. + + String + + + Id + + Specifies the ID of the task that this cmdlet gets. You cannot specify wildcard characters. + + String + + + Expand + + Specifies an OData expand clause. Specify a value for this parameter to get associated entities of the main entity to get. + + String + + + Select + + Specifies an OData select clause. Specify a value for this parameter to get specific properties rather than all object properties. + + String + + + BatchContext + + Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. + + BatchAccountContext + + + + Get-AzureBatchTask + + Job + + Specifies the job that contains tasks that this cmdlet gets. To obtain a PSCloudJob object, use the Get-AzureBatchJob cmdlet. + + PSCloudJob + + + Expand + + Specifies an OData expand clause. Specify a value for this parameter to get associated entities of the main entity to get. + + String + + + Filter + + Specifies an OData filter clause for tasks. If you do not specify a filter, this cmdlet returns all tasks for the Batch account or job. + + String MaxCount @@ -6122,9 +6874,9 @@ AutoScaleEvaluationInterval - Specifies time interval at which to automatically adjust the pool size according to the AutoScale formula. The default value is 15 minutes. The minimum allowed value is 5 minutes. + Specifies the amount of time (in minutes) that elapses before the pool size is automatically adjusted according to the AutoScale formula. The default value is 15 minutes, and the minimum value is 5 minutes. - TimeSpan + Nullable [System.TimeSpan] AutoScaleFormula @@ -6345,11 +7097,11 @@ AutoScaleEvaluationInterval - Specifies time interval at which to automatically adjust the pool size according to the AutoScale formula. The default value is 15 minutes. The minimum allowed value is 5 minutes. + Specifies the amount of time (in minutes) that elapses before the pool size is automatically adjusted according to the AutoScale formula. The default value is 15 minutes, and the minimum value is 5 minutes. - TimeSpan + Nullable [System.TimeSpan] - TimeSpan + Nullable [System.TimeSpan] none @@ -6697,9 +7449,9 @@ MultiInstanceSettings - Specifies information about how to run the multi-instance task. + Specifies information about how to run a multi-instance task. - PSMultiInstanceSettings + Microsoft.Azure.Commands.Batch.Models.PSMultiInstanceSettings ResourceFiles @@ -6783,9 +7535,9 @@ MultiInstanceSettings - Specifies information about how to run the multi-instance task. + Specifies information about how to run a multi-instance task. - PSMultiInstanceSettings + Microsoft.Azure.Commands.Batch.Models.PSMultiInstanceSettings ResourceFiles @@ -6935,11 +7687,11 @@ MultiInstanceSettings - Specifies information about how to run the multi-instance task. + Specifies information about how to run a multi-instance task. - PSMultiInstanceSettings + Microsoft.Azure.Commands.Batch.Models.PSMultiInstanceSettings - PSTaskConstraints + Microsoft.Azure.Commands.Batch.Models.PSMultiInstanceSettings none @@ -7690,7 +8442,7 @@ Specifies a deallocation option for the removal operation that this cmdlet starts. The default value is Requeue. - ComputeNodeDeallocationOption + ComputeNodeDeallocationOption] Force @@ -7703,7 +8455,7 @@ Specifies the time-out interval for removal of the compute nodes from the pool. The default value is 10 minutes. The minimum value is 5 minutes. - TimeSpan + TimeSpan] BatchContext @@ -7727,7 +8479,7 @@ Specifies a deallocation option for the removal operation that this cmdlet starts. The default value is Requeue. - ComputeNodeDeallocationOption + ComputeNodeDeallocationOption] Force @@ -7740,7 +8492,7 @@ Specifies the time-out interval for removal of the compute nodes from the pool. The default value is 10 minutes. The minimum value is 5 minutes. - TimeSpan + TimeSpan] BatchContext @@ -7781,9 +8533,9 @@ Specifies a deallocation option for the removal operation that this cmdlet starts. The default value is Requeue. - ComputeNodeDeallocationOption + ComputeNodeDeallocationOption] - ComputeNodeDeallocationOption + ComputeNodeDeallocationOption] none @@ -7829,9 +8581,9 @@ Specifies the time-out interval for removal of the compute nodes from the pool. The default value is 10 minutes. The minimum value is 5 minutes. - TimeSpan + TimeSpan] - TimeSpan + TimeSpan] none @@ -12174,781 +12926,4 @@ - - - - - Disable-AzureBatchComputeNodeScheduling - - - Disables task scheduling on the specified compute node. - - - - - Disable - AzureBatchComputeNodeScheduling - - - - Disables task scheduling on the specified compute node. - - - - - Disable-AzureBatchComputeNodeScheduling - - PoolId - - The id of the pool. - - string - - - Id - - The id of the compute node. - - string - - - BatchContext - - The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. - - BatchAccountContext - - - DisableSchedulingOption - - Specifies what to do with currently running tasks. The default is Requeue. - - DisableComputeNodeSchedulingOption - - - - Disable-AzureBatchComputeNodeScheduling - - ComputeNode - - The PSComputeNode object representing the compute node to disable task scheduling on. Use the Get-AzureBatchComputeNode cmdlet to get a PSComputeNode instance. - - PSComputeNode - - - BatchContext - - The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. - - BatchAccountContext - - - DisableSchedulingOption - - Specifies what to do with currently running tasks. The default is Requeue. - - DisableComputeNodeSchedulingOption - - - - - - - BatchContext - - The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. - - - BatchAccountContext - - BatchAccountContext - - - - - - ComputeNode - - The PSComputeNode object representing the compute node to disable task scheduling on. Use the Get-AzureBatchComputeNode cmdlet to get a PSComputeNode instance. - - - PSComputeNode - - PSComputeNode - - - - - - DisableSchedulingOption - - Specifies what to do with currently running tasks. The default is Requeue. - - - DisableComputeNodeSchedulingOption - - DisableComputeNodeSchedulingOption - - - - - - Id - - The id of the compute node. - - - string - - string - - - - - - PoolId - - The id of the pool. - - - string - - string - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - - C:\PS> - - - Disable-AzureBatchComputeNodeScheduling "myPool" "tvm-1783593343_34-20151117t222514z" -BatchContext $context - - - Description - ----------- - Disables task scheduling on compute node "tvm-1783593343_34-20151117t222514z" in pool "myPool". - - - - - - - - - - - - - - - -------------------------- EXAMPLE 2 -------------------------- - - - C:\PS> - - - Get-AzureBatchComputeNode "myPool" "tvm-1783593343_34-20151117t222514z" -BatchContext $context | Disable-AzureBatchComputeNodeScheduling -BatchContext $context - - - Description - ----------- - Disables task scheduling on compute node "tvm-1783593343_34-20151117t222514z" in pool "myPool". - - - - - - - - - - - - - - - - - - - - - - - - Enable-AzureBatchComputeNodeScheduling - - - Enables task scheduling on the specified compute node. - - - - - Enable - AzureBatchComputeNodeScheduling - - - - Enables task scheduling on the specified compute node. - - - - - Enable-AzureBatchComputeNodeScheduling - - PoolId - - The id of the pool. - - string - - - Id - - The id of the compute node. - - string - - - BatchContext - - The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. - - BatchAccountContext - - - - Enable-AzureBatchComputeNodeScheduling - - ComputeNode - - The PSComputeNode object representing the compute node to enable task scheduling on. Use the Get-AzureBatchComputeNode cmdlet to get a PSComputeNode instance. - - PSComputeNode - - - BatchContext - - The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. - - BatchAccountContext - - - - - - - BatchContext - - The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. - - - BatchAccountContext - - BatchAccountContext - - - - - - ComputeNode - - The PSComputeNode object representing the compute node to enable task scheduling on. Use the Get-AzureBatchComputeNode cmdlet to get a PSComputeNode instance. - - - PSComputeNode - - PSComputeNode - - - - - - Id - - The id of the compute node. - - - string - - string - - - - - - PoolId - - The id of the pool. - - - string - - string - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - - C:\PS> - - - Enable-AzureBatchComputeNodeScheduling "myPool" "tvm-1783593343_34-20151117t222514z" -BatchContext $context - - - Description - ----------- - Enables task scheduling on compute node "tvm-1783593343_34-20151117t222514z" in pool "myPool". - - - - - - - - - - - - - - - -------------------------- EXAMPLE 2 -------------------------- - - - C:\PS> - - - Get-AzureBatchComputeNode "myPool" "tvm-1783593343_34-20151117t222514z" -BatchContext $context | Enable-AzureBatchComputeNodeScheduling -BatchContext $context - - - Description - ----------- - Enables task scheduling on compute node "tvm-1783593343_34-20151117t222514z" in pool "myPool". - - - - - - - - - - - - - - - - - - - - - - - - Get-AzureBatchSubtask - - - Gets the subtask information of the specified task. - - - - - Get - AzureBatchSubtask - - - - Gets the subtask information of the specified task. - - - - - Get-AzureBatchSubtask - - JobId - - The id of the job. - - string - - - TaskId - - The id of the task. - - string - - - BatchContext - - The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. - - BatchAccountContext - - - MaxCount - - The maximum number of subtasks to return. If a value of 0 or less is specified, then no upper limit will be used. If no value is specified, a default value of 1000 will be used. - - int - - - - Get-AzureBatchSubtask - - Task - - The PSCloudTask object representing the task. Use the Get-AzureBatchTask cmdlet to get a PSCloudTask instance. - - PSCloudTask - - - BatchContext - - The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. - - BatchAccountContext - - - MaxCount - - The maximum number of subtasks to return. If a value of 0 or less is specified, then no upper limit will be used. If no value is specified, a default value of 1000 will be used. - - int - - - - - - - BatchContext - - The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. - - - BatchAccountContext - - BatchAccountContext - - - - - - JobId - - The id of the job. - - - string - - string - - - - - - MaxCount - - The maximum number of subtasks to return. If a value of 0 or less is specified, then no upper limit will be used. If no value is specified, a default value of 1000 will be used. - - - int - - int - - - - - - Task - - The PSCloudTask object representing the task. Use the Get-AzureBatchTask cmdlet to get a PSCloudTask instance. - - - PSCloudTask - - PSCloudTask - - - - - - TaskId - - The id of the task. - - - string - - string - - - - - - - - - - - - - - - - - - - - - - - - - PSSubtaskInformation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - - C:\PS> - - - Get-AzureBatchSubtask "job-01" "myTask" -BatchContext $context - - ComputeNodeInformation : Microsoft.Azure.Commands.Batch.Models.PSComputeNodeInformation - EndTime : 1/1/1601 12:01:45 AM - ExitCode : 0 - Id : 1 - PreviousState : Running - PreviousStateTransitionTime : 1/1/1601 12:01:37 AM - SchedulingError : - StartTime : 1/1/1601 12:01:37 AM - State : Completed - StateTransitionTime : 1/1/1601 12:01:45 AM - - ComputeNodeInformation : Microsoft.Azure.Commands.Batch.Models.PSComputeNodeInformation - EndTime : 1/1/1601 12:01:45 AM - ExitCode : 0 - Id : 2 - PreviousState : Running - PreviousStateTransitionTime : 1/1/1601 12:01:37 AM - SchedulingError : - StartTime : 1/1/1601 12:01:37 AM - State : Completed - StateTransitionTime : 1/1/1601 12:01:45 AM - - - Description - ----------- - Gets the subtask information for task "myTask" under job "job-01". - - - - - - - - - - - - - - - -------------------------- EXAMPLE 2 -------------------------- - - - C:\PS> - - - Get-AzureBatchTask "job-01" "myTask" -BatchContext $context | Get-AzureBatchSubtask -BatchContext $context - - ComputeNodeInformation : Microsoft.Azure.Commands.Batch.Models.PSComputeNodeInformation - EndTime : 1/1/1601 12:01:45 AM - ExitCode : 0 - Id : 1 - PreviousState : Running - PreviousStateTransitionTime : 1/1/1601 12:01:37 AM - SchedulingError : - StartTime : 1/1/1601 12:01:37 AM - State : Completed - StateTransitionTime : 1/1/1601 12:01:45 AM - - ComputeNodeInformation : Microsoft.Azure.Commands.Batch.Models.PSComputeNodeInformation - EndTime : 1/1/1601 12:01:45 AM - ExitCode : 0 - Id : 2 - PreviousState : Running - PreviousStateTransitionTime : 1/1/1601 12:01:37 AM - SchedulingError : - StartTime : 1/1/1601 12:01:37 AM - State : Completed - StateTransitionTime : 1/1/1601 12:01:45 AM - - - Description - ----------- - Gets the subtask information for task "myTask" under job "job-01". - - - - - - - - - - - - - - - - - - - -