名前空間: microsoft.graph.networkaccess
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
関連付けられたデバイス リンクを含むブランチ サイトを作成します。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
✅ |
❌ |
❌ |
❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。
アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
アクセス許可の種類 |
最小特権アクセス許可 |
より高い特権のアクセス許可 |
委任 (職場または学校のアカウント) |
NetworkAccess.ReadWrite.All |
注意事項なし。 |
委任 (個人用 Microsoft アカウント) |
サポートされていません。 |
サポートされていません。 |
アプリケーション |
NetworkAccess.ReadWrite.All |
注意事項なし。 |
重要
職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーに、サポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 この操作では、次の最小特権ロールがサポートされています。
- グローバル セキュリティで保護されたアクセス管理者
- セキュリティ管理者
HTTP 要求
POST /networkAccess/connectivity/branches/{branchSiteId}/deviceLinks
名前 |
説明 |
Authorization |
ベアラー {token}。 必須です。
認証と認可についての詳細をご覧ください。 |
Content-Type |
application/json. 必須です。 |
要求本文
要求本文で、 microsoft.graph.networkaccess.deviceLink オブジェクトの JSON 表現を指定します。
deviceLink の作成時に、次のプロパティを指定できます。
プロパティ |
型 |
説明 |
name |
String |
デバイス リンクに関連付けられている名前または識別子。 必須です。 |
ipAddress |
String |
デバイス リンクに関連付けられている IP アドレス。 必須です。 |
deviceVendor |
microsoft.graph.networkaccess.deviceVendor |
デバイス リンクに関連付けられているデバイスのベンダーまたは製造元。 使用できる値は、 barracudaNetworks 、 checkPoint 、 ciscoMeraki 、 citrix 、 fortinet 、 hpeAruba 、 netFoundry 、 nuage 、 openSystems 、 paloAltoNetworks 、 riverbedTechnology 、 silverPeak 、 vmWareSdWan 、 versa 、 other です。 必須です。 |
lastModifiedDateTime |
DateTimeOffset |
デバイス リンクが最後に変更された日時。 必須です。 |
tunnelConfiguration |
microsoft.graph.networkaccess.tunnelConfiguration |
デバイス リンクに関連付けられているトンネル構成設定。 必須です。 |
bgpConfiguration |
microsoft.graph.networkaccess.bgpConfiguration |
デバイス リンクに関連付けられている Border Gateway Protocol (BGP) 構成設定。 必須です。 |
応答
成功した場合、このメソッドは応答コード 201 Created
と、応答本文に microsoft.graph.networkaccess.deviceLink オブジェクトを返します。
例
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/beta/networkAccess/connectivity/branches/19a92090-c14e-4cea-a933-27d38f72c4d1/deviceLinks
Content-Type: application/json
{
"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"
}
}
// 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);
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"\
}\
}\
'
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodelsnetworkaccess "github.com/microsoftgraph/msgraph-beta-sdk-go/models/networkaccess"
//other-imports
)
requestBody := graphmodelsnetworkaccess.NewDeviceLink()
name := "device link 1"
requestBody.SetName(&name)
ipAddress := "24.123.22.168"
requestBody.SetIpAddress(&ipAddress)
deviceVendor := graphmodels.INTEL_DEVICEVENDOR
requestBody.SetDeviceVendor(&deviceVendor)
bandwidthCapacityInMbps := graphmodels.MBPS250_BANDWIDTHCAPACITYINMBPS
requestBody.SetBandwidthCapacityInMbps(&bandwidthCapacityInMbps)
bgpConfiguration := graphmodelsnetworkaccess.NewBgpConfiguration()
localIpAddress := "1.128.24.22"
bgpConfiguration.SetLocalIpAddress(&localIpAddress)
peerIpAddress := "1.128.24.28"
bgpConfiguration.SetPeerIpAddress(&peerIpAddress)
asn := int32(4)
bgpConfiguration.SetAsn(&asn)
requestBody.SetBgpConfiguration(bgpConfiguration)
redundancyConfiguration := graphmodelsnetworkaccess.NewRedundancyConfiguration()
zoneLocalIpAddress := "1.128.23.20"
redundancyConfiguration.SetZoneLocalIpAddress(&zoneLocalIpAddress)
redundancyTier := graphmodels.ZONEREDUNDANCY_REDUNDANCYTIER
redundancyConfiguration.SetRedundancyTier(&redundancyTier)
requestBody.SetRedundancyConfiguration(redundancyConfiguration)
tunnelConfiguration := graphmodelsnetworkaccess.NewTunnelConfiguration()
preSharedKey := "/microsoft/keyVault/placeholder"
tunnelConfiguration.SetPreSharedKey(&preSharedKey)
requestBody.SetTunnelConfiguration(tunnelConfiguration)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
deviceLinks, err := graphClient.NetworkAccess().Connectivity().Branches().ByBranchSiteId("branchSite-id").DeviceLinks().Post(context.Background(), requestBody, nil)
// 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);
const options = {
authProvider,
};
const client = Client.init(options);
const deviceLink = {
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'
}
};
await client.api('/networkAccess/connectivity/branches/19a92090-c14e-4cea-a933-27d38f72c4d1/deviceLinks')
.version('beta')
.post(deviceLink);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Networkaccess\DeviceLink;
use Microsoft\Graph\Beta\Generated\Models\Networkaccess\DeviceVendor;
use Microsoft\Graph\Beta\Generated\Models\Networkaccess\BandwidthCapacityInMbps;
use Microsoft\Graph\Beta\Generated\Models\Networkaccess\BgpConfiguration;
use Microsoft\Graph\Beta\Generated\Models\Networkaccess\RedundancyConfiguration;
use Microsoft\Graph\Beta\Generated\Models\Networkaccess\RedundancyTier;
use Microsoft\Graph\Beta\Generated\Models\Networkaccess\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();
Import-Module Microsoft.Graph.Beta.NetworkAccess
$params = @{
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"
}
}
New-MgBetaNetworkAccessConnectivityBranchDeviceLink -BranchSiteId $branchSiteId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.networkaccess.device_link import DeviceLink
from msgraph_beta.generated.models.device_vendor import DeviceVendor
from msgraph_beta.generated.models.bandwidth_capacity_in_mbps import BandwidthCapacityInMbps
from msgraph_beta.generated.models.networkaccess.bgp_configuration import BgpConfiguration
from msgraph_beta.generated.models.networkaccess.redundancy_configuration import RedundancyConfiguration
from msgraph_beta.generated.models.redundancy_tier import RedundancyTier
from msgraph_beta.generated.models.networkaccess.tunnel_configuration import TunnelConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
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)
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.networkaccess.deviceLink",
"id": "2f183529-b8d9-c6f1-0373-3a6beee36e38",
"name": "device link 1",
"ipAddress": "24.123.22.168",
"deviceVendor": "intel",
"bandwidthCapacityInMbps": "mbps250",
"redundancyConfiguration_redundancyTier": "zoneRedundancy",
"tunnelConfiguration_type": "microsoft.graph.networkAccess.tunnelConfigurationIKEv2Default",
"tunnelConfiguration_preSharedKey": "/microsoft/keyVault/placeholder"
}