VirtualMachineUpdateLoadBalancedSetParameters.InputEndpoint Class

Definition

The modeled external endpoint for a persistent VM role.

public class VirtualMachineUpdateLoadBalancedSetParameters.InputEndpoint
type VirtualMachineUpdateLoadBalancedSetParameters.InputEndpoint = class
Public Class VirtualMachineUpdateLoadBalancedSetParameters.InputEndpoint
Inheritance
VirtualMachineUpdateLoadBalancedSetParameters.InputEndpoint

Constructors

VirtualMachineUpdateLoadBalancedSetParameters.InputEndpoint()

Initializes a new instance of the InputEndpoint class.

VirtualMachineUpdateLoadBalancedSetParameters.InputEndpoint(String)

Initializes a new instance of the InputEndpoint class with required arguments.

Properties

EnableDirectServerReturn

Optional. A Boolean specifying whether this endpoint uses Direct Server Return

IdleTimeoutInMinutes

Optional. The idle timeout in minutes for this endpoint.

LoadBalancedEndpointSetName

Required. Specifies whether this endpoint is part of shared LoadBalanced endpoint and served by multiple role instances. If not specified a BadRequest error will be returned. It must also be in use by the deployment (at least one role in the deployment must have an endpoint whose LoadBalancedEndpointSetName matches this) otherwise a BadRequest error will be returned.

LoadBalancerDistribution

Optional. Load Balancer Distribution for this endpoint.

LoadBalancerName

Optional. Optional. Specify the name of an internal load balancer if this endpoint shall not be exposed on the default load balancer.

LoadBalancerProbe

Optional. This represents an endpoint setting which platform load balancer must monitor to detect the availability of this role before forwarding traffic to this endpoint. If not specified the probe settings (if any) from the existing load balanced endpoint definition will be retained.

LocalPort

Optional. Specifies the internal port on which a service running inside the VM is listening to serve this endpoint. WARNING: If specified then ALL the endpoints of this LB set on all the roles will be updated to have THIS local port. To keep unique local ports on each role for a load balanced endpoint specify this as 0 (zero) and if you need to change those use UpdateRole. In case of port conflict with a local port (or probe port) on a role a BadRequestwill be returned.

Name

Optional. The name of the InputEndpoint. The name is ignored if specified

Port

Optional. An integer specifying the public port for this endpoint. Allowed values are between 1 and 65535 inclusive. A unqiue Port and Protocol combination must be specified for each InputEndpoint in the list.

Protocol

Optional. Specifies the transport protocol for the endpoint.

Rules

Optional. A collection of access control rules which control the external network traffic reaching to this endpoint. NOTES: (1) To remove the ACLs from a load-balanced endpoint just omit this element. (2) ACLs are set as specified. There is no merge done with existing ACLs.

VirtualIPAddress

Optional. The virtual IP address of the endpoint.

VirtualIPName

Optional. Virtual IP Name for this endpoint.

Applies to