NetworkVirtualAppliancesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:network_virtual_appliances> attribute.

Constructor

NetworkVirtualAppliancesOperations(*args, **kwargs)

Methods

begin_abort_migration	Aborts an in-progress migration of the specified Network Virtual Appliance and rolls back to the previous state.
begin_commit_migration	Commits the migration of the specified Network Virtual Appliance. This finalizes a previously executed migration workflow.
begin_create_or_update	Creates or updates the specified Network Virtual Appliance.
begin_delete	Deletes the specified Network Virtual Appliance.
begin_execute_migration	Executes the migration of the specified Network Virtual Appliance. This step performs the migration workflow that was previously prepared.
begin_get_boot_diagnostic_logs	Retrieves the boot diagnostic logs for a VM instance belonging to the specified Network Virtual Appliance.
begin_prepare_migration	Prepares the migration of the specified Network Virtual Appliance. This is the first step of a migration workflow, such as migrating to a new OS version or to the new internal load balancer architecture.
begin_reimage	Reimages one VM belonging to 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_abort_migration

Aborts an in-progress migration of the specified Network Virtual Appliance and rolls back to the previous state.

begin_abort_migration(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. The name is case insensitive. 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 None

Exceptions

Type	Description
HttpResponseError

begin_commit_migration

Commits the migration of the specified Network Virtual Appliance. This finalizes a previously executed migration workflow.

begin_commit_migration(resource_group_name: str, network_virtual_appliance_name: str, body: _models.NetworkVirtualApplianceCommitMigrationRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
network_virtual_appliance_name Required	str The name of Network Virtual Appliance. Required.
body Required	NetworkVirtualApplianceCommitMigrationRequest or NetworkVirtualApplianceCommitMigrationRequest or IO[bytes] Parameters supplied to commit the migration of the Network Virtual Appliance. Is either a NetworkVirtualApplianceCommitMigrationRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

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. The name is case insensitive. Required.
network_virtual_appliance_name Required	str The name of Network Virtual Appliance. Required.
parameters Required	NetworkVirtualAppliance or 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 NetworkVirtualAppliance. The NetworkVirtualAppliance is compatible with MutableMapping

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. The name is case insensitive. 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 None

Exceptions

Type	Description
HttpResponseError

begin_execute_migration

Executes the migration of the specified Network Virtual Appliance. This step performs the migration workflow that was previously prepared.

begin_execute_migration(resource_group_name: str, network_virtual_appliance_name: str, body: _models.NetworkVirtualApplianceExecuteMigrationRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
network_virtual_appliance_name Required	str The name of Network Virtual Appliance. Required.
body Required	NetworkVirtualApplianceExecuteMigrationRequest or NetworkVirtualApplianceExecuteMigrationRequest or IO[bytes] Parameters supplied to execute the migration of the Network Virtual Appliance. Is either a NetworkVirtualApplianceExecuteMigrationRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_get_boot_diagnostic_logs

Retrieves the boot diagnostic logs for a VM instance belonging to the specified Network Virtual Appliance.

begin_get_boot_diagnostic_logs(resource_group_name: str, network_virtual_appliance_name: str, request: _models.NetworkVirtualApplianceBootDiagnosticParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.NetworkVirtualApplianceInstanceId]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
network_virtual_appliance_name Required	str The name of Network Virtual Appliance. Required.
request Required	NetworkVirtualApplianceBootDiagnosticParameters or NetworkVirtualApplianceBootDiagnosticParameters or IO[bytes] Parameters supplied to retrieve boot diagnostic logs for a NVA VM instance. Is either a NetworkVirtualApplianceBootDiagnosticParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[NetworkVirtualApplianceInstanceId]	An instance of LROPoller that returns NetworkVirtualApplianceInstanceId. The NetworkVirtualApplianceInstanceId is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_prepare_migration

Prepares the migration of the specified Network Virtual Appliance. This is the first step of a migration workflow, such as migrating to a new OS version or to the new internal load balancer architecture.

begin_prepare_migration(resource_group_name: str, network_virtual_appliance_name: str, body: _models.NetworkVirtualAppliancePrepareMigrationRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
network_virtual_appliance_name Required	str The name of Network Virtual Appliance. Required.
body Required	NetworkVirtualAppliancePrepareMigrationRequest or NetworkVirtualAppliancePrepareMigrationRequest or IO[bytes] Parameters supplied to prepare the migration of the Network Virtual Appliance. Is either a NetworkVirtualAppliancePrepareMigrationRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_reimage

Reimages one VM belonging to the specified Network Virtual Appliance.

begin_reimage(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. The name is case insensitive. Required.
network_virtual_appliance_name Required	str The name of Network Virtual Appliance. Required.
network_virtual_appliance_instance_ids	NetworkVirtualApplianceInstanceIds or 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 NetworkVirtualApplianceInstanceIds. The NetworkVirtualApplianceInstanceIds is compatible with MutableMapping

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. The name is case insensitive. Required.
network_virtual_appliance_name Required	str The name of Network Virtual Appliance. Required.
network_virtual_appliance_instance_ids	NetworkVirtualApplianceInstanceIds or 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 NetworkVirtualApplianceInstanceIds. The NetworkVirtualApplianceInstanceIds is compatible with MutableMapping

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. The name is case insensitive. 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. The NetworkVirtualAppliance is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

Gets all Network Virtual Appliances in a subscription.

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

Returns

Type	Description
ItemPaged[NetworkVirtualAppliance]	An iterator like instance of NetworkVirtualAppliance

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) -> ItemPaged[NetworkVirtualAppliance]

Parameters

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

Returns

Type	Description
ItemPaged[NetworkVirtualAppliance]	An iterator like instance of NetworkVirtualAppliance

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 name of the resource group. The name is case insensitive. Required.
network_virtual_appliance_name Required	str The name of Network Virtual Appliance. Required.
parameters Required	TagsObject or 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. The NetworkVirtualAppliance is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Visszajelzés

Hasznosnak találta ezt az oldalt?