Edit

Share via

Set-AzureBatchPool

  • Reference
Module:
AzureRM.Batch

Updates the properties of a pool.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Set-AzureBatchPool
   [-Pool] <PSCloudPool>
   -BatchContext <BatchAccountContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<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.

Parameters

-BatchContext

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

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

Inputs

PSCloudPool

Parameters: Pool (ByValue)

BatchAccountContext

Parameters: BatchContext (ByValue)

Outputs

Void