你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Virtual Appliance Sites - List

Lists all Network Virtual Appliance Sites in a Network Virtual Appliance resource.

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

URI Parameters

Name In Required Type Description
networkVirtualApplianceName
path True

string

The name of the 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.

Responses

Name Type Description
200 OK

NetworkVirtualApplianceSiteListResult

Success. The operation returns a list of Network Virtual Appliance site resources.

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

List all Network Virtual Appliance sites for a given Network Virtual Appliance

Sample request

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

Sample response

{
  "value": [
    {
      "name": "site1",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/site1",
      "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"",
      "properties": {
        "provisioningState": "Succeeded",
        "addressPrefix": "192.168.1.0/24",
        "o365Policy": {
          "breakOutCategories": {
            "allow": true,
            "optimize": true,
            "default": true
          }
        }
      }
    }
  ]
}

Definitions

Name Description
BreakOutCategoryPolicies

Network Virtual Appliance Sku Properties.

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

NetworkVirtualApplianceSiteListResult

Response for ListNetworkVirtualApplianceSites API service call.

Office365PolicyProperties

Network Virtual Appliance Sku Properties.

ProvisioningState

The current provisioning state.

VirtualApplianceSite

Virtual Appliance Site resource.

BreakOutCategoryPolicies

Network Virtual Appliance Sku Properties.

Name Type Description
allow

boolean

Flag to control breakout of o365 allow category.

default

boolean

Flag to control breakout of o365 default category.

optimize

boolean

Flag to control breakout of o365 optimize category.

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.

NetworkVirtualApplianceSiteListResult

Response for ListNetworkVirtualApplianceSites API service call.

Name Type Description
nextLink

string

URL to get the next set of results.

value

VirtualApplianceSite[]

List of Network Virtual Appliance sites.

Office365PolicyProperties

Network Virtual Appliance Sku Properties.

Name Type Description
breakOutCategories

BreakOutCategoryPolicies

Office 365 breakout categories.

ProvisioningState

The current provisioning state.

Name Type Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

VirtualApplianceSite

Virtual Appliance Site resource.

Name Type Description
etag

string

A unique read-only string that changes whenever the resource is updated.

id

string

Resource ID.

name

string

Name of the virtual appliance site.

properties.addressPrefix

string

Address Prefix.

properties.o365Policy

Office365PolicyProperties

Office 365 Policy.

properties.provisioningState

ProvisioningState

The provisioning state of the resource.

type

string

Site type.