Vpn Connections - Get
Извлекает сведения о vpn-подключении.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}?api-version=2023-09-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
connection
|
path | True |
string |
Имя VPN-подключения. |
gateway
|
path | True |
string |
Имя шлюза. |
resource
|
path | True |
string |
Имя группы ресурсов VpnGateway. |
subscription
|
path | True |
string |
Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы. |
api-version
|
query | True |
string |
Версия API клиента. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Запрос выполнен успешно. Возвращает сведения о vpn-подключении. |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
VpnConnectionGet
Sample Request
Sample Response
{
"name": "vpnConnection1",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"properties": {
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"enableInternetSecurity": false,
"ingressBytesTransferred": 0,
"egressBytesTransferred": 0,
"trafficSelectorPolicies": [],
"vpnLinkConnections": [
{
"name": "Connection-Link1",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"properties": {
"provisioningState": "Succeeded",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
},
"connectionBandwidth": 200,
"ipsecPolicies": [],
"vpnConnectionProtocolType": "IKEv2",
"sharedKey": "key",
"ingressBytesTransferred": 0,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"routingWeight": 0,
"vpnLinkConnectionMode": "ResponderOnly"
}
},
{
"name": "Connection-Link2",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2",
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"properties": {
"provisioningState": "Succeeded",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"
},
"connectionBandwidth": 200,
"ipsecPolicies": [],
"vpnConnectionProtocolType": "IKEv2",
"sharedKey": "key",
"ingressBytesTransferred": 0,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"routingWeight": 0,
"vpnLinkConnectionMode": "InitiatorOnly"
}
}
],
"routingConfiguration": {
"associatedRouteTable": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
},
"propagatedRouteTables": {
"labels": [
"label1",
"label2"
],
"ids": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"
}
]
},
"inboundRouteMap": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"
},
"outboundRouteMap": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"
}
}
}
}
Определения
Имя | Описание |
---|---|
Cloud |
Ответ об ошибке от службы. |
Cloud |
Ответ об ошибке от службы. |
Dh |
Группы DH, используемые на этапе 1 IKE для начального уровня безопасности. |
Gateway |
GatewayCustomBgpIpAddressIpConfiguration для подключения шлюза виртуальной сети. |
Ike |
Алгоритм шифрования IKE (этап 2 IKE). |
Ike |
Алгоритм целостности IKE (этап 2 IKE). |
Ipsec |
Алгоритм шифрования IPSec (этап 1 IKE). |
Ipsec |
Алгоритм целостности IPSec (этап 1 IKE). |
Ipsec |
Конфигурация политики IPSec для подключения шлюза виртуальной сети. |
Pfs |
Группы Pfs, используемые на этапе 2 IKE для нового дочернего sa. |
Propagated |
Список таблиц RouteTable для объявления маршрутов. |
Provisioning |
Текущее состояние подготовки. |
Routing |
Конфигурация маршрутизации, указывающая связанные и распространяемые таблицы маршрутов для этого подключения. |
Static |
Список всех статических маршрутов. |
Static |
Конфигурация статических маршрутов в этом HubVnetConnectionНастройка статических маршрутов в этом HubVnetConnection. |
Sub |
Ссылка на другой подресурс. |
Traffic |
Политика выбора трафика для подключения шлюза виртуальной сети. |
Virtual |
Протокол подключения, используемый для этого подключения. |
Vnet |
Параметр, определяющий, пропускается ли сетевой модуль в периферийной виртуальной сети для трафика с назначением в периферийной виртуальной сети. |
Vnet |
Список маршрутов, управляющих маршрутизацией из VirtualHub в подключение к виртуальной сети. |
Vpn |
Ресурс VpnConnection. |
Vpn |
Текущее состояние VPN-подключения. |
Vpn |
Режим подключения vpn-канала. |
Vpn |
Ресурс VpnSiteLinkConnection. |
CloudError
Ответ об ошибке от службы.
Имя | Тип | Описание |
---|---|---|
error |
Текст ошибки облака. |
CloudErrorBody
Ответ об ошибке от службы.
Имя | Тип | Описание |
---|---|---|
code |
string |
Идентификатор ошибки. Коды инвариантны и предназначены для программного использования. |
details |
Список дополнительных сведений об ошибке. |
|
message |
string |
Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе. |
target |
string |
Целевой объект конкретной ошибки. Например, имя свойства в ошибке. |
DhGroup
Группы DH, используемые на этапе 1 IKE для начального уровня безопасности.
Имя | Тип | Описание |
---|---|---|
DHGroup1 |
string |
|
DHGroup14 |
string |
|
DHGroup2 |
string |
|
DHGroup2048 |
string |
|
DHGroup24 |
string |
|
ECP256 |
string |
|
ECP384 |
string |
|
None |
string |
GatewayCustomBgpIpAddressIpConfiguration
GatewayCustomBgpIpAddressIpConfiguration для подключения шлюза виртуальной сети.
Имя | Тип | Описание |
---|---|---|
customBgpIpAddress |
string |
Пользовательский объект BgpPeeringAddress, принадлежащий ipconfigurationId. |
ipConfigurationId |
string |
IpconfigurationId ipconfiguration, который принадлежит шлюзу. |
IkeEncryption
Алгоритм шифрования IKE (этап 2 IKE).
Имя | Тип | Описание |
---|---|---|
AES128 |
string |
|
AES192 |
string |
|
AES256 |
string |
|
DES |
string |
|
DES3 |
string |
|
GCMAES128 |
string |
|
GCMAES256 |
string |
IkeIntegrity
Алгоритм целостности IKE (этап 2 IKE).
Имя | Тип | Описание |
---|---|---|
GCMAES128 |
string |
|
GCMAES256 |
string |
|
MD5 |
string |
|
SHA1 |
string |
|
SHA256 |
string |
|
SHA384 |
string |
IpsecEncryption
Алгоритм шифрования IPSec (этап 1 IKE).
Имя | Тип | Описание |
---|---|---|
AES128 |
string |
|
AES192 |
string |
|
AES256 |
string |
|
DES |
string |
|
DES3 |
string |
|
GCMAES128 |
string |
|
GCMAES192 |
string |
|
GCMAES256 |
string |
|
None |
string |
IpsecIntegrity
Алгоритм целостности IPSec (этап 1 IKE).
Имя | Тип | Описание |
---|---|---|
GCMAES128 |
string |
|
GCMAES192 |
string |
|
GCMAES256 |
string |
|
MD5 |
string |
|
SHA1 |
string |
|
SHA256 |
string |
IpsecPolicy
Конфигурация политики IPSec для подключения шлюза виртуальной сети.
Имя | Тип | Описание |
---|---|---|
dhGroup |
Группа DH, используемая на этапе 1 IKE для начального sa. |
|
ikeEncryption |
Алгоритм шифрования IKE (этап 2 IKE). |
|
ikeIntegrity |
Алгоритм целостности IKE (этап 2 IKE). |
|
ipsecEncryption |
Алгоритм шифрования IPSec (этап 1 IKE). |
|
ipsecIntegrity |
Алгоритм целостности IPSec (этап 1 IKE). |
|
pfsGroup |
Группа Pfs, используемая на этапе 2 IKE для нового дочернего sa. |
|
saDataSizeKilobytes |
integer |
Размер полезных данных сопоставления безопасности IPSec (также называемого быстрым режимом или этапом 2 SA) в КБ для VPN-туннеля типа "сеть — сеть". |
saLifeTimeSeconds |
integer |
Время существования сопоставления безопасности IPSec (также называемое быстрым режимом или этапом 2 SA) в секундах для VPN-туннеля типа "сеть — сеть". |
PfsGroup
Группы Pfs, используемые на этапе 2 IKE для нового дочернего sa.
Имя | Тип | Описание |
---|---|---|
ECP256 |
string |
|
ECP384 |
string |
|
None |
string |
|
PFS1 |
string |
|
PFS14 |
string |
|
PFS2 |
string |
|
PFS2048 |
string |
|
PFS24 |
string |
|
PFSMM |
string |
PropagatedRouteTable
Список таблиц RouteTable для объявления маршрутов.
Имя | Тип | Описание |
---|---|---|
ids |
Список идентификаторов ресурсов всех таблиц RouteTable. |
|
labels |
string[] |
Список меток. |
ProvisioningState
Текущее состояние подготовки.
Имя | Тип | Описание |
---|---|---|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
RoutingConfiguration
Конфигурация маршрутизации, указывающая связанные и распространяемые таблицы маршрутов для этого подключения.
Имя | Тип | Описание |
---|---|---|
associatedRouteTable |
Идентификатор ресурса RouteTable, связанный с данной routingConfiguration. |
|
inboundRouteMap |
Идентификатор ресурса RouteMap, связанного с данной routingConfiguration для входящие изученные маршруты. |
|
outboundRouteMap |
Идентификатор ресурса ОбъектаRouteMap, связанного с данной конфигурацией маршрутизации для исходящих объявленных маршрутов. |
|
propagatedRouteTables |
Список таблиц RouteTable для объявления маршрутов. |
|
vnetRoutes |
Список маршрутов, управляющих маршрутизацией из VirtualHub в подключение к виртуальной сети. |
StaticRoute
Список всех статических маршрутов.
Имя | Тип | Описание |
---|---|---|
addressPrefixes |
string[] |
Список всех префиксов адресов. |
name |
string |
Имя StaticRoute, уникальное в пределах VnetRoute. |
nextHopIpAddress |
string |
IP-адрес следующего прыжка. |
StaticRoutesConfig
Конфигурация статических маршрутов в этом HubVnetConnectionНастройка статических маршрутов в этом HubVnetConnection.
Имя | Тип | Описание |
---|---|---|
propagateStaticRoutes |
boolean |
Логическое значение, указывающее, распространяется ли автоматически статические маршруты в этом соединении в таблицы маршрутизации, в которые распространяется это соединение. |
vnetLocalRouteOverrideCriteria |
Параметр, определяющий, пропускается ли сетевой модуль в периферийной виртуальной сети для трафика с назначением в периферийной сети. |
SubResource
Ссылка на другой подресурс.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса. |
TrafficSelectorPolicy
Политика выбора трафика для подключения шлюза виртуальной сети.
Имя | Тип | Описание |
---|---|---|
localAddressRanges |
string[] |
Коллекция локальных адресных пространств в формате CIDR. |
remoteAddressRanges |
string[] |
Коллекция удаленных адресных пространств в формате CIDR. |
VirtualNetworkGatewayConnectionProtocol
Протокол подключения, используемый для этого подключения.
Имя | Тип | Описание |
---|---|---|
IKEv1 |
string |
|
IKEv2 |
string |
VnetLocalRouteOverrideCriteria
Параметр, определяющий, пропускается ли сетевой модуль в периферийной виртуальной сети для трафика с назначением в периферийной виртуальной сети.
Имя | Тип | Описание |
---|---|---|
Contains |
string |
|
Equal |
string |
VnetRoute
Список маршрутов, управляющих маршрутизацией из VirtualHub в подключение к виртуальной сети.
Имя | Тип | Описание |
---|---|---|
bgpConnections |
Список ссылок на объекты HubBgpConnection. |
|
staticRoutes |
Список всех статических маршрутов. |
|
staticRoutesConfig |
Настройка статических маршрутов в этом HubVnetConnection. |
VpnConnection
Ресурс VpnConnection.
Имя | Тип | Описание |
---|---|---|
etag |
string |
Уникальная строка, доступная только для чтения, которая изменяется при каждом обновлении ресурса. |
id |
string |
Идентификатор ресурса. |
name |
string |
Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу. |
properties.connectionBandwidth |
integer |
Ожидаемая пропускная способность в Мбит/с. |
properties.connectionStatus |
Состояние подключения. |
|
properties.dpdTimeoutSeconds |
integer |
Время ожидания DPD для VPN-подключения в секундах. |
properties.egressBytesTransferred |
integer |
Переданные байты исходящего трафика. |
properties.enableBgp |
boolean |
Флаг EnableBgp. |
properties.enableInternetSecurity |
boolean |
Включите безопасность в Интернете. |
properties.enableRateLimiting |
boolean |
Флаг EnableBgp. |
properties.ingressBytesTransferred |
integer |
Переданные байты входящего трафика. |
properties.ipsecPolicies |
Политики IPSec, которые будут учитываться этим подключением. |
|
properties.provisioningState |
Состояние подготовки ресурса VPN-подключения. |
|
properties.remoteVpnSite |
Идентификатор подключенного vpn-сайта. |
|
properties.routingConfiguration |
Конфигурация маршрутизации, указывающая связанные и распространяемые таблицы маршрутов для этого подключения. |
|
properties.routingWeight |
integer |
Вес маршрутизации для VPN-подключения. |
properties.sharedKey |
string |
SharedKey для VPN-подключения. |
properties.trafficSelectorPolicies |
Политики выбора трафика, которые будут учитываться этим подключением. |
|
properties.useLocalAzureIpAddress |
boolean |
Используйте локальный IP-адрес Azure для запуска подключения. |
properties.usePolicyBasedTrafficSelectors |
boolean |
Включите селекторы трафика на основе политик. |
properties.vpnConnectionProtocolType |
Протокол подключения, используемый для этого подключения. |
|
properties.vpnLinkConnections |
Список всех подключений vpn-сайта к шлюзу. |
VpnConnectionStatus
Текущее состояние VPN-подключения.
Имя | Тип | Описание |
---|---|---|
Connected |
string |
|
Connecting |
string |
|
NotConnected |
string |
|
Unknown |
string |
VpnLinkConnectionMode
Режим подключения vpn-канала.
Имя | Тип | Описание |
---|---|---|
Default |
string |
|
InitiatorOnly |
string |
|
ResponderOnly |
string |
VpnSiteLinkConnection
Ресурс VpnSiteLinkConnection.
Имя | Тип | Описание |
---|---|---|
etag |
string |
Уникальная строка, доступная только для чтения, которая изменяется при каждом обновлении ресурса. |
id |
string |
Идентификатор ресурса. |
name |
string |
Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу. |
properties.connectionBandwidth |
integer |
Ожидаемая пропускная способность в Мбит/с. |
properties.connectionStatus |
Состояние подключения. |
|
properties.egressBytesTransferred |
integer |
Переданные байты исходящего трафика. |
properties.egressNatRules |
Список исходящих NatRules. |
|
properties.enableBgp |
boolean |
Флаг EnableBgp. |
properties.enableRateLimiting |
boolean |
Флаг EnableBgp. |
properties.ingressBytesTransferred |
integer |
Переданные байты входящего трафика. |
properties.ingressNatRules |
Список объектов NatRules для входящего трафика. |
|
properties.ipsecPolicies |
Политики IPSec, которые будут учитываться этим подключением. |
|
properties.provisioningState |
Состояние подготовки ресурса подключения к vpn-сайту. |
|
properties.routingWeight |
integer |
Вес маршрутизации для VPN-подключения. |
properties.sharedKey |
string |
SharedKey для VPN-подключения. |
properties.useLocalAzureIpAddress |
boolean |
Используйте локальный IP-адрес Azure для запуска подключения. |
properties.usePolicyBasedTrafficSelectors |
boolean |
Включите селекторы трафика на основе политик. |
properties.vpnConnectionProtocolType |
Протокол подключения, используемый для этого подключения. |
|
properties.vpnGatewayCustomBgpAddresses |
vpnGatewayCustomBgpAddresses, используемый этим подключением. |
|
properties.vpnLinkConnectionMode |
Режим подключения vpn-канала. |
|
properties.vpnSiteLink |
Идентификатор ссылки на подключенный vpn-сайт. |
|
type |
string |
Тип ресурса. |