Sdílet prostřednictvím


Vpn Connections - Get

Načte podrobnosti o připojení VPN.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
connectionName
path True

string

Název připojení VPN.

gatewayName
path True

string

Název brány.

resourceGroupName
path True

string

Název skupiny prostředků vpnGateway.

subscriptionId
path True

string

Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.

api-version
query True

string

Verze rozhraní API klienta.

Odpovědi

Name Typ Description
200 OK

VpnConnection

Žádost byla úspěšná. Vrátí podrobnosti o připojení VPN.

Other Status Codes

CloudError

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

VpnConnectionGet

Ukázkový požadavek

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1?api-version=2024-05-01

Ukázková odpověď

{
  "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"
      }
    }
  }
}

Definice

Name Description
CloudError

Chybová odpověď ze služby.

CloudErrorBody

Chybová odpověď ze služby.

DhGroup

Skupiny DH používané ve fázi IKE 1 pro počáteční přidružení zabezpečení.

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration pro připojení brány virtuální sítě.

IkeEncryption

Šifrovací algoritmus IKE (fáze IKE 2).

IkeIntegrity

Algoritmus integrity protokolu IKE (fáze IKE 2).

IpsecEncryption

Šifrovací algoritmus IPSec (fáze IKE 1).

IpsecIntegrity

Algoritmus integrity protokolu IPSec (fáze IKE 1).

IpsecPolicy

Konfigurace zásad PROTOKOLU IPSec pro připojení brány virtuální sítě.

PfsGroup

Skupiny Pfs použité ve fázi IKE 2 pro nové podřízené přidružení zabezpečení.

PropagatedRouteTable

Seznam směrovacích tabulek pro inzerování tras.

ProvisioningState

Aktuální stav zřizování.

RoutingConfiguration

Konfigurace směrování označující přidružené a šířené směrovací tabulky pro toto připojení

StaticRoute

Seznam všech statických tras

StaticRoutesConfig

Konfigurace statických tras v této hubVnetConnectionConfiguration pro statické trasy v tomto HubVnetConnection.

SubResource

Odkaz na jiný podsourc.

TrafficSelectorPolicy

Zásady selektoru provozu pro připojení brány virtuální sítě.

VirtualNetworkGatewayConnectionProtocol

Protokol připojení použitý pro toto připojení.

VnetLocalRouteOverrideCriteria

Parametr určující, jestli se síťové virtuální zařízení v paprskové virtuální síti vynechá pro provoz s cílem v paprskové virtuální síti.

VnetRoute

Seznam tras, které řídí směrování z VirtualHubu do připojení k virtuální síti

VpnConnection

Prostředek VpnConnection.

VpnConnectionStatus

Aktuální stav připojení VPN.

VpnLinkConnectionMode

Režim připojení vpn link.

VpnSiteLinkConnection

Prostředek VpnSiteLinkConnection

CloudError

Chybová odpověď ze služby.

Name Typ Description
error

CloudErrorBody

Text chyby cloudu.

CloudErrorBody

Chybová odpověď ze služby.

Name Typ Description
code

string

Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.

details

CloudErrorBody[]

Seznam dalších podrobností o chybě

message

string

Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.

target

string

Cíl konkrétní chyby. Například název vlastnosti v chybě.

DhGroup

Skupiny DH používané ve fázi IKE 1 pro počáteční přidružení zabezpečení.

Name Typ Description
DHGroup1

string

DHGroup14

string

DHGroup2

string

DHGroup2048

string

DHGroup24

string

ECP256

string

ECP384

string

None

string

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration pro připojení brány virtuální sítě.

Name Typ Description
customBgpIpAddress

string

Vlastní BgpPeeringAddress, která patří ipconfigurationId.

ipConfigurationId

string

IPconfigurationId ipconfiguration, která patří k bráně.

IkeEncryption

Šifrovací algoritmus IKE (fáze IKE 2).

Name Typ Description
AES128

string

AES192

string

AES256

string

DES

string

DES3

string

GCMAES128

string

GCMAES256

string

IkeIntegrity

Algoritmus integrity protokolu IKE (fáze IKE 2).

Name Typ Description
GCMAES128

string

GCMAES256

string

MD5

string

SHA1

string

SHA256

string

SHA384

string

IpsecEncryption

Šifrovací algoritmus IPSec (fáze IKE 1).

Name Typ Description
AES128

string

AES192

string

AES256

string

DES

string

DES3

string

GCMAES128

string

GCMAES192

string

GCMAES256

string

None

string

IpsecIntegrity

Algoritmus integrity protokolu IPSec (fáze IKE 1).

Name Typ Description
GCMAES128

string

GCMAES192

string

GCMAES256

string

MD5

string

SHA1

string

SHA256

string

IpsecPolicy

Konfigurace zásad PROTOKOLU IPSec pro připojení brány virtuální sítě.

Name Typ Description
dhGroup

DhGroup

Skupina DH použitá ve fázi IKE 1 pro počáteční přidružení služby.

ikeEncryption

IkeEncryption

Šifrovací algoritmus IKE (fáze IKE 2).

ikeIntegrity

IkeIntegrity

Algoritmus integrity protokolu IKE (fáze IKE 2).

ipsecEncryption

IpsecEncryption

Šifrovací algoritmus IPSec (fáze IKE 1).

ipsecIntegrity

IpsecIntegrity

Algoritmus integrity protokolu IPSec (fáze IKE 1).

pfsGroup

PfsGroup

Skupina Pfs použitá ve fázi IKE 2 pro nové podřízené přidružení služby.

saDataSizeKilobytes

integer

Velikost datové části přidružení zabezpečení IPSec (označovaná také jako rychlý režim nebo přidružení zabezpečení fáze 2) v kB pro tunel VPN typu site-to-site.

saLifeTimeSeconds

integer

Životnost přidružení zabezpečení IPSec (označovaná také jako rychlý režim nebo přidružení zabezpečení fáze 2) v sekundách pro tunel VPN typu site-to-site.

PfsGroup

Skupiny Pfs použité ve fázi IKE 2 pro nové podřízené přidružení zabezpečení.

Name Typ Description
ECP256

string

ECP384

string

None

string

PFS1

string

PFS14

string

PFS2

string

PFS2048

string

PFS24

string

PFSMM

string

PropagatedRouteTable

Seznam směrovacích tabulek pro inzerování tras.

Name Typ Description
ids

SubResource[]

Seznam ID prostředků všech směrovacích tabulek

labels

string[]

Seznam popisků

ProvisioningState

Aktuální stav zřizování.

Name Typ Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

RoutingConfiguration

Konfigurace směrování označující přidružené a šířené směrovací tabulky pro toto připojení

Name Typ Description
associatedRouteTable

SubResource

Id prostředku RouteTable přidružené k této RoutingConfiguration.

inboundRouteMap

SubResource

ID prostředku objektu RouteMap přidruženého k této směrování RoutingConfiguration pro příchozí naučené trasy.

outboundRouteMap

SubResource

ID prostředku mapyRoute přidružené k této RoutingConfiguration pro odchozí inzerované trasy.

propagatedRouteTables

PropagatedRouteTable

Seznam směrovacích tabulek pro inzerování tras.

vnetRoutes

VnetRoute

Seznam tras, které řídí směrování z VirtualHubu do připojení k virtuální síti

StaticRoute

Seznam všech statických tras

Name Typ Description
addressPrefixes

string[]

Seznam všech předpon adres

name

string

Název StaticRoute, který je jedinečný v rámci virtuální sítěRoute.

nextHopIpAddress

string

IP adresa dalšího segmentu směrování.

StaticRoutesConfig

Konfigurace statických tras v této hubVnetConnectionConfiguration pro statické trasy v tomto HubVnetConnection.

Name Typ Description
propagateStaticRoutes

boolean

Logická hodnota označující, jestli se statické trasy v tomto připojení automaticky rozšíří do směrovacích tabulek, do kterých se toto připojení rozšíří.

vnetLocalRouteOverrideCriteria

VnetLocalRouteOverrideCriteria

Parametr určující, jestli je síťové virtuální zařízení v paprskové virtuální síti vynecháno pro provoz s cílem v paprsku.

SubResource

Odkaz na jiný podsourc.

Name Typ Description
id

string

ID prostředku.

TrafficSelectorPolicy

Zásady selektoru provozu pro připojení brány virtuální sítě.

Name Typ Description
localAddressRanges

string[]

Kolekce místních adresních prostorů ve formátu CIDR.

remoteAddressRanges

string[]

Kolekce vzdálených adresních prostorů ve formátu CIDR.

VirtualNetworkGatewayConnectionProtocol

Protokol připojení použitý pro toto připojení.

Name Typ Description
IKEv1

string

IKEv2

string

VnetLocalRouteOverrideCriteria

Parametr určující, jestli se síťové virtuální zařízení v paprskové virtuální síti vynechá pro provoz s cílem v paprskové virtuální síti.

Name Typ Description
Contains

string

Equal

string

VnetRoute

Seznam tras, které řídí směrování z VirtualHubu do připojení k virtuální síti

Name Typ Description
bgpConnections

SubResource[]

Seznam odkazů na objekty HubBgpConnection.

staticRoutes

StaticRoute[]

Seznam všech statických tras

staticRoutesConfig

StaticRoutesConfig

Konfigurace statických tras v tomto hubVnetConnectionu

VpnConnection

Prostředek VpnConnection.

Name Typ Description
etag

string

Jedinečný řetězec jen pro čtení, který se změní při každé aktualizaci prostředku.

id

string

ID prostředku.

name

string

Název prostředku, který je jedinečný v rámci skupiny prostředků. Tento název lze použít pro přístup k prostředku.

properties.connectionBandwidth

integer

Očekávaná šířka pásma v MBPS

properties.connectionStatus

VpnConnectionStatus

Stav připojení.

properties.dpdTimeoutSeconds

integer

Časový limit DPD v sekundách pro připojení VPN

properties.egressBytesTransferred

integer

Odchozí bajty převedené.

properties.enableBgp

boolean

Příznak EnableBgp

properties.enableInternetSecurity

boolean

Povolte zabezpečení internetu.

properties.enableRateLimiting

boolean

Příznak EnableBgp

properties.ingressBytesTransferred

integer

Přenesené bajty příchozího přenosu dat.

properties.ipsecPolicies

IpsecPolicy[]

Zásady PROTOKOLU IPSec, které se mají považovat za toto připojení.

properties.provisioningState

ProvisioningState

Stav zřizování prostředku připojení VPN.

properties.remoteVpnSite

SubResource

ID připojené lokality vpn.

properties.routingConfiguration

RoutingConfiguration

Konfigurace směrování označující přidružené a šířené směrovací tabulky v tomto připojení.

properties.routingWeight

integer

Váha směrování pro připojení VPN

properties.sharedKey

string

SharedKey pro připojení vpn.

properties.trafficSelectorPolicies

TrafficSelectorPolicy[]

Zásady selektoru provozu, které má toto připojení zvážit.

properties.useLocalAzureIpAddress

boolean

K zahájení připojení použijte místní ip adresu Azure.

properties.usePolicyBasedTrafficSelectors

boolean

Povolte selektory provozu založené na zásadách.

properties.vpnConnectionProtocolType

VirtualNetworkGatewayConnectionProtocol

Protokol připojení použitý pro toto připojení.

properties.vpnLinkConnections

VpnSiteLinkConnection[]

Seznam všech připojení lokalit vpn k bráně

VpnConnectionStatus

Aktuální stav připojení VPN.

Name Typ Description
Connected

string

Connecting

string

NotConnected

string

Unknown

string

VpnLinkConnectionMode

Režim připojení vpn link.

Name Typ Description
Default

string

InitiatorOnly

string

ResponderOnly

string

VpnSiteLinkConnection

Prostředek VpnSiteLinkConnection

Name Typ Description
etag

string

Jedinečný řetězec jen pro čtení, který se změní při každé aktualizaci prostředku.

id

string

ID prostředku.

name

string

Název prostředku, který je jedinečný v rámci skupiny prostředků. Tento název lze použít pro přístup k prostředku.

properties.connectionBandwidth

integer

Očekávaná šířka pásma v MBPS

properties.connectionStatus

VpnConnectionStatus

Stav připojení.

properties.dpdTimeoutSeconds

integer

Časový limit detekce mrtvých peerů v sekundách pro připojení VpnLink

properties.egressBytesTransferred

integer

Odchozí bajty převedené.

properties.egressNatRules

SubResource[]

Seznam výchozích hodnot NatRules

properties.enableBgp

boolean

Příznak EnableBgp

properties.enableRateLimiting

boolean

Příznak EnableBgp

properties.ingressBytesTransferred

integer

Přenesené bajty příchozího přenosu dat.

properties.ingressNatRules

SubResource[]

Seznam příchozích dat – NatRules

properties.ipsecPolicies

IpsecPolicy[]

Zásady PROTOKOLU IPSec, které se mají považovat za toto připojení.

properties.provisioningState

ProvisioningState

Stav zřizování prostředku připojení propojení lokality VPN.

properties.routingWeight

integer

Váha směrování pro připojení VPN

properties.sharedKey

string

SharedKey pro připojení vpn.

properties.useLocalAzureIpAddress

boolean

K zahájení připojení použijte místní ip adresu Azure.

properties.usePolicyBasedTrafficSelectors

boolean

Povolte selektory provozu založené na zásadách.

properties.vpnConnectionProtocolType

VirtualNetworkGatewayConnectionProtocol

Protokol připojení použitý pro toto připojení.

properties.vpnGatewayCustomBgpAddresses

GatewayCustomBgpIpAddressIpConfiguration[]

vpnGatewayCustomBgpAddresses používané tímto připojením.

properties.vpnLinkConnectionMode

VpnLinkConnectionMode

Režim připojení vpn link.

properties.vpnSiteLink

SubResource

ID propojení připojené lokality vpn.

type

string

Typ prostředku.