Set-AzBatchPool
Updates the properties of a pool.
Syntax
Set-AzBatchPool
[-Pool] <PSCloudPool>
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Set-AzBatchPool cmdlet updates the properties of a pool in the Azure Batch service. Use the Get-AzBatchPool 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
$Pool = Get-AzBatchPool "ContosoPool" -BatchContext $Context
$StartTask = New-Object Microsoft.Azure.Commands.Batch.Models.PSStartTask
$StartTask.CommandLine = "cmd /c echo example"
$Pool.StartTask = $StartTask
Set-AzBatchPool -Pool $Pool -BatchContext $ContextThe first command gets a pool by using Get-AzBatchPool, 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.
Parameters
-BatchContext
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey 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.
| Type: | BatchAccountContext |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Pool
Specifies the PSCloudPool to which this cmdlet updates the Batch service.
| Type: | PSCloudPool |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
