Vpn Connections - List By Vpn Gateway

Извлекает все VPN-подключения для определенного VPN-шлюза виртуальной глобальной сети.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections?api-version=2025-07-01

Параметры URI

Имя В Обязательно Тип Описание
gatewayName
path True

string

Имя шлюза.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя нечувствительно к регистру.

subscriptionId
path True

string (uuid)

Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).

api-version
query True

string

minLength: 1

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

ListVpnConnectionsResult

Операция Azure успешно завершена.

Other Status Codes

CloudError

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation выдать себя за учетную запись пользователя

Примеры

VpnConnectionList

Образец запроса

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections?api-version=2025-07-01

Пример ответа

{
  "value": [
    {
      "name": "vpnConnection1",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
      "properties": {
        "egressBytesTransferred": 0,
        "enableInternetSecurity": false,
        "ingressBytesTransferred": 0,
        "provisioningState": "Succeeded",
        "remoteVpnSite": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
        },
        "routingConfiguration": {
          "associatedRouteTable": {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
          },
          "inboundRouteMap": {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"
          },
          "outboundRouteMap": {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"
          },
          "propagatedRouteTables": {
            "ids": [
              {
                "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
              },
              {
                "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"
              },
              {
                "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"
              }
            ],
            "labels": [
              "label1",
              "label2"
            ]
          }
        },
        "trafficSelectorPolicies": [],
        "vpnLinkConnections": [
          {
            "name": "Connection-Link1",
            "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
            "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
            "properties": {
              "connectionBandwidth": 200,
              "egressBytesTransferred": 0,
              "enableBgp": false,
              "enableRateLimiting": false,
              "ingressBytesTransferred": 0,
              "ipsecPolicies": [],
              "provisioningState": "Succeeded",
              "routingWeight": 0,
              "useLocalAzureIpAddress": false,
              "usePolicyBasedTrafficSelectors": false,
              "vpnConnectionProtocolType": "IKEv2",
              "vpnLinkConnectionMode": "Default",
              "vpnSiteLink": {
                "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
              }
            }
          },
          {
            "name": "Connection-Link2",
            "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
            "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2",
            "properties": {
              "connectionBandwidth": 200,
              "egressBytesTransferred": 0,
              "enableBgp": false,
              "enableRateLimiting": false,
              "ingressBytesTransferred": 0,
              "ipsecPolicies": [],
              "provisioningState": "Succeeded",
              "routingWeight": 0,
              "useLocalAzureIpAddress": false,
              "usePolicyBasedTrafficSelectors": false,
              "vpnConnectionProtocolType": "IKEv2",
              "vpnLinkConnectionMode": "Default",
              "vpnSiteLink": {
                "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"
              }
            }
          }
        ]
      }
    }
  ]
}

Определения

Имя Описание
CloudError

Ответ на ошибку службы.

CloudErrorBody

Ответ на ошибку службы.

DhGroup

Группы DH, используемые на этапе IKE 1 для начального sa.

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration для подключения шлюза виртуальной сети.

IkeEncryption

Алгоритм шифрования IKE (этап IKE 2).

IkeIntegrity

Алгоритм целостности IKE (этап IKE 2).

IpsecEncryption

Алгоритм шифрования IPSec (этап IKE 1).

IpsecIntegrity

Алгоритм целостности IPSec (этап IKE 1).

IpsecPolicy

Конфигурация политики IPSec для подключения шлюза виртуальной сети.

ListVpnConnectionsResult

Результат запроса на перечисление всех vpn-подключений к vpn-шлюзу виртуальной глобальной сети. Он содержит список VPN-подключений и URL-адрес nextLink, чтобы получить следующий набор результатов.

PfsGroup

Группы Pfs, используемые на этапе IKE 2 для нового дочернего SA.

PropagatedRouteTable

Список маршрутов для объявления маршрутов.

ProvisioningState

Состояние подготовки ресурса.

RoutingConfiguration

Конфигурация маршрутизации, указывающая связанные и распространяемые таблицы маршрутов для этого подключения.

StaticRoute

Список всех статических маршрутов.

StaticRoutesConfig

Настройка статических маршрутов в этой конфигурации HubVnetConnectionConfiguration для статических маршрутов в этом HubVnetConnection.

SubResource

Ссылка на другой подресурс.

TrafficSelectorPolicy

Политика селектора трафика для подключения шлюза виртуальной сети.

VirtualNetworkGatewayConnectionProtocol

Протокол подключения к шлюзу.

VnetLocalRouteOverrideCriteria

Параметр, определяющий, пропускается ли NVA в периферийной виртуальной сети для трафика с назначением в периферийной виртуальной сети.

VnetRoute

Список маршрутов, которые управляют маршрутизацией из VirtualHub в подключение к виртуальной сети.

VpnConnection

Ресурс VpnConnection.

VpnConnectionStatus

Текущее состояние VPN-соединения.

VpnLinkConnectionMode

Режим подключения vpn-канала.

VpnSiteLinkConnection

Ресурс VpnSiteLinkConnection.

CloudError

Ответ на ошибку службы.

Имя Тип Описание
error

CloudErrorBody

Тело ошибки облака.

CloudErrorBody

Ответ на ошибку службы.

Имя Тип Описание
code

string

Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.

details

CloudErrorBody[]

Список дополнительных сведений об ошибке.

message

string

Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.

target

string

Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

DhGroup

Группы DH, используемые на этапе IKE 1 для начального sa.

Значение Описание
None

Нет

DHGroup1

DHGroup1

DHGroup2

DHGroup2

DHGroup14

DHGroup14

DHGroup2048

DHGroup2048

ECP256

ECP256

ECP384

ECP384

DHGroup24

DHGroup24

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration для подключения шлюза виртуальной сети.

Имя Тип Описание
customBgpIpAddress

string

Пользовательский объект BgpPeeringAddress, принадлежащий IpconfigurationId.

ipConfigurationId

string

IpconfigurationId ipconfiguration, который принадлежит шлюзу.

IkeEncryption

Алгоритм шифрования IKE (этап IKE 2).

Значение Описание
DES

DES

DES3

DES3

AES128

AES128

AES192

АЕС192

AES256

AES256

GCMAES256

GCMAES256

GCMAES128

GCMAES128

IkeIntegrity

Алгоритм целостности IKE (этап IKE 2).

Значение Описание
MD5

MD5

SHA1

SHA1

SHA256

SHA256

SHA384

SHA384

GCMAES256

GCMAES256

GCMAES128

GCMAES128

IpsecEncryption

Алгоритм шифрования IPSec (этап IKE 1).

Значение Описание
None

Нет

DES

DES

DES3

DES3

AES128

AES128

AES192

АЕС192

AES256

AES256

GCMAES128

GCMAES128

GCMAES192

GCMAES192

GCMAES256

GCMAES256

IpsecIntegrity

Алгоритм целостности IPSec (этап IKE 1).

Значение Описание
MD5

MD5

SHA1

SHA1

SHA256

SHA256

GCMAES128

GCMAES128

GCMAES192

GCMAES192

GCMAES256

GCMAES256

IpsecPolicy

Конфигурация политики IPSec для подключения шлюза виртуальной сети.

Имя Тип Описание
dhGroup

DhGroup

Группа DH, используемая на этапе IKE 1 для начального sa.

ikeEncryption

IkeEncryption

Алгоритм шифрования IKE (этап IKE 2).

ikeIntegrity

IkeIntegrity

Алгоритм целостности IKE (этап IKE 2).

ipsecEncryption

IpsecEncryption

Алгоритм шифрования IPSec (этап IKE 1).

ipsecIntegrity

IpsecIntegrity

Алгоритм целостности IPSec (этап IKE 1).

pfsGroup

PfsGroup

Группа Pfs, используемая на этапе IKE 2 для нового дочернего SA.

saDataSizeKilobytes

integer (int32)

Размер полезных данных IPSec (также называемый быстрым режимом или этапом 2 SA) в КБ для сайта vpn-туннеля.

saLifeTimeSeconds

integer (int32)

Связь безопасности IPSec (также называемая быстрым режимом или этапом 2 SA) в секундах для сайта vpn-туннеля сайта.

ListVpnConnectionsResult

Результат запроса на перечисление всех vpn-подключений к vpn-шлюзу виртуальной глобальной сети. Он содержит список VPN-подключений и URL-адрес nextLink, чтобы получить следующий набор результатов.

Имя Тип Описание
nextLink

string (uri)

Ссылка на следующую страницу элементов

value

VpnConnection[]

Элементы VpnConnection на этой странице

PfsGroup

Группы Pfs, используемые на этапе IKE 2 для нового дочернего SA.

Значение Описание
None

Нет

PFS1

PFS1

PFS2

PFS2

PFS2048

PFS2048

ECP256

ECP256

ECP384

ECP384

PFS24

PFS24

PFS14

ПФС14

PFSMM

ПФСММ

PropagatedRouteTable

Список маршрутов для объявления маршрутов.

Имя Тип Описание
ids

SubResource[]

Список идентификаторов ресурсов всех маршрутов.

labels

string[]

Список меток.

ProvisioningState

Состояние подготовки ресурса.

Значение Описание
Failed

Неудача

Succeeded

Succeeded

Canceled

Canceled.

Creating

Создавать

Updating

Updating

Deleting

Удаление

RoutingConfiguration

Конфигурация маршрутизации, указывающая связанные и распространяемые таблицы маршрутов для этого подключения.

Имя Тип Описание
associatedRouteTable

SubResource

Идентификатор ресурса RouteTable, связанный с этой конфигурацией маршрутизации.

inboundRouteMap

SubResource

Идентификатор ресурса RouteMap, связанный с этой маршрутизациейConfiguration для входящих наученных маршрутов.

outboundRouteMap

SubResource

Идентификатор ресурса объектаRouteMap, связанного с этой маршрутизациейConfiguration для исходящих объявленных маршрутов.

propagatedRouteTables

PropagatedRouteTable

Список маршрутов для объявления маршрутов.

vnetRoutes

VnetRoute

Список маршрутов, которые управляют маршрутизацией из VirtualHub в подключение к виртуальной сети.

StaticRoute

Список всех статических маршрутов.

Имя Тип Описание
addressPrefixes

string[]

Список всех префиксов адресов.

name

string

Имя staticRoute, уникальное в виртуальной сети.

nextHopIpAddress

string

Ip-адрес следующего прыжка.

StaticRoutesConfig

Настройка статических маршрутов в этой конфигурации HubVnetConnectionConfiguration для статических маршрутов в этом HubVnetConnection.

Имя Тип Описание
propagateStaticRoutes

boolean

Логическое значение указывает, распространяются ли статические маршруты в этом соединении автоматически на таблицы маршрутов, на которые распространяется это соединение.

vnetLocalRouteOverrideCriteria

VnetLocalRouteOverrideCriteria

Параметр, определяющий, пропускается ли NVA в периферийной виртуальной сети для трафика с назначением в периферийной сети.

SubResource

Ссылка на другой подресурс.

Имя Тип Описание
id

string

Идентификатор ресурса.

TrafficSelectorPolicy

Политика селектора трафика для подключения шлюза виртуальной сети.

Имя Тип Описание
localAddressRanges

string[]

Коллекция локальных адресных пространств в формате CIDR.

remoteAddressRanges

string[]

Коллекция удаленных адресных пространств в формате CIDR.

VirtualNetworkGatewayConnectionProtocol

Протокол подключения к шлюзу.

Значение Описание
IKEv2

IKEv2

IKEv1

IKEv1

VnetLocalRouteOverrideCriteria

Параметр, определяющий, пропускается ли NVA в периферийной виртуальной сети для трафика с назначением в периферийной виртуальной сети.

Значение Описание
Contains

Содержит

Equal

Равно

VnetRoute

Список маршрутов, которые управляют маршрутизацией из VirtualHub в подключение к виртуальной сети.

Имя Тип Описание
bgpConnections

SubResource[]

Список ссылок на объекты HubBgpConnection.

staticRoutes

StaticRoute[]

Список всех статических маршрутов.

staticRoutesConfig

StaticRoutesConfig

Конфигурация статических маршрутов в этом HubVnetConnection.

VpnConnection

Ресурс VpnConnection.

Имя Тип Описание
etag

string

Уникальная строка только для чтения, которая изменяется при обновлении ресурса.

id

string

Идентификатор ресурса.

name

string

Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу.

properties.connectionBandwidth

integer (int32)

Ожидаемая пропускная способность в МБPS.

properties.connectionStatus

VpnConnectionStatus

Состояние подключения.

properties.dpdTimeoutSeconds

integer (int32)

Время ожидания DPD в секундах для vpn-подключения.

properties.egressBytesTransferred

integer (int64)

Передаваемые исходящие байты.

properties.enableBgp

boolean

Флаг EnableBgp.

properties.enableInternetSecurity

boolean

Включите интернет-безопасность.

properties.enableRateLimiting

boolean

Флаг EnableBgp.

properties.ingressBytesTransferred

integer (int64)

Переданные байты входящего трафика.

properties.ipsecPolicies

IpsecPolicy[]

Политики IPSec, которые будут рассматриваться этим подключением.

properties.provisioningState

ProvisioningState

Состояние подготовки ресурса VPN-подключения.

properties.remoteVpnSite

SubResource

Идентификатор подключенного VPN-сайта.

properties.routingConfiguration

RoutingConfiguration

Конфигурация маршрутизации, указывающая связанные и распространяемые таблицы маршрутов для этого подключения.

properties.routingWeight

integer (int32)

Вес маршрутизации для VPN-подключения.

properties.sharedKey

string

Устарело: SharedKey для vpn-соединения. Это больше не используется.

properties.trafficSelectorPolicies

TrafficSelectorPolicy[]

Политики селектора трафика, которые будут рассматриваться этим подключением.

properties.useLocalAzureIpAddress

boolean

Используйте локальный IP-адрес Azure для инициирования подключения.

properties.usePolicyBasedTrafficSelectors

boolean

Включите селекторы трафика на основе политик.

properties.vpnConnectionProtocolType

VirtualNetworkGatewayConnectionProtocol

Протокол подключения, используемый для этого подключения.

properties.vpnLinkConnections

VpnSiteLinkConnection[]

Список всех подключений vpn-сайта к шлюзу.

VpnConnectionStatus

Текущее состояние VPN-соединения.

Значение Описание
Unknown

Неизвестно

Connecting

Подключение

Connected

Подключен

NotConnected

NotConnected

VpnLinkConnectionMode

Режим подключения vpn-канала.

Значение Описание
Default

По умолчанию

ResponderOnly

ResponderOnly

InitiatorOnly

InitiatorOnly

VpnSiteLinkConnection

Ресурс VpnSiteLinkConnection.

Имя Тип Описание
etag

string

Уникальная строка только для чтения, которая изменяется при обновлении ресурса.

id

string

Идентификатор ресурса.

name

string

Имя ресурса.

properties.connectionBandwidth

integer (int32)

Ожидаемая пропускная способность в МБPS.

properties.connectionStatus

VpnConnectionStatus

Состояние подключения.

properties.dpdTimeoutSeconds

integer (int32)

Время ожидания обнаружения недоставленных одноранговых узлов в секундах для подключения VpnLink.

properties.egressBytesTransferred

integer (int64)

Передаваемые исходящие байты.

properties.egressNatRules

SubResource[]

Список исходящих данных NatRules.

properties.enableBgp

boolean

Флаг EnableBgp.

properties.enableRateLimiting

boolean

Флаг EnableBgp.

properties.ingressBytesTransferred

integer (int64)

Переданные байты входящего трафика.

properties.ingressNatRules

SubResource[]

Список входящего трафика NatRules.

properties.ipsecPolicies

IpsecPolicy[]

Политики IPSec, которые будут рассматриваться этим подключением.

properties.provisioningState

ProvisioningState

Состояние подготовки ресурса подключения канала VPN-сайта.

properties.routingWeight

integer (int32)

Вес маршрутизации для VPN-подключения.

properties.sharedKey

string (password)

SharedKey для подключения по vpn-ссылке. Мы больше не будем возвращать sharedKey в ответах API Create/Update/Get/List/UpdateTags VpnGateway/VpnConnection/VpnLinkConnection. Пожалуйста, используйте API 'Vpn Link Connections - List Default Shared Key' для получения VPN-соединения sharedKey.

properties.useLocalAzureIpAddress

boolean

Используйте локальный IP-адрес Azure для инициирования подключения.

properties.usePolicyBasedTrafficSelectors

boolean

Включите селекторы трафика на основе политик.

properties.vpnConnectionProtocolType

VirtualNetworkGatewayConnectionProtocol

Протокол подключения, используемый для этого подключения.

properties.vpnGatewayCustomBgpAddresses

GatewayCustomBgpIpAddressIpConfiguration[]

vpnGatewayCustomBgpAddresses, используемый этим подключением.

properties.vpnLinkConnectionMode

VpnLinkConnectionMode

Режим подключения vpn-канала.

properties.vpnSiteLink

SubResource

Идентификатор ссылки подключенного VPN-сайта.

type

string

Тип ресурса.