< Back
Set-AzureBatchPoolOSVersion
Post
NAME Set-AzureBatchPoolOSVersion
SYNOPSIS
Changes the operating system version of the specified pool.
SYNTAX
Set-AzureBatchPoolOSVersion [-Id] <String> [-TargetOSVersion] <String> -BatchContext <BatchAccountContext> [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Set-AzureBatchPoolOSVersion cmdlet changes the operating system version of the specified pool.
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
-Id <String>
Specifies the ID of the pool.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-TargetOSVersion <String>
Specifies the Azure Guest operating system version to install on the virtual machines in the pool. For more information on Azure Guest
operating system versions, see Azure Guest OS Releases and SDK Compatibility
Matrixhttp://azure.microsoft.com/en-us/documentation/articles/cloud-services-guestos-update-matrix/
(http://azure.microsoft.com/en-us/docume ... te-matrix/).
Required? true
Position? 1
Default value None
Accept pipeline input? False
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
String
Parameter 'Id' accepts value of type 'String' from the pipeline
OUTPUTS
NOTES
Example 1: Set the target operating system version of a pool
PS C:\\>Set-AzureBatchPoolOSVersion -Id "MyPool" -TargetOSVersion "WA-GUEST-OS-4.20_201505-01" -BatchContext $Context
This command sets the target operating system version of pool MyPool to WA-GUEST-OS-4.20_201505-01.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... losversion
Get-AzureRmBatchAccountKeys
SYNOPSIS
Changes the operating system version of the specified pool.
SYNTAX
Set-AzureBatchPoolOSVersion [-Id] <String> [-TargetOSVersion] <String> -BatchContext <BatchAccountContext> [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Set-AzureBatchPoolOSVersion cmdlet changes the operating system version of the specified pool.
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
-Id <String>
Specifies the ID of the pool.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-TargetOSVersion <String>
Specifies the Azure Guest operating system version to install on the virtual machines in the pool. For more information on Azure Guest
operating system versions, see Azure Guest OS Releases and SDK Compatibility
Matrixhttp://azure.microsoft.com/en-us/documentation/articles/cloud-services-guestos-update-matrix/
(http://azure.microsoft.com/en-us/docume ... te-matrix/).
Required? true
Position? 1
Default value None
Accept pipeline input? False
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
String
Parameter 'Id' accepts value of type 'String' from the pipeline
OUTPUTS
NOTES
Example 1: Set the target operating system version of a pool
PS C:\\>Set-AzureBatchPoolOSVersion -Id "MyPool" -TargetOSVersion "WA-GUEST-OS-4.20_201505-01" -BatchContext $Context
This command sets the target operating system version of pool MyPool to WA-GUEST-OS-4.20_201505-01.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... losversion
Get-AzureRmBatchAccountKeys