supported_images

Creates, updates, deletes, gets or lists a supported_images resource.

Overview

Name	supported_images
Type	Resource
Id	azure.batch_dataplane.supported_images

Fields

The following fields are returned by SELECT queries:

list_supported_images

Name	Datatype	Description
batchSupportEndOfLife	string (date-time)	The time when the Azure Batch service will stop accepting create Pool requests for the Image.
capabilities	array	The capabilities or features which the Image supports. Not every capability of the Image is listed. Capabilities in this list are considered of special interest and are generally related to integration with other features in the Azure Batch service.
imageReference	object	The reference to the Azure Virtual Machine's Marketplace Image. Required.
nodeAgentSKUId	string	The ID of the Compute Node agent SKU which the Image supports. Required.
osType	string	The type of operating system (e.g. Windows or Linux) of the Image. Required. Known values are: "linux" and "windows". (linux, windows)
verificationType	string	Whether the Azure Batch service actively verifies that the Image is compatible with the associated Compute Node agent SKU. Required. Known values are: "verified" and "unverified". (verified, unverified)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_supported_images	select	endpoint	timeOut, ocp-date, maxresults, $filter	Lists all Virtual Machine Images supported by the Azure Batch service. Lists all Virtual Machine Images supported by the Azure Batch service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
$filter	string	An OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images _. Default value is None.
maxresults	integer	The maximum number of items to return in the response. A maximum of 1000 applications can be returned. Default value is None.
ocp-date	string	The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. Default value is None.
timeOut	integer	The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". Default value is None.

SELECT examples

list_supported_images

Lists all Virtual Machine Images supported by the Azure Batch service. Lists all Virtual Machine Images supported by the Azure Batch service.

SELECT
batchSupportEndOfLife,
capabilities,
imageReference,
nodeAgentSKUId,
osType,
verificationType
FROM azure.batch_dataplane.supported_images
WHERE endpoint = '{{ endpoint }}' -- required
AND timeOut = '{{ timeOut }}'
AND ocp-date = '{{ ocp-date }}'
AND maxresults = '{{ maxresults }}'
AND $filter = '{{ $filter }}'
;