Network Virtual Appliances - List

服務:: Virtual Networks

API 版本:: 2025-05-01

取得訂用帳戶中的所有網路虛擬設備。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualAppliances?api-version=2025-05-01

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	NetworkVirtualApplianceListResult	Azure 運作順利完成。
Other Status Codes	Common.CloudError	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List all Network Virtual Appliances for a given subscription

範例要求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/networkVirtualAppliances?api-version=2025-05-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python network_virtual_appliance_list_by_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.network_virtual_appliances.list()
    for item in response:
        print(item)


# x-ms-original-file: 2025-05-01/NetworkVirtualApplianceListBySubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets all Network Virtual Appliances in a subscription.
 *
 * @summary Gets all Network Virtual Appliances in a subscription.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/NetworkVirtualApplianceListBySubscription.json
 */
async function listAllNetworkVirtualAppliancesForAGivenSubscription() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.networkVirtualAppliances.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "name": "nva",
      "type": "Microsoft.Network/networkVirtualAppliances",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva",
      "identity": {
        "type": "UserAssigned",
        "userAssignedIdentities": {
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {}
        }
      },
      "location": "West US",
      "properties": {
        "additionalNics": [
          {
            "name": "exrsdwan",
            "hasPublicIp": true
          }
        ],
        "addressPrefix": "192.168.1.0/16",
        "bootStrapConfigurationBlobs": [
          "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig"
        ],
        "cloudInitConfigurationBlobs": [
          "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig"
        ],
        "inboundSecurityRules": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1"
          }
        ],
        "internetIngressPublicIps": [
          {
            "id": "/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip"
          }
        ],
        "networkProfile": {
          "networkInterfaceConfigurations": [
            {
              "type": "PublicNic",
              "properties": {
                "ipConfigurations": [
                  {
                    "name": "publicnicipconfig",
                    "properties": {
                      "primary": true
                    }
                  },
                  {
                    "name": "publicnicipconfig-2",
                    "properties": {
                      "primary": false
                    }
                  }
                ]
              }
            },
            {
              "type": "PrivateNic",
              "properties": {
                "ipConfigurations": [
                  {
                    "name": "privatenicipconfig",
                    "properties": {
                      "primary": true
                    }
                  },
                  {
                    "name": "privatenicipconfig-2",
                    "properties": {
                      "primary": false
                    }
                  }
                ]
              }
            }
          ]
        },
        "nvaSku": {
          "bundledScaleUnit": "1",
          "marketPlaceVersion": "12.1",
          "vendor": "Cisco SDWAN"
        },
        "provisioningState": "Succeeded",
        "virtualApplianceAsn": 10000,
        "virtualApplianceNics": [
          {
            "name": "publicnicipconfig",
            "instanceName": "nva_0",
            "nicType": "PublicNic",
            "privateIpAddress": "192.168.12.1",
            "publicIpAddress": "40.30.2.2"
          },
          {
            "name": "publicnicipconfig-2",
            "instanceName": "nva_0",
            "nicType": "PublicNic",
            "privateIpAddress": "192.168.12.2",
            "publicIpAddress": "40.30.2.3"
          },
          {
            "name": "privatenicipconfig",
            "instanceName": "nva_0",
            "nicType": "PrivateNic",
            "privateIpAddress": "192.168.12.3",
            "publicIpAddress": ""
          },
          {
            "name": "privatenicipconfig-2",
            "instanceName": "nva_0",
            "nicType": "PrivateNic",
            "privateIpAddress": "192.168.12.4",
            "publicIpAddress": ""
          },
          {
            "name": "exrsdwan",
            "instanceName": "nva_0",
            "nicType": "AdditionalNic",
            "privateIpAddress": "10.1.113.4",
            "publicIpAddress": "4.231.25.19"
          }
        ],
        "virtualApplianceSites": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1"
          }
        ],
        "virtualHub": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1"
        }
      },
      "tags": {
        "key1": "value1"
      }
    }
  ]
}

定義

名稱	Description
Common.CloudError	來自服務的錯誤回應。
Common.CloudErrorBody	來自服務的錯誤回應。
Common.ManagedServiceIdentity	資源的身分識別。
Common.SubResource	另一個子資源的參考。
DelegationProperties	委派的屬性。
InternetIngressPublicIpsProperties	網際網路輸入公用 IP 屬性
ManagedServiceIdentityUserAssignedIdentities
NetworkVirtualAppliance	NetworkVirtualAppliance 資源。
NetworkVirtualApplianceListResult	NetworkVirtualAppliance 清單操作的回應。
NetworkVirtualAppliancePropertiesFormatNetworkProfile	包含公用和私人 NIC 組態的網路配置檔。
NicTypeInRequest	NIC 類型。這應該是 PublicNic 或 PrivateNic。
NicTypeInResponse	NIC 類型 - PublicNic、PrivateNic 或 AdditionalNic;AdditionalPrivateNic 和 AdditionalPublicNic 僅支援部署在 VNet 中的 NVA。
NvaInterfaceConfigurationsProperties	指定 VNet 介面設定中所需的輸入參數 NVA。
NvaInVnetSubnetReferenceProperties	將部署 NVA NIC 的子網路參考
NvaNicType
PartnerManagedResourceProperties	合作夥伴受控資源的屬性。僅適用於 SaaS NVA。
ProvisioningState	應用程式安全性群組資源的佈建狀態。
ResourceIdentityType	用於資源的身分識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』會從虛擬機中移除任何身分識別。
VirtualApplianceAdditionalNicProperties	網路虛擬設備其他 NIC 屬性
VirtualApplianceIPConfiguration	表示單一IP組態。
VirtualApplianceIPConfigurationProperties	表示單一IP組態屬性。
VirtualApplianceNetworkInterfaceConfiguration	表示單一 NIC 組態。
VirtualApplianceNetworkInterfaceConfigurationProperties	表示單一 NIC 組態屬性。
VirtualApplianceNicProperties	網路虛擬設備 NIC 屬性。
VirtualApplianceSkuProperties	網路虛擬設備 Sku 屬性。

Common.CloudError

Object

來自服務的錯誤回應。

名稱	類型	Description
error	Common.CloudErrorBody	雲端錯誤內文。

Common.CloudErrorBody

Object

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
details	Common.CloudErrorBody[]	有關錯誤的其他詳細資料清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。例如，錯誤中的屬性名稱。

Common.ManagedServiceIdentity

Object

資源的身分識別。

名稱	類型	Description
principalId	string	系統指派身分的主體識別碼。此屬性只會針對系統指派的身分識別提供。
tenantId	string	系統指派身分識別的租用戶識別碼。此屬性只會針對系統指派的身分識別提供。
type	ResourceIdentityType	用於資源的身分識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』會從虛擬機中移除任何身分識別。
userAssignedIdentities	<string, ManagedServiceIdentityUserAssignedIdentities>	與資源相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

Common.SubResource

Object

另一個子資源的參考。

名稱	類型	Description
id	string	資源標識碼。

DelegationProperties

Object

委派的屬性。

名稱	類型	Description
provisioningState	ProvisioningState	布建資源的狀態。
serviceName	string	委派 NVA 的服務名稱。

InternetIngressPublicIpsProperties

Object

網際網路輸入公用 IP 屬性

名稱	類型	Description
id	string (arm-id)	公用IP的資源URI

ManagedServiceIdentityUserAssignedIdentities

Object

名稱	類型	Description
clientId	string	使用者指派身分識別的用戶端標識碼。
principalId	string	使用者指派身分識別的主體標識碼。