Freigeben über


Vpn Site Links - Get

Ruft die Details eines VPN-Standortlinks ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks/{vpnSiteLinkName}?api-version=2024-05-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Ressourcengruppenname der VpnSite.

subscriptionId
path True

string

Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

vpnSiteLinkName
path True

string

Der Name des abzurufenden VpnSiteLinks.

vpnSiteName
path True

string

Der Name der VpnSite.

api-version
query True

string

Client-API-Version.

Antworten

Name Typ Beschreibung
200 OK

VpnSiteLink

Anforderung erfolgreich. Gibt die Details des abgerufenen VpnSiteLink zurück.

Other Status Codes

CloudError

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

VpnSiteGet

Beispielanforderung

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1?api-version=2024-05-01

Beispiel für eine Antwort

{
  "name": "vpnSiteLink1",
  "type": "Microsoft.Network/vpnSites/vpnSiteLinks",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "properties": {
    "provisioningState": "Succeeded",
    "ipAddress": "50.50.50.56",
    "linkProperties": {
      "linkSpeedInMbps": 0
    },
    "bgpProperties": {
      "bgpPeeringAddress": "192.168.0.0",
      "asn": 1234
    }
  }
}

Definitionen

Name Beschreibung
CloudError

Eine Fehlerantwort des Diensts.

CloudErrorBody

Eine Fehlerantwort des Diensts.

ProvisioningState

Der aktuelle Bereitstellungsstatus.

VpnLinkBgpSettings

Details zu den BGP-Einstellungen für einen Link.

VpnLinkProviderProperties

Liste der Eigenschaften eines Linkanbieters.

VpnSiteLink

VpnSiteLink-Ressource.

CloudError

Eine Fehlerantwort des Diensts.

Name Typ Beschreibung
error

CloudErrorBody

Cloudfehlertext.

CloudErrorBody

Eine Fehlerantwort des Diensts.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.

details

CloudErrorBody[]

Eine Liste mit zusätzlichen Details zum Fehler.

message

string

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.

target

string

Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

ProvisioningState

Der aktuelle Bereitstellungsstatus.

Wert Beschreibung
Deleting
Failed
Succeeded
Updating

VpnLinkBgpSettings

Details zu den BGP-Einstellungen für einen Link.

Name Typ Beschreibung
asn

integer (int64)

Der ASN des BGP-Sprechers.

bgpPeeringAddress

string

Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Lautsprechers.

VpnLinkProviderProperties

Liste der Eigenschaften eines Linkanbieters.

Name Typ Beschreibung
linkProviderName

string

Name des Linkanbieters.

linkSpeedInMbps

integer (int32)

Verbindungsgeschwindigkeit.

VpnSiteLink-Ressource.

Name Typ Beschreibung
etag

string

Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.

id

string

Ressourcen-ID.

name

string

Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.

properties.bgpProperties

VpnLinkBgpSettings

Der Satz von bgp-Eigenschaften.

properties.fqdn

string

FQDN von vpn-site-link.

properties.ipAddress

string

Die IP-Adresse für den vpn-site-link.

properties.linkProperties

VpnLinkProviderProperties

Die Eigenschaften des Verknüpfungsanbieters.

properties.provisioningState

ProvisioningState

Der Bereitstellungsstatus der VPN-Standortverknüpfungsressource.

type

string

Ressourcentyp.