Assign forwardingProfile
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.
Assign a forwarding profile to an existing remote network. To create a remote network with traffic forwarding profile, see Create remoteNetwork.
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 permission | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | Not supported. | Not supported. |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | Not supported. | Not supported. |
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/connectivity/remoteNetworks/{remoteNetworkId}/forwardingProfiles
Request headers
| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
| Content-Type | application/json. Required. |
Request body
In the request body, supply a JSON representation of the microsoft.graph.networkaccess.forwardingProfile object.
You can specify the following properties when associating a forwardingProfile to a remote network.
| Property | Type | Description |
|---|---|---|
| id | String | ID of the forwarding profile. Inherited from microsoft.graph.networkaccess.profile. Required. |
Response
If successful, this method returns a OK 200 response code.
Examples
To get the id of forwarding profiles of your organization, refer to this article - List forwardingProfiles.
Request
The following example shows a request.
PATCH https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks/{remoteNetworkId}/forwardingProfiles
Content-Type: application/json
{
"@context": "#$delta",
"value": [
{
"id": "1adaf535-1e31-4e14-983f-2270408162bf"
}
]
}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK