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.
Update an existing forwarding policy link to modify the association between a forwarding policy and a forwarding profile. This operation allows for linking or unlinking them as needed.
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 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. |
Important
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.
- Global Secure Access Administrator
- Security Administrator
HTTP request
PATCH /networkAccess/forwardingProfiles/{forwardingProfileId}/policies/{forwardingPolicyId}
Request body
In the request body, supply only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.
The following table specifies the properties that can be updated.
| Property |
Type |
Description |
| state |
microsoft.graph.networkaccess.status |
Represents the current state or status of a forwarding policy link. It indicates whether the link between a forwarding policy and a forwarding profile is active or inactive., Inherited from microsoft.graph.networkaccess.policyLink. The possible values are: enabled, disabled. Required. |
Response
If successful, this method returns a 204 No Content response code.
Examples
Request
The following example shows a request.
PATCH https://graph.microsoft.com/beta/networkAccess/forwardingProfiles/{forwardingProfile_id}/policies/{policy_id}
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.networkaccess.forwardingPolicyLink",
"state": "enabled"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models.Networkaccess;
var requestBody = new ForwardingPolicyLink
{
OdataType = "#microsoft.graph.networkaccess.forwardingPolicyLink",
State = Status.Enabled,
};
// To initialize your graphClient, see https://free.blessedness.top/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.NetworkAccess.ForwardingProfiles["{forwardingProfile-id}"].Policies["{policyLink-id}"].PatchAsync(requestBody);
// 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.NewPolicyLink()
state := graphmodels.ENABLED_STATUS
requestBody.SetState(&state)
// To initialize your graphClient, see https://free.blessedness.top/en-us/graph/sdks/create-client?from=snippets&tabs=go
policies, err := graphClient.NetworkAccess().ForwardingProfiles().ByForwardingProfileId("forwardingProfile-id").Policies().ByPolicyLinkId("policyLink-id").Patch(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.ForwardingPolicyLink policyLink = new com.microsoft.graph.beta.models.networkaccess.ForwardingPolicyLink();
policyLink.setOdataType("#microsoft.graph.networkaccess.forwardingPolicyLink");
policyLink.setState(com.microsoft.graph.beta.models.networkaccess.Status.Enabled);
com.microsoft.graph.models.networkaccess.PolicyLink result = graphClient.networkAccess().forwardingProfiles().byForwardingProfileId("{forwardingProfile-id}").policies().byPolicyLinkId("{policyLink-id}").patch(policyLink);
const options = {
authProvider,
};
const client = Client.init(options);
const policyLink = {
'@odata.type': '#microsoft.graph.networkaccess.forwardingPolicyLink',
state: 'enabled'
};
await client.api('/networkAccess/forwardingProfiles/{forwardingProfile_id}/policies/{policy_id}')
.version('beta')
.update(policyLink);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Networkaccess\ForwardingPolicyLink;
use Microsoft\Graph\Beta\Generated\Models\Networkaccess\Status;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ForwardingPolicyLink();
$requestBody->setOdataType('#microsoft.graph.networkaccess.forwardingPolicyLink');
$requestBody->setState(new Status('enabled'));
$result = $graphServiceClient->networkAccess()->forwardingProfiles()->byForwardingProfileId('forwardingProfile-id')->policies()->byPolicyLinkId('policyLink-id')->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.NetworkAccess
$params = @{
"@odata.type" = "#microsoft.graph.networkaccess.forwardingPolicyLink"
state = "enabled"
}
Update-MgBetaNetworkAccessForwardingProfilePolicy -ForwardingProfileId $forwardingProfileId -PolicyLinkId $policyLinkId -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.forwarding_policy_link import ForwardingPolicyLink
from msgraph_beta.generated.models.status import Status
# To initialize your graph_client, see https://free.blessedness.top/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ForwardingPolicyLink(
odata_type = "#microsoft.graph.networkaccess.forwardingPolicyLink",
state = Status.Enabled,
)
result = await graph_client.network_access.forwarding_profiles.by_forwarding_profile_id('forwardingProfile-id').policies.by_policy_link_id('policyLink-id').patch(request_body)
Response
The following example shows the response.
HTTP/1.1 204 No Content