VMExtension Class

The configuration for virtual machine extensions.

Constructor

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

Variables

Name	Description
name	str The name of the virtual machine extension. Required.
publisher	str The name of the extension handler publisher. Required.
type	str The type of the extension. Required.
type_handler_version	str The version of script handler.
auto_upgrade_minor_version	bool Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
enable_automatic_upgrade	bool Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
settings	dict[str, str] JSON formatted public settings for the extension.
protected_settings	dict[str, str] The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provision_after_extensions	list[str] The collection of extension names. Collection of extension names after which this extension needs to be provisioned.

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

auto_upgrade_minor_version

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

auto_upgrade_minor_version: bool | None

enable_automatic_upgrade

Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.

enable_automatic_upgrade: bool | None

name

The name of the virtual machine extension. Required.

name: str

protected_settings

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

protected_settings: dict[str, str] | None

provision_after_extensions

The collection of extension names. Collection of extension names after which this extension needs to be provisioned.

provision_after_extensions: list[str] | None

publisher

The name of the extension handler publisher. Required.

publisher: str

settings

JSON formatted public settings for the extension.

settings: dict[str, str] | None

type

The type of the extension. Required.

type: str

type_handler_version

The version of script handler.

type_handler_version: str | None

フィードバック

このページはお役に立ちましたか?