VirtualMachineScaleSetExtensionsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ComputeManagementClient's

<xref:virtual_machine_scale_set_extensions> attribute.

Inheritance
builtins.object
VirtualMachineScaleSetExtensionsOperations

Constructor

VirtualMachineScaleSetExtensionsOperations(*args, **kwargs)

Methods

begin_create_or_update

The operation to create or update an extension.
begin_delete

The operation to delete the extension.
begin_update

The operation to update an extension.
get

The operation to get the extension.
list

Gets a list of all extensions in a VM scale set.

begin_create_or_update

The operation to create or update an extension.

async begin_create_or_update(resource_group_name: str, vm_scale_set_name: str, vmss_extension_name: str, extension_parameters: _models.VirtualMachineScaleSetExtension, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.VirtualMachineScaleSetExtension]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_scale_set_name
Required
str

The name of the VM scale set where the extension should be create or updated. Required.
vmss_extension_name
Required
str

The name of the VM scale set extension. Required.
extension_parameters
Required
VirtualMachineScaleSetExtension or IO[bytes]

Parameters supplied to the Create VM scale set Extension operation. Is either a VirtualMachineScaleSetExtension type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[VirtualMachineScaleSetExtension]

An instance of AsyncLROPoller that returns either VirtualMachineScaleSetExtension or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

The operation to delete the extension.

async begin_delete(resource_group_name: str, vm_scale_set_name: str, vmss_extension_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_scale_set_name
Required
str

The name of the VM scale set where the extension should be deleted. Required.
vmss_extension_name
Required
str

The name of the VM scale set extension. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_update

The operation to update an extension.

async begin_update(resource_group_name: str, vm_scale_set_name: str, vmss_extension_name: str, extension_parameters: _models.VirtualMachineScaleSetExtensionUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.VirtualMachineScaleSetExtension]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_scale_set_name
Required
str

The name of the VM scale set where the extension should be updated. Required.
vmss_extension_name
Required
str

The name of the VM scale set extension. Required.
extension_parameters
Required
VirtualMachineScaleSetExtensionUpdate or IO[bytes]

Parameters supplied to the Update VM scale set Extension operation. Is either a VirtualMachineScaleSetExtensionUpdate type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[VirtualMachineScaleSetExtension]

An instance of AsyncLROPoller that returns either VirtualMachineScaleSetExtension or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

The operation to get the extension.

async get(resource_group_name: str, vm_scale_set_name: str, vmss_extension_name: str, *, expand: str | None = None, **kwargs: Any) -> VirtualMachineScaleSetExtension

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_scale_set_name
Required
str

The name of the VM scale set containing the extension. Required.
vmss_extension_name
Required
str

The name of the VM scale set extension. Required.

Keyword-Only Parameters

Name Description
expand
str

The expand expression to apply on the operation. Default value is None.

Returns

Type Description
VirtualMachineScaleSetExtension

VirtualMachineScaleSetExtension or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets a list of all extensions in a VM scale set.

list(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) -> AsyncIterable[VirtualMachineScaleSetExtension]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_scale_set_name
Required
str

The name of the VM scale set containing the extension. Required.

Returns

Type Description
AsyncItemPaged[VirtualMachineScaleSetExtension]

An iterator like instance of either VirtualMachineScaleSetExtension or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.compute.v2021_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2021_03_01\\models\\__init__.py'>