Vpn Server Configurations Associated With Virtual Wan - List

服务:

Virtual WAN

API 版本:

2025-05-01

提供与资源组中的虚拟 WAN 关联的 VpnServerConfigurations 列表。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnServerConfigurations?api-version=2025-05-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
virtualWANName	path	True	string	这就是VirtualWAN的名称。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK	VpnServerConfigurationsResponse	Azure 运营顺利完成。
202 Accepted		已接受资源作。 标头 Location: string Retry-After: integer
Other Status Codes	CloudError	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

GetVirtualWanVpnServerConfigurations

示例请求

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/wan1/vpnServerConfigurations?api-version=2025-05-01

JavaScript

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

/**
 * This sample demonstrates how to Gives the list of VpnServerConfigurations associated with Virtual Wan in a resource group.
 *
 * @summary Gives the list of VpnServerConfigurations associated with Virtual Wan in a resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/GetVirtualWanVpnServerConfigurations.json
 */
async function getVirtualWanVpnServerConfigurations() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualWANName = "wan1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.vpnServerConfigurationsAssociatedWithVirtualWan.beginListAndWait(
    resourceGroupName,
    virtualWANName,
  );
  console.log(result);
}

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

示例响应

状态代码:

200

{
  "vpnServerConfigurationResourceIds": [
    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig1",
    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig2"
  ]
}

状态代码:

202

location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}

定义

名称	说明
CloudError	服务的错误响应。
CloudErrorBody	服务的错误响应。
VpnServerConfigurationsResponse	与 VirtualWan 响应关联的 VpnServerConfigurations 列表。

CloudError

对象

服务的错误响应。

名称	类型	说明
error	CloudErrorBody	云错误正文。

CloudErrorBody

对象

服务的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。 例如，错误属性的名称。

VpnServerConfigurationsResponse

对象

与 VirtualWan 响应关联的 VpnServerConfigurations 列表。

名称	类型	说明
vpnServerConfigurationResourceIds	string[]	与 VirtualWAN 关联的 VpnServerConfigurations 列表。