Get-AzBatchSupportedImage
Gets Batch supported images for a Batch account.
Syntax
Default (Default)
Get-AzBatchSupportedImage
[-Filter <String>]
[-MaxCount <Int32>]
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzBatchSupportedImage cmdlet gets supported virtual machine images that are available in an Azure Batch account. Specify the account by using the BatchContext parameter.
Examples
Example 1: Get all available supported images
$Context = Get-AzBatchAccountKey -AccountName "ContosoBatchAccount"
Get-AzBatchSupportedImage -BatchContext $Context
BatchSupportEndOfLife :
Capabilities :
ImageReference : canonical:ubuntuserver:16.04-lts:latest
NodeAgentSkuId : batch.node.ubuntu 16.04
OSType : Linux
VerificationType : Verified
BatchSupportEndOfLife :
Capabilities :
ImageReference : canonical:ubuntuserver:18.04-lts:latest
NodeAgentSkuId : batch.node.ubuntu 18.04
OSType : Linux
VerificationType : Verified
BatchSupportEndOfLife :
Capabilities :
ImageReference : credativ:debian:8:latest
NodeAgentSkuId : batch.node.debian 8
OSType : Linux
VerificationType : Verified
BatchSupportEndOfLife :
Capabilities :
ImageReference : microsoftwindowsserver:windowsserver:2016-datacenter:latest
NodeAgentSkuId : batch.node.windows amd64
OSType : Windows
VerificationType : Verified
...
The first command gets a Batch account context that contains access keys for your subscription by using Get-AzBatchAccountKey. The command stores the context in the $Context variable to use in the next command. The second command gets all available supported images for that Batch account.
Parameters
-BatchContext
The BatchAccountContext instance to use when interacting 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.
Parameter properties
| Type: | BatchAccountContext |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Filter
Specifies an OData filter clause for supported images. If you do not specify a filter, this cmdlet returns all images the Batch account supports.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MaxCount
Specifies the maximum number of supported images to return.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
