ImageReference Class

Specifies information about the image used.

Readonly variables are only populated by the server, and will be ignored when sending a request.

Constructor

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

Variables

Name Description
name
str

The name of the image used.

version
str

The version of the image.

operating_system
str

The operating system of the image.

os_build_number
str

The operating system build number of the image.

published_date

The datetime that the backing image version was published.

Methods

as_dict

Return a dict that can be JSONify using json.dump.

clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify using json.dump.

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

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

Default value: False

Returns

Type Description

A dict JSON compatible object

clear

clear() -> None

copy

copy() -> Model

get

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

Parameters

Name Description
key
Required
default
Default value: None

items

items() -> ItemsView[str, Any]

keys

keys() -> KeysView[str]

pop

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

Parameters

Name Description
key
Required
default

popitem

popitem() -> Tuple[str, Any]

setdefault

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

Parameters

Name Description
key
Required
default

update

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

values

values() -> ValuesView[Any]

Attributes

name

The name of the image used.

name: str | None

operating_system

The operating system of the image.

operating_system: str | None

os_build_number

The operating system build number of the image.

os_build_number: str | None

published_date

The datetime that the backing image version was published.

published_date: datetime | None

version

The version of the image.

version: str | None