NetworkVirtualAppliancesOperations interface

Package:
@azure/arm-network

Interface representing a NetworkVirtualAppliances operations.

Properties

abortMigration

Aborts an in-progress migration of the specified Network Virtual Appliance and rolls back to the previous state.
beginAbortMigration
beginAbortMigrationAndWait
beginCommitMigration
beginCommitMigrationAndWait
beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginExecuteMigration
beginExecuteMigrationAndWait
beginGetBootDiagnosticLogs
beginGetBootDiagnosticLogsAndWait
beginPrepareMigration
beginPrepareMigrationAndWait
beginReimage
beginReimageAndWait
beginRestart
beginRestartAndWait
commitMigration

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

Creates or updates the specified Network Virtual Appliance.
delete

Deletes the specified Network Virtual Appliance.
executeMigration

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

Gets the specified Network Virtual Appliance.
getBootDiagnosticLogs

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

Gets all Network Virtual Appliances in a subscription.
listByResourceGroup

Lists all Network Virtual Appliances in a resource group.
prepareMigration

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.
reimage

Reimages one VM belonging to the specified Network Virtual Appliance.
restart

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

Updates a Network Virtual Appliance.

Property Details

abortMigration

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

abortMigration: (resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesAbortMigrationOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesAbortMigrationOptionalParams) => PollerLike<OperationState<void>, void>

beginAbortMigration

Warning

This API is now deprecated.

use abortMigration instead

beginAbortMigration: (resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesAbortMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesAbortMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginAbortMigrationAndWait

Warning

This API is now deprecated.

use abortMigration instead

beginAbortMigrationAndWait: (resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesAbortMigrationOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesAbortMigrationOptionalParams) => Promise<void>

beginCommitMigration

Warning

This API is now deprecated.

use commitMigration instead

beginCommitMigration: (resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualApplianceCommitMigrationRequest, options?: NetworkVirtualAppliancesCommitMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualApplianceCommitMigrationRequest, options?: NetworkVirtualAppliancesCommitMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginCommitMigrationAndWait

Warning

This API is now deprecated.

use commitMigration instead

beginCommitMigrationAndWait: (resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualApplianceCommitMigrationRequest, options?: NetworkVirtualAppliancesCommitMigrationOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualApplianceCommitMigrationRequest, options?: NetworkVirtualAppliancesCommitMigrationOptionalParams) => Promise<void>

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, networkVirtualApplianceName: string, parameters: NetworkVirtualAppliance, options?: NetworkVirtualAppliancesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NetworkVirtualAppliance>, NetworkVirtualAppliance>>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, parameters: NetworkVirtualAppliance, options?: NetworkVirtualAppliancesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NetworkVirtualAppliance>, NetworkVirtualAppliance>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, networkVirtualApplianceName: string, parameters: NetworkVirtualAppliance, options?: NetworkVirtualAppliancesCreateOrUpdateOptionalParams) => Promise<NetworkVirtualAppliance>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, parameters: NetworkVirtualAppliance, options?: NetworkVirtualAppliancesCreateOrUpdateOptionalParams) => Promise<NetworkVirtualAppliance>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesDeleteOptionalParams) => Promise<void>

beginExecuteMigration

Warning

This API is now deprecated.

use executeMigration instead

beginExecuteMigration: (resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualApplianceExecuteMigrationRequest, options?: NetworkVirtualAppliancesExecuteMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualApplianceExecuteMigrationRequest, options?: NetworkVirtualAppliancesExecuteMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginExecuteMigrationAndWait

Warning

This API is now deprecated.

use executeMigration instead

beginExecuteMigrationAndWait: (resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualApplianceExecuteMigrationRequest, options?: NetworkVirtualAppliancesExecuteMigrationOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualApplianceExecuteMigrationRequest, options?: NetworkVirtualAppliancesExecuteMigrationOptionalParams) => Promise<void>

beginGetBootDiagnosticLogs

Warning

This API is now deprecated.

use getBootDiagnosticLogs instead

beginGetBootDiagnosticLogs: (resourceGroupName: string, networkVirtualApplianceName: string, request: NetworkVirtualApplianceBootDiagnosticParameters, options?: NetworkVirtualAppliancesGetBootDiagnosticLogsOptionalParams) => Promise<SimplePollerLike<OperationState<NetworkVirtualApplianceInstanceId>, NetworkVirtualApplianceInstanceId>>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, request: NetworkVirtualApplianceBootDiagnosticParameters, options?: NetworkVirtualAppliancesGetBootDiagnosticLogsOptionalParams) => Promise<SimplePollerLike<OperationState<NetworkVirtualApplianceInstanceId>, NetworkVirtualApplianceInstanceId>>

beginGetBootDiagnosticLogsAndWait

Warning

This API is now deprecated.

use getBootDiagnosticLogs instead

beginGetBootDiagnosticLogsAndWait: (resourceGroupName: string, networkVirtualApplianceName: string, request: NetworkVirtualApplianceBootDiagnosticParameters, options?: NetworkVirtualAppliancesGetBootDiagnosticLogsOptionalParams) => Promise<NetworkVirtualApplianceInstanceId>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, request: NetworkVirtualApplianceBootDiagnosticParameters, options?: NetworkVirtualAppliancesGetBootDiagnosticLogsOptionalParams) => Promise<NetworkVirtualApplianceInstanceId>

beginPrepareMigration

Warning

This API is now deprecated.

use prepareMigration instead

beginPrepareMigration: (resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualAppliancePrepareMigrationRequest, options?: NetworkVirtualAppliancesPrepareMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualAppliancePrepareMigrationRequest, options?: NetworkVirtualAppliancesPrepareMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginPrepareMigrationAndWait

Warning

This API is now deprecated.

use prepareMigration instead

beginPrepareMigrationAndWait: (resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualAppliancePrepareMigrationRequest, options?: NetworkVirtualAppliancesPrepareMigrationOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualAppliancePrepareMigrationRequest, options?: NetworkVirtualAppliancesPrepareMigrationOptionalParams) => Promise<void>

beginReimage

Warning

This API is now deprecated.

use reimage instead

beginReimage: (resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesReimageOptionalParams) => Promise<SimplePollerLike<OperationState<NetworkVirtualApplianceInstanceIds>, NetworkVirtualApplianceInstanceIds>>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesReimageOptionalParams) => Promise<SimplePollerLike<OperationState<NetworkVirtualApplianceInstanceIds>, NetworkVirtualApplianceInstanceIds>>

beginReimageAndWait

Warning

This API is now deprecated.

use reimage instead

beginReimageAndWait: (resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesReimageOptionalParams) => Promise<NetworkVirtualApplianceInstanceIds>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesReimageOptionalParams) => Promise<NetworkVirtualApplianceInstanceIds>

beginRestart

Warning

This API is now deprecated.

use restart instead

beginRestart: (resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesRestartOptionalParams) => Promise<SimplePollerLike<OperationState<NetworkVirtualApplianceInstanceIds>, NetworkVirtualApplianceInstanceIds>>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesRestartOptionalParams) => Promise<SimplePollerLike<OperationState<NetworkVirtualApplianceInstanceIds>, NetworkVirtualApplianceInstanceIds>>

beginRestartAndWait

Warning

This API is now deprecated.

use restart instead

beginRestartAndWait: (resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesRestartOptionalParams) => Promise<NetworkVirtualApplianceInstanceIds>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesRestartOptionalParams) => Promise<NetworkVirtualApplianceInstanceIds>

commitMigration

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

commitMigration: (resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualApplianceCommitMigrationRequest, options?: NetworkVirtualAppliancesCommitMigrationOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualApplianceCommitMigrationRequest, options?: NetworkVirtualAppliancesCommitMigrationOptionalParams) => PollerLike<OperationState<void>, void>

createOrUpdate

Creates or updates the specified Network Virtual Appliance.

createOrUpdate: (resourceGroupName: string, networkVirtualApplianceName: string, parameters: NetworkVirtualAppliance, options?: NetworkVirtualAppliancesCreateOrUpdateOptionalParams) => PollerLike<OperationState<NetworkVirtualAppliance>, NetworkVirtualAppliance>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, parameters: NetworkVirtualAppliance, options?: NetworkVirtualAppliancesCreateOrUpdateOptionalParams) => PollerLike<OperationState<NetworkVirtualAppliance>, NetworkVirtualAppliance>

delete

Deletes the specified Network Virtual Appliance.

delete: (resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

executeMigration

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

executeMigration: (resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualApplianceExecuteMigrationRequest, options?: NetworkVirtualAppliancesExecuteMigrationOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualApplianceExecuteMigrationRequest, options?: NetworkVirtualAppliancesExecuteMigrationOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets the specified Network Virtual Appliance.

get: (resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesGetOptionalParams) => Promise<NetworkVirtualAppliance>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesGetOptionalParams) => Promise<NetworkVirtualAppliance>

getBootDiagnosticLogs

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

getBootDiagnosticLogs: (resourceGroupName: string, networkVirtualApplianceName: string, request: NetworkVirtualApplianceBootDiagnosticParameters, options?: NetworkVirtualAppliancesGetBootDiagnosticLogsOptionalParams) => PollerLike<OperationState<NetworkVirtualApplianceInstanceId>, NetworkVirtualApplianceInstanceId>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, request: NetworkVirtualApplianceBootDiagnosticParameters, options?: NetworkVirtualAppliancesGetBootDiagnosticLogsOptionalParams) => PollerLike<OperationState<NetworkVirtualApplianceInstanceId>, NetworkVirtualApplianceInstanceId>

list

Gets all Network Virtual Appliances in a subscription.

list: (options?: NetworkVirtualAppliancesListOptionalParams) => PagedAsyncIterableIterator<NetworkVirtualAppliance, NetworkVirtualAppliance[], PageSettings>

Property Value

(options?: NetworkVirtualAppliancesListOptionalParams) => PagedAsyncIterableIterator<NetworkVirtualAppliance, NetworkVirtualAppliance[], PageSettings>

listByResourceGroup

Lists all Network Virtual Appliances in a resource group.

listByResourceGroup: (resourceGroupName: string, options?: NetworkVirtualAppliancesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<NetworkVirtualAppliance, NetworkVirtualAppliance[], PageSettings>

Property Value

(resourceGroupName: string, options?: NetworkVirtualAppliancesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<NetworkVirtualAppliance, NetworkVirtualAppliance[], PageSettings>

prepareMigration

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.

prepareMigration: (resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualAppliancePrepareMigrationRequest, options?: NetworkVirtualAppliancesPrepareMigrationOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, body: NetworkVirtualAppliancePrepareMigrationRequest, options?: NetworkVirtualAppliancesPrepareMigrationOptionalParams) => PollerLike<OperationState<void>, void>

reimage

Reimages one VM belonging to the specified Network Virtual Appliance.

reimage: (resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesReimageOptionalParams) => PollerLike<OperationState<NetworkVirtualApplianceInstanceIds>, NetworkVirtualApplianceInstanceIds>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesReimageOptionalParams) => PollerLike<OperationState<NetworkVirtualApplianceInstanceIds>, NetworkVirtualApplianceInstanceIds>

restart

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

restart: (resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesRestartOptionalParams) => PollerLike<OperationState<NetworkVirtualApplianceInstanceIds>, NetworkVirtualApplianceInstanceIds>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, options?: NetworkVirtualAppliancesRestartOptionalParams) => PollerLike<OperationState<NetworkVirtualApplianceInstanceIds>, NetworkVirtualApplianceInstanceIds>

updateTags

Updates a Network Virtual Appliance.

updateTags: (resourceGroupName: string, networkVirtualApplianceName: string, parameters: TagsObject, options?: NetworkVirtualAppliancesUpdateTagsOptionalParams) => Promise<NetworkVirtualAppliance>

Property Value

(resourceGroupName: string, networkVirtualApplianceName: string, parameters: TagsObject, options?: NetworkVirtualAppliancesUpdateTagsOptionalParams) => Promise<NetworkVirtualAppliance>