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

List Network Manager Effective Connectivity Configurations - List Network Manager Effective Connectivity Configurations

列出在虚拟网络上应用的所有有效连接配置。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listNetworkManagerEffectiveConnectivityConfigurations?api-version=2022-01-01

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

资源组的名称。

subscriptionId
path True
  • string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

virtualNetworkName
path True
  • string

虚拟网络的名称。

api-version
query True
  • string

客户端 API 版本。

请求正文

Name Type Description
skipToken
  • string

如果存在,可以将该值传递给后续查询调用 (以及当前请求中使用的相同查询和范围,) 检索下一页数据。

响应

Name Type Description
200 OK

确定 - 返回有关配置的信息。

Other Status Codes

资源提供程序错误响应,描述操作失败的原因。

安全性

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 模拟用户帐户

示例

List effective connectivity configuration

Sample Request

POST https://management.azure.com/subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/testVirtualNetwork/listNetworkManagerEffectiveConnectivityConfigurations?api-version=2022-01-01

{
  "skipToken": "FakeSkipTokenCode"
}

Sample Response

{
  "value": [
    {
      "id": "subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig",
      "properties": {
        "description": "Sample Configuration",
        "connectivityTopology": "HubAndSpoke",
        "hubs": [
          {
            "resourceId": "/subscriptionB/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myHubVnet",
            "resourceType": "Microsoft.Network/virtualNetworks"
          }
        ],
        "isGlobal": "True",
        "deleteExistingPeering": "True",
        "appliesToGroups": [
          {
            "networkGroupId": "/subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/groups/group1",
            "useHubGateway": "True",
            "groupConnectivity": "None",
            "isGlobal": "False"
          }
        ],
        "provisioningState": "Succeeded"
      },
      "configurationGroups": [
        {
          "id": "/subscriptions/subscriptionA/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1",
          "properties": {
            "description": "A group for all test Virtual Networks",
            "provisioningState": "Succeeded"
          }
        }
      ]
    }
  ],
  "skipToken": "FakeSkipTokenCode"
}

定义

CloudError

服务的错误响应。

CloudErrorBody

服务的错误响应。

ConfigurationGroup

网络配置组资源

connectivityGroupItem

连接组项。

ConnectivityTopology

连接拓扑类型。

DeleteExistingPeering

如果需要删除当前的现有对等互连,则标记。

EffectiveConnectivityConfiguration

网络管理器有效的连接配置

GroupConnectivity

组连接类型。

Hub

中心项。

IsGlobal

如果支持全局网格,则标记。

NetworkManagerEffectiveConnectivityConfigurationListResult

列出 networkManagerEffectiveConnectivityConfiguration 的请求的结果。 它包含组列表和 skiptoken 以获取下一组结果。

ProvisioningState

当前预配状态。

QueryRequestOptions

查询请求选项

UseHubGateway

如果需要使用中心网关,则标记。

CloudError

服务的错误响应。

Name Type Description
error

云错误正文。

CloudErrorBody

服务的错误响应。

Name Type Description
code
  • string

错误的标识符。 代码是固定的,旨在以编程方式使用。

details

有关错误的其他详细信息的列表。

message
  • string

描述错误的消息,旨在适合在用户界面中显示。

target
  • string

特定错误的目标。 例如,错误属性的名称。

ConfigurationGroup

网络配置组资源

Name Type Description
id
  • string

网络组 ID。

properties.description
  • string

网络组的说明。

properties.provisioningState

范围分配资源的预配状态。

connectivityGroupItem

连接组项。

Name Type Description
groupConnectivity

组连接类型。

isGlobal

如果支持全局,则标记。

networkGroupId
  • string

网络组 ID。

useHubGateway

如果需要使用中心网关,则标记。

ConnectivityTopology

连接拓扑类型。

Name Type Description
HubAndSpoke
  • string
Mesh
  • string

DeleteExistingPeering

如果需要删除当前的现有对等互连,则标记。

Name Type Description
False
  • string
True
  • string

EffectiveConnectivityConfiguration

网络管理器有效的连接配置

Name Type Description
configurationGroups

有效的配置组。

id
  • string

连接配置 ID。

properties.appliesToGroups

用于配置的组

properties.connectivityTopology

连接拓扑类型。

properties.deleteExistingPeering

如果需要删除当前的现有对等互连,则标记。

properties.description
  • string

连接配置的说明。

properties.hubs

hubItems 列表

properties.isGlobal

如果支持全局网格,则标记。

properties.provisioningState

连接配置资源的预配状态。

GroupConnectivity

组连接类型。

Name Type Description
DirectlyConnected
  • string
None
  • string

Hub

中心项。

Name Type Description
resourceId
  • string

资源 ID。

resourceType
  • string

资源类型。

IsGlobal

如果支持全局网格,则标记。

Name Type Description
False
  • string
True
  • string

NetworkManagerEffectiveConnectivityConfigurationListResult

列出 networkManagerEffectiveConnectivityConfiguration 的请求的结果。 它包含组列表和 skiptoken 以获取下一组结果。

Name Type Description
skipToken
  • string

如果存在,可以将该值传递给后续查询调用 (以及当前请求中使用的相同查询和范围,) 检索下一页数据。

value

获取 NetworkManagerEffectiveConnectivityConfiguration 的页面

ProvisioningState

当前预配状态。

Name Type Description
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

QueryRequestOptions

查询请求选项

Name Type Description
skipToken
  • string

如果存在,可以将该值传递给后续查询调用 (以及当前请求中使用的相同查询和范围,) 检索下一页数据。

UseHubGateway

如果需要使用中心网关,则标记。

Name Type Description
False
  • string
True
  • string