Network Virtual Appliances - Restart

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

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/restart?api-version=2024-03-01

URI Parameters

Name In Required Type Description
networkVirtualApplianceName
path True

string

The name of Network Virtual Appliance.

resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client API version.

Request Body

Name Type Description
instanceIds

string[]

The network virtual appliance instance ids. Omitting the network virtual appliance instance ids will result in the operation being performed on all virtual machines belonging to the network virtual appliance.

Responses

Name Type Description
200 OK

NetworkVirtualApplianceInstanceIds

Request successful. The operation restarts one or more Network Virtual Appliance VM resources.

202 Accepted

Request accepted. The operation restarts one or more Network Virtual Appliance VM resources.

Headers

Location: string

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Restart All NetworkVirtualAppliance VMs in VM Scale Set
Restart Specific NetworkVirtualAppliance VMs in VM Scale Set

Restart All NetworkVirtualAppliance VMs in VM Scale Set

Sample request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/restart?api-version=2024-03-01

Sample response

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
{
  "instanceIds": []
}
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2024-03-01

Restart Specific NetworkVirtualAppliance VMs in VM Scale Set

Sample request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/restart?api-version=2024-03-01

Sample response

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
{
  "instanceIds": [
    "0",
    "1"
  ]
}
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2024-03-01

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

NetworkVirtualApplianceInstanceIds

Specifies a list of virtual machine instance IDs from the Network Virtual Appliance VM instances.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

NetworkVirtualApplianceInstanceIds

Specifies a list of virtual machine instance IDs from the Network Virtual Appliance VM instances.

Name Type Description
instanceIds

string[]

The network virtual appliance instance ids. Omitting the network virtual appliance instance ids will result in the operation being performed on all virtual machines belonging to the network virtual appliance.