forwardingPolicy: updatePolicyRules

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 the rules within a forwarding policy.

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)	NetworkAccessPolicy.ReadWrite.All	Not available.
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

POST /networkAccess/forwardingPolicies/{id}/updatePolicyRules

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

The following table shows the parameters that can be used with this action.

Parameter	Type	Description
id	microsoft.graph.networkaccess.policyRule	Unique Identifier for the rule.
action	microsoft.graph.networkaccess.policyRuleDelta	Action for the traffic, possible values are forward or bypass. Required.

Response

If successful, this action returns a 204 No Content response code.

Examples

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/networkAccess/forwardingPolicies/{id}/updatePolicyRules
Content-Type: application/json

{
  "rules": [
    {
      "ruleId": "e296c914-768c-4ce9-a279-e4b6145a8a4b",
      "action": "forward"
    }
  ]
}

CLI

mgc-beta network-access forwarding-policies microsoft-graph-networkaccess-update-policy-rules post --forwarding-policy-id {forwardingPolicy-id} --body '{\
  "rules": [\
    {\
      "ruleId": "e296c914-768c-4ce9-a279-e4b6145a8a4b",\
      "action": "forward"\
    }\
  ]\
}\
'

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const updatePolicyRules = {
  rules: [
    {
      ruleId: 'e296c914-768c-4ce9-a279-e4b6145a8a4b',
      action: 'forward'
    }
  ]
};

await client.api('/networkAccess/forwardingPolicies/{id}/updatePolicyRules')
	.version('beta')
	.post(updatePolicyRules);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows a response.

HTTP/1.1 204 No Content