Criar deviceLink (preterido)

2024-08-13

Espaço de nomes: microsoft.graph.networkaccess

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Importante

Preterido e descontinuado em breve. Em alternativa, utilize o tipo de recurso remoteNetwork e os respetivos métodos associados.

Crie um site de ramo com ligações de dispositivo associadas.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global	US Government L4	US Government L5 (DOD)	China operada pela 21Vianet
✅	❌	❌	❌

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão	Permissões com menos privilégios	Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante)	NetworkAccess.ReadWrite.All	Indisponível.
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Application	NetworkAccess.ReadWrite.All	Indisponível.

Importante

Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.

Administrador de Acesso Seguro Global
Administrador de Segurança

Solicitação HTTP

POST /networkAccess/connectivity/branches/{branchSiteId}/deviceLinks

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type	application/json. Obrigatório.

Corpo da solicitação

No corpo do pedido, forneça uma representação JSON do objeto microsoft.graph.networkaccess.deviceLink .

Pode especificar as seguintes propriedades ao criar um deviceLink.

Propriedade	Tipo	Descrição
name	Cadeia de caracteres	O nome ou identificador associado a uma ligação de dispositivo. Obrigatório.
ipAddress	Cadeia de caracteres	O endereço IP associado a uma ligação de dispositivo. Obrigatório.
deviceVendor	microsoft.graph.networkaccess.deviceVendor	O fornecedor ou fabricante do dispositivo associado a uma ligação de dispositivo. Os valores possíveis são: `barracudaNetworks`, , `checkPoint`, `ciscoMerakicitrix`, `fortinet`, `hpeAruba`, `netFoundry`, `nuage`, `openSystems`, , `paloAltoNetworks`, `riverbedTechnology`, , `silverPeak`, , `vmWareSdWan`, , `versa`, . `other` Obrigatório.
lastModifiedDateTime	DateTimeOffset	A data e hora em que a ligação do dispositivo foi modificada pela última vez. Obrigatório.
tunnelConfiguration	microsoft.graph.networkaccess.tunnelConfiguration	As definições de configuração do túnel associadas a uma ligação de dispositivo. Obrigatório.
bgpConfiguration	microsoft.graph.networkaccess.bgpConfiguration	As definições de configuração do Protocolo BGP (Border Gateway Protocol) associadas a uma ligação de dispositivo. Obrigatório.

Resposta

Se for bem-sucedido, este método devolve um 201 Created código de resposta e um objeto microsoft.graph.networkaccess.deviceLink no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

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);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



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"\
    }\
}\
'

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



// 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)

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


// 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);

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


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);

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


<?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();

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


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

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


# 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)

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

Partilhar via

Criar deviceLink (preterido)

Permissões

Solicitação HTTP

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Exemplos

Solicitação

Resposta

Comentários

Recursos adicionais