Partilhar via

Criar forwardingProfile (preterido)

  • Artigo

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 novo ramo e atribua um perfil de reencaminhamento.

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) NetworkAccessPolicy.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Sem suporte. Sem suporte.

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}/forwardingProfiles

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.forwardingProfile .

Pode especificar as seguintes propriedades ao criar um forwardingProfile.

Propriedade Tipo Descrição
name Cadeia de caracteres Nome do ramo. Herdado de microsoft.graph.networkaccess.profile. Obrigatório.
description Cadeia de caracteres Descrição. Herdado de microsoft.graph.networkaccess.profile. Opcional.
state microsoft.graph.networkaccess. status Status. Herdado de microsoft.graph.networkaccess.profile. Os valores possíveis são: enabled, disabled. Obrigatório.
associações coleção microsoft.graph.networkaccess.association A coleção de perfis de reencaminhamento representa um grupo de múltiplos perfis de reencaminhamento. Obrigatório.

Resposta

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

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/networkAccess/connectivity/branches/{branchSiteId}/
Content-Type: application/json

{
    "name": "branch 1",
    "region": "eastUS",
    "deviceLinks":
    [
        {
            "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": "/path/to/kv"
            }
        }
    ],
    "forwardingProfiles": [
        {
            "id": "8e30d8d6-3588-4d5f-a704-6bd843be5b8f"
        }
    ]
}

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.context": "https://localhost:5001/networkaccess/connectivity/$metadata#branches/$entity",
    "id": "c038928c-4100-4b8d-895d-f90ae38bafa1",
    "name": "branch 1",
    "region": "eastUS",
    "connectivityState": "pending",
    "version": "1.0.0",
    "lastModifiedDateTime": "2021-01-05T00:00:00Z",
    "deviceLinks": [
        {
            "id": "f29753d5-85b4-4cce-9194-10a287568973",
            "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",
            },
            "tunnleConfiguration": {
                "@odata.type": "#microsoft.graph.networkaccess.TunnleConfigurationIKEv2Deafult",
                "preSharedKey": "/path/to/kv"
            }
        }
    ],
    "forwardingProfiles": [
        {
            "id": "8e30d8d6-3588-4d5f-a704-6bd843be5b8f"
        }
    ]
}