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.
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 permissions
Higher privileged permissions
Delegated (work or school account)
NetworkAccess.ReadWrite.All
Not available.
Delegated (personal Microsoft account)
Not supported.
Not supported.
Application
NetworkAccess.ReadWrite.All
Not available.
To make changes, the calling user must also be assigned at least one of the following Microsoft Entra roles.
Global Secure Access Administrator
Security Administrator
HTTP request
POST /networkAccess/connectivity/branches/{branchSiteId}/deviceLinks
You can specify the following properties when creating a deviceLink.
Property
Type
Description
name
String
The name or identifier associated with a device link. Required.
ipAddress
String
The IP address associated with a device link. Required.
deviceVendor
microsoft.graph.networkaccess.deviceVendor
The vendor or manufacturer of the device associated with a device link. The possible values are: barracudaNetworks, checkPoint, ciscoMeraki, citrix, fortinet, hpeAruba, netFoundry, nuage, openSystems, paloAltoNetworks, riverbedTechnology, silverPeak, vmWareSdWan, versa, other. Required.
lastModifiedDateTime
DateTimeOffset
The date and time when the device link was last modified. Required.
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models.Networkaccess;
var requestBody = new DeviceLink
{
Name = "device link 1",
IpAddress = "24.123.22.168",
DeviceVendor = DeviceVendor.BarracudaNetworks,
BandwidthCapacityInMbps = BandwidthCapacityInMbps.Mbps250,
BgpConfiguration = new BgpConfiguration
{
LocalIpAddress = "1.128.24.22",
PeerIpAddress = "1.128.24.28",
Asn = 4,
},
RedundancyConfiguration = new RedundancyConfiguration
{
ZoneLocalIpAddress = "1.128.23.20",
RedundancyTier = RedundancyTier.ZoneRedundancy,
},
TunnelConfiguration = new TunnelConfiguration
{
OdataType = "microsoft.graph.networkAccess.tunnelConfigurationIKEv2Default",
PreSharedKey = "/microsoft/keyVault/placeholder",
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.NetworkAccess.Connectivity.Branches["{branchSite-id}"].DeviceLinks.PostAsync(requestBody);
Important
Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta network-access connectivity branches device-links create --branch-site-id {branchSite-id} --body '{\
"name": "device link 1",\
"ipAddress": "24.123.22.168",\
"deviceVendor": "intel",\
"bandwidthCapacityInMbps": "mbps250",\
"bgpConfiguration":\
{\
"localIpAddress": "1.128.24.22",\
"peerIpAddress": "1.128.24.28",\
"asn": 4\
},\
"redundancyConfiguration":\
{\
"zoneLocalIpAddress": "1.128.23.20",\
"redundancyTier": "zoneRedundancy"\
},\
"tunnelConfiguration":\
{\
"@odata.type": "microsoft.graph.networkAccess.tunnelConfigurationIKEv2Default",\
"preSharedKey": "/microsoft/keyVault/placeholder"\
}\
}\
'
Important
Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.
Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.models.networkaccess.DeviceLink deviceLink = new com.microsoft.graph.beta.models.networkaccess.DeviceLink();
deviceLink.setName("device link 1");
deviceLink.setIpAddress("24.123.22.168");
deviceLink.setDeviceVendor(com.microsoft.graph.beta.models.networkaccess.DeviceVendor.BarracudaNetworks);
deviceLink.setBandwidthCapacityInMbps(com.microsoft.graph.beta.models.networkaccess.BandwidthCapacityInMbps.Mbps250);
com.microsoft.graph.beta.models.networkaccess.BgpConfiguration bgpConfiguration = new com.microsoft.graph.beta.models.networkaccess.BgpConfiguration();
bgpConfiguration.setLocalIpAddress("1.128.24.22");
bgpConfiguration.setPeerIpAddress("1.128.24.28");
bgpConfiguration.setAsn(4);
deviceLink.setBgpConfiguration(bgpConfiguration);
com.microsoft.graph.beta.models.networkaccess.RedundancyConfiguration redundancyConfiguration = new com.microsoft.graph.beta.models.networkaccess.RedundancyConfiguration();
redundancyConfiguration.setZoneLocalIpAddress("1.128.23.20");
redundancyConfiguration.setRedundancyTier(com.microsoft.graph.beta.models.networkaccess.RedundancyTier.ZoneRedundancy);
deviceLink.setRedundancyConfiguration(redundancyConfiguration);
com.microsoft.graph.beta.models.networkaccess.TunnelConfiguration tunnelConfiguration = new com.microsoft.graph.beta.models.networkaccess.TunnelConfiguration();
tunnelConfiguration.setOdataType("microsoft.graph.networkAccess.tunnelConfigurationIKEv2Default");
tunnelConfiguration.setPreSharedKey("/microsoft/keyVault/placeholder");
deviceLink.setTunnelConfiguration(tunnelConfiguration);
com.microsoft.graph.models.networkaccess.DeviceLink result = graphClient.networkAccess().connectivity().branches().byBranchSiteId("{branchSite-id}").deviceLinks().post(deviceLink);
Important
Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.
Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\DeviceLink;
use Microsoft\Graph\Generated\Models\BgpConfiguration;
use Microsoft\Graph\Generated\Models\RedundancyConfiguration;
use Microsoft\Graph\Generated\Models\TunnelConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new DeviceLink();
$requestBody->setName('device link 1');
$requestBody->setIpAddress('24.123.22.168');
$requestBody->setDeviceVendor(new DeviceVendor('intel'));
$requestBody->setBandwidthCapacityInMbps(new BandwidthCapacityInMbps('mbps250'));
$bgpConfiguration = new BgpConfiguration();
$bgpConfiguration->setLocalIpAddress('1.128.24.22');
$bgpConfiguration->setPeerIpAddress('1.128.24.28');
$bgpConfiguration->setAsn(4);
$requestBody->setBgpConfiguration($bgpConfiguration);
$redundancyConfiguration = new RedundancyConfiguration();
$redundancyConfiguration->setZoneLocalIpAddress('1.128.23.20');
$redundancyConfiguration->setRedundancyTier(new RedundancyTier('zoneRedundancy'));
$requestBody->setRedundancyConfiguration($redundancyConfiguration);
$tunnelConfiguration = new TunnelConfiguration();
$tunnelConfiguration->setOdataType('microsoft.graph.networkAccess.tunnelConfigurationIKEv2Default');
$tunnelConfiguration->setPreSharedKey('/microsoft/keyVault/placeholder');
$requestBody->setTunnelConfiguration($tunnelConfiguration);
$result = $graphServiceClient->networkAccess()->connectivity()->branches()->byBranchSiteId('branchSite-id')->deviceLinks()->post($requestBody)->wait();
Important
Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.
from msgraph import GraphServiceClient
from msgraph.generated.models.device_link import DeviceLink
from msgraph.generated.models.bgp_configuration import BgpConfiguration
from msgraph.generated.models.redundancy_configuration import RedundancyConfiguration
from msgraph.generated.models.tunnel_configuration import TunnelConfiguration
graph_client = GraphServiceClient(credentials, scopes)
request_body = DeviceLink(
name = "device link 1",
ip_address = "24.123.22.168",
device_vendor = DeviceVendor.BarracudaNetworks,
bandwidth_capacity_in_mbps = BandwidthCapacityInMbps.Mbps250,
bgp_configuration = BgpConfiguration(
local_ip_address = "1.128.24.22",
peer_ip_address = "1.128.24.28",
asn = 4,
),
redundancy_configuration = RedundancyConfiguration(
zone_local_ip_address = "1.128.23.20",
redundancy_tier = RedundancyTier.ZoneRedundancy,
),
tunnel_configuration = TunnelConfiguration(
odata_type = "microsoft.graph.networkAccess.tunnelConfigurationIKEv2Default",
pre_shared_key = "/microsoft/keyVault/placeholder",
),
)
result = await graph_client.network_access.connectivity.branches.by_branch_site_id('branchSite-id').device_links.post(request_body)
Important
Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.