Update Load-Balanced Endpoint Set

 

Updated: July 10, 2015

The Update Load-Balanced Endpoint Set operation updates the configuration of the specified load-balanced input endpoints on all Virtual Machines in a deployment.

The Update Load-Balanced Endpoint Set request may be specified as follows. Replace <subscription-id> with the subscription ID, <cloudservice-name> with the name of the cloud service, and <deployment-name> with the name of the deployment.

Method

Request URI

POST

https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deployments/<deployment-name>

URI Parameter

Description

comp=UpdateLbSet

Required. Specifies that the load-balanced endpoint set must be updated.

The following table describes the request headers.

Request Header

Description

Content-Type

Required. Set this header to application/xml.

x-ms-version

Required. Specifies the version of the operation to use for this request. This header should be set to 2013-06-01 or higher.

The format of the request body is as follows:


<LoadBalancedEndpointList xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <InputEndpoint>
    <LoadBalancedEndpointSetName>endpoint-set-name</LoadBalancedEndpointSetName>
    <LocalPort>local-port-number</LocalPort>
    <Port>external-port-number</Port>
    <LoadBalancerProbe>
      <Path>path-of-probe</Path>
      <Port>port-assigned-to-probe</Port>
      <Protocol>probe-protocol</Protocol>
      <IntervalInSeconds>interval-of-probe</IntervalInSeconds>
      <TimeoutInSeconds>timeout-for-probe</TimeoutInSeconds>
    </LoadBalancerProbe>
    <Protocol>endpoint-protocol</Protocol>
    <EnableDirectServerReturn>enable-direct-server-return</EnableDirectServerReturn>   
    <EndpointACL>
      <Rules>
        <Rule>
          <Order>priority-of-the-rule</Order>
          <Action>permit-rule</Action>
          <RemoteSubnet>subnet-of-the-rule</RemoteSubnet>
          <Description>description-of-the-rule</Description>
        </Rule>
      </Rules>
    </EndpointACL>
    <LoadBalancerName>name-of-internal-loadbalancer</LoadBalancerName>
    <IdleTimeoutInMinutes>timeout-for-tcp-idle-connection</IdleTimeoutInMinutes>
  </InputEndpoint>
</LoadBalancedEndpointList>

The following table describes the elements of the request body.

Element name

Description

InputEndpoint

Required. Specifies the properties that define an external endpoint for the Virtual Machine.

LoadBalancedEndpointSetName

Required. Specifies a name for a set of load-balanced endpoints. At least one Virtual Machine in the deployment must have an endpoint with this LoadBalancedEndpointSetName defined.

LocalPort

Required. Specifies the internal port on which the Virtual Machine is listening. All endpoints in the load-balanced endpoint set will be updated with this value.

Port

Required. Specifies the external port to use for the endpoint. Allowed values are between 1 and 65535 inclusive. A unique Port and Protocol combination must be specified for each input endpoint in the set.

LoadBalancerProbe

Optional. Specifies endpoint settings that the load balancer uses to monitor the availability of the Virtual Machine before forwarding traffic to the endpoint.

If this element is not specified, the probe settings from the existing load-balanced endpoint definition are retained.

Protocol

Required Specifies the protocol to use for the endpoint. A unique Port and Protocol combination must be specified for each input endpoint in the set. If EnableDirectServerReturn set to true, you cannot update the value of Protocol

Possible values are:

  • UDP

  • TCP

EnableDirectServerReturn

Optional. Specifies whether the endpoint uses Direct Server Return. The EnableDirectServerReturn element is not supported for RDP, SSH, or WinRM endpoints and it is not supported when the public port and local port of an endpoint are different. You cannot disable EnableDirectServerReturn on an endpoint. If EnableDirectServerReturn set to true, you cannot update the value of Protocol. It is recommended that this element is only used when setting up Virtual Machines for SQL Server and AlwaysOn Availability Groups.

Possible values are:

  • true

  • false

The default value is false.

EndpointACL

Optional. Specifies a collection of rules that control the network traffic to the endpoint. To remove the ACLs from a load-balanced endpoint, do not specify this this element in the request. Changes to ACLs are not merged with existing ACLs.

LoadBalancerName

Optional. Specifies the name of the internal load balancer that is associated with this endpoint.

The LoadBalancerName element is only available using version 2014-05-01 or higher.

IdleTimeoutInMinutes

Optional. Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

The IdleTimeoutInMinutes element is only available using version 2014-06-01 or higher.

Specifies the endpoint settings that the load balancer uses to monitor the availability of the virtual machine before forwarding traffic to the endpoint.

Element name

Description

Path

Optional. Specifies the relative path to inspect to determine the availability status of the Virtual Machine. If Protocol is set to TCP, this value must be NULL.

Example:

path

The probe will use https://example.com/path to perform the probe.

Port

Optional. Specifies the port to use to inspect the availability status of the Virtual Machine.

Protocol

Optional. Specifies the protocol to use to inspect the availability status of the virtual machine.

Possible values are:

  • HTTP

  • TCP

IntervalInSeconds

Optional. Specifies the interval for the load balancer probe in seconds. The minimum value is 5 seconds. The default is 15 seconds.

TimeoutInSeconds

Optional. Specifies the timeout for the load balancer probe in seconds. The minimum value is 11 seconds. The default is 31 seconds.

Contains a collection of rules that control the network traffic to the endpoint.

Element name

Description

Rules

Required. Specifies a collection of access control rules. A maximum of 50 rules are allowed.

Rule

Required. Specifies the definition of an access control rule.

Order

Required. Specifies the priority of the rule. The value can be between 0 and 65535. The order number must be unique for each rule in the collection. The lower the order number, the higher the priority of the rule.

Action

Required. Specifies whether traffic that matches the rule should be permitted or denied.

Possible values are:

  • permit

  • deny

RemoteSubnet

Required. Specifies the subnet for the rule. The subnet must be in IPV4 Classless Inter-Domain Routing (CIDR) notation, and must be a valid subnet.

For example, 10.0.0.0/24

Description

Optional. Specifies a description for the rule. The maximum length of the description is 256 characters.

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

A successful operation returns status code 202 (Accepted).

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.

Show: