BatchSupportedImage Class

A reference to the Azure Virtual Machines Marketplace Image and additional information about the Image.

Constructor

BatchSupportedImage(*args: Any, **kwargs: Any)

Variables

Name	Description
node_agent_sku_id	str The ID of the Compute Node agent SKU which the Image supports. Required.
image_reference	BatchVmImageReference The reference to the Azure Virtual Machine's Marketplace Image. Required.
os_type	str or OSType The type of operating system (e.g. Windows or Linux) of the Image. Required. Known values are: "linux" and "windows".
capabilities	list[str] 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.
batch_support_end_of_life	datetime The time when the Azure Batch service will stop accepting create Pool requests for the Image.
verification_type	str or ImageVerificationType 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".

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from D.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault	Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update	Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on D's values

Attributes

batch_support_end_of_life

The time when the Azure Batch service will stop accepting create Pool requests for the Image.

batch_support_end_of_life: datetime | None

capabilities

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.

capabilities: list[str] | None

image_reference

The reference to the Azure Virtual Machine's Marketplace Image. Required.

image_reference: _models.BatchVmImageReference

node_agent_sku_id

The ID of the Compute Node agent SKU which the Image supports. Required.

node_agent_sku_id: str

os_type

The type of operating system (e.g. Windows or Linux) of the Image. Required. Known values are: "linux" and "windows".

os_type: str | _models.OSType

verification_type

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".

verification_type: str | _models.ImageVerificationType

Feedback

Was this page helpful?