List deviceLinks

Namespace: microsoft.graph.networkaccess

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Retrieve a list of device links associated with a specific remote network.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permission	Higher privileged permissions
Delegated (work or school account)	Not supported.	Not supported.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

To read the configuration, the calling user must also be assigned at least one of the following Microsoft Entra roles.

• Global Reader
• Global Secure Access Administrator
• Security Administrator

HTTP request

GET /networkAccess/connectivity/remoteNetworks/{remoteNetworkId}/deviceLinks

Optional query parameters

This method supports the $expand OData query parameter to help customize the response.

Request headers

Name	Description
Authorization	Bearer {token}. Required.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of microsoft.graph.networkaccess.deviceLink objects in the response body.

Examples

Request

The following is an example of a request.

GET hhttps://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks/4ecfc62c-ec85-42fd-af37-5a93c7deb1d9/deviceLinks

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks('4ecfc62c-ec85-42fd-af37-5a93c7deb1d9')/deviceLinks",
    "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET networkAccess/connectivity/remoteNetworks('<guid>')/deviceLinks?$select=bandwidthCapacityInMbps,bgpConfiguration",
    "value": [
        {
            "id": "109376bf-6dc7-4183-ab11-4a1206fb5e90",
            "name": "VNG",
            "ipAddress": "20.172.65.16",
            "bandwidthCapacityInMbps": "mbps500",
            "deviceVendor": "other",
            "lastModifiedDateTime": "2024-01-17T20:59:13Z",
            "bgpConfiguration": {
                "localIpAddress": "192.168.1.2",
                "peerIpAddress": "10.0.2.5",
                "asn": 65533
            },
            "redundancyConfiguration": {
                "zoneLocalIpAddress": "192.168.1.3",
                "redundancyTier": "zoneRedundancy"
            },
            "tunnelConfiguration": {
                "@odata.type": "#microsoft.graph.networkaccess.tunnelConfigurationIKEv2Default",
                "preSharedKey": "test123"
            }
        }
    ]
}