NetworkVirtualAppliancesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:network_virtual_appliances> attribute.

Constructor

NetworkVirtualAppliancesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates the specified Network Virtual Appliance.
begin_delete	Deletes the specified Network Virtual Appliance.
begin_restart	Restarts one or more VMs belonging to the specified Network Virtual Appliance.
get	Gets the specified Network Virtual Appliance.
list	Gets all Network Virtual Appliances in a subscription.
list_by_resource_group	Lists all Network Virtual Appliances in a resource group.
update_tags	Updates a Network Virtual Appliance.

begin_create_or_update

Creates or updates the specified Network Virtual Appliance.

begin_create_or_update(resource_group_name: str, network_virtual_appliance_name: str, parameters: _models.NetworkVirtualAppliance, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.NetworkVirtualAppliance]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_virtual_appliance_name Required	str The name of Network Virtual Appliance. Required.
parameters Required	NetworkVirtualAppliance or IO[bytes] Parameters supplied to the create or update Network Virtual Appliance. Is either a NetworkVirtualAppliance type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[NetworkVirtualAppliance]	An instance of LROPoller that returns either NetworkVirtualAppliance or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified Network Virtual Appliance.

begin_delete(resource_group_name: str, network_virtual_appliance_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_virtual_appliance_name Required	str The name of Network Virtual Appliance. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_restart

Restarts one or more VMs belonging to the specified Network Virtual Appliance.

begin_restart(resource_group_name: str, network_virtual_appliance_name: str, network_virtual_appliance_instance_ids: _models.NetworkVirtualApplianceInstanceIds | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.NetworkVirtualApplianceInstanceIds]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_virtual_appliance_name Required	str The name of Network Virtual Appliance. Required.
network_virtual_appliance_instance_ids	NetworkVirtualApplianceInstanceIds or IO[bytes] Specifies a list of virtual machine instance IDs from the Network Virtual Appliance VM instances. Is either a NetworkVirtualApplianceInstanceIds type or a IO[bytes] type. Default value is None. Default value: None

Returns

Type	Description
LROPoller[NetworkVirtualApplianceInstanceIds]	An instance of LROPoller that returns either NetworkVirtualApplianceInstanceIds or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets the specified Network Virtual Appliance.

get(resource_group_name: str, network_virtual_appliance_name: str, *, expand: str | None = None, **kwargs: Any) -> NetworkVirtualAppliance

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_virtual_appliance_name Required	str The name of Network Virtual Appliance. Required.

Keyword-Only Parameters

Name	Description
expand	str Expands referenced resources. Default value is None. Default value: None

Returns

Type	Description
NetworkVirtualAppliance	NetworkVirtualAppliance or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Gets all Network Virtual Appliances in a subscription.

list(**kwargs: Any) -> Iterable[NetworkVirtualAppliance]

Returns

Type	Description
ItemPaged[NetworkVirtualAppliance]	An iterator like instance of either NetworkVirtualAppliance or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Lists all Network Virtual Appliances in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[NetworkVirtualAppliance]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.

Returns

Type	Description
ItemPaged[NetworkVirtualAppliance]	An iterator like instance of either NetworkVirtualAppliance or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update_tags

Updates a Network Virtual Appliance.

update_tags(resource_group_name: str, network_virtual_appliance_name: str, parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.NetworkVirtualAppliance

Parameters

Name	Description
resource_group_name Required	str The resource group name of Network Virtual Appliance. Required.
network_virtual_appliance_name Required	str The name of Network Virtual Appliance being updated. Required.
parameters Required	TagsObject or IO[bytes] Parameters supplied to Update Network Virtual Appliance Tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type	Description
NetworkVirtualAppliance	NetworkVirtualAppliance or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv167\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>