Set-​Azure​Batch​Pool

Updates the properties of a pool.

Syntax

Set-AzureBatchPool
   [-Pool] <PSCloudPool>
   -BatchContext <BatchAccountContext>
   [<CommonParameters>]

Description

The Set-AzureBatchPool cmdlet updates the properties of a pool in the Azure Batch service. Use the Get-AzureBatchPool cmdlet to get a PSCloudPool object. Modify the properties of that object, and then use the current cmdlet to commit your changes to the Batch service.

Examples

Example 1: Update a pool

PS C:\>$Pool = Get-AzureBatchPool "ContosoPool" -BatchContext $Context
PS C:\> $StartTask = New-Object Microsoft.Azure.Commands.Batch.Models.PSStartTask
PS C:\> $StartTask.CommandLine = "cmd /c echo example"
PS C:\> $Pool.StartTask = $StartTask
PS C:\> Set-AzureBatchPool -Pool $Pool -BatchContext $Context

The first command gets a pool by using Get-AzureBatchPool, and then stores it in the $Pool variable.

The next three commands modify the start task specification on the $Pool object.

The final command updates the Batch service to match the local object in $Pool.

Required Parameters

-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.

Type:BatchAccountContext
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Pool

Specifies the PSCloudPool to which this cmdlet updates the Batch service.

Type:PSCloudPool
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False