< Back
Set-AzureBatchPool
Post
NAME Set-AzureBatchPool
SYNOPSIS
Updates the properties of a pool.
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.
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
-Pool <PSCloudPool>
Specifies the PSCloudPool to which this cmdlet updates the Batch service.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
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
PSCloudPool
Parameter 'Pool' accepts value of type 'PSCloudPool' from the pipeline
OUTPUTS
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ebatchpool
Get-AzureBatchPool
Get-AzureRmBatchAccountKeys
New-AzureBatchPool
Remove-AzureBatchPool
Azure Batch Cmdlets
SYNOPSIS
Updates the properties of a pool.
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.
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
-Pool <PSCloudPool>
Specifies the PSCloudPool to which this cmdlet updates the Batch service.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
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
PSCloudPool
Parameter 'Pool' accepts value of type 'PSCloudPool' from the pipeline
OUTPUTS
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ebatchpool
Get-AzureBatchPool
Get-AzureRmBatchAccountKeys
New-AzureBatchPool
Remove-AzureBatchPool
Azure Batch Cmdlets