Share via

Set IP Forwarding for Role

  • Article

 

The Set IP Forwarding for Role operation sets the status of IP forwarding for the specified role.

Request

The Set IP Forwarding for Role request is specified as follows. Replace <subscription-id> with your subscription ID, <cloud-service-name> with the name of the cloud service, <deployment-name> with the name of the deployment, and <role-name> with the name of the Virtual Machine on which IP forwarding state will be updated.

Method

Request URI

POST

https://management.core.windows.net/<subscription-id>/services/ hostedservices/<cloud-service-name>/deployments/<deployment-name>/roles/<role-name>/ipforwarding

URI Parameters

The following table describes the request headers.

Request Header

Description

x-ms-version

Required. Specifies the version of the operation to use for this request. The value of this header must be set to 2015-04-01 or higher.

Request Body

<IPForwarding xmlns="https://schemas.microsoft.com/windowsazure">
   <State>ip-forwarding-state</State>
</IPForwarding>

Element name

Description

State

Required. The state of IP Forwarding for the role. Possible Values are:

  • Enabled

  • Disabled

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

A successful operation returns status code 202 (Accepted).

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers.

Response Header

Description

x-ms-request-id

A value that uniquely identifies a request made against the management service.

Response Body

None.