Set-AzureEndpoint

NAME Set-AzureEndpoint



SYNOPSIS

Modifies an endpoint assigned to a virtual machine.





SYNTAX

Set-AzureEndpoint [-Name] <String> [[-Protocol] <String>] [[-LocalPort] <Int32>] [-PublicPort <Nullable`1[Int32]>] [-DirectServerReturn

<Nullable`1[Boolean]>] [-ACL <NetworkAclObject>] [-InternalLoadBalancerName <String>] [-IdleTimeoutInMinutes <Int32>] [-LoadBalancerDistribution

<String>] [-VirtualIPName <String>] -VM <IPersistentVM> [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable

<String>] [<CommonParameters>]





DESCRIPTION

The Set-AzureEndpoint cmdlet modifies an endpoint assigned to an Azure virtual machine. You can specify changes to an endpoint that is not load balanced.





PARAMETERS

-Name <String>

Specifies the name of the endpoint.



Required? true

Position? 0

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Protocol <String>

Specifies the protocol of the endpoint. Valid values are:



-- tcp



-- udp



Required? false

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-LocalPort <Int32>

Specifies the local, private, port that this endpoint uses. Applications within the virtual machine listen on this port for service input requests

for this endpoint.



Required? false

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-PublicPort <Nullable`1[Int32]>

Specifies the public port that the endpoint uses.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DirectServerReturn <Nullable`1[Boolean]>

Specifies whether this cmdlet enables direct server return. Specify $True to enable, or $False to disable.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ACL <NetworkAclObject>

Specifies an access control list (ACL) configuration object that this cmdlet applies to the endpoint.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InternalLoadBalancerName <String>

Specifies the name of the internal load balancer.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-IdleTimeoutInMinutes <Int32>

Specifies the TCP idle time-out period, in minutes, for the endpoint.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-LoadBalancerDistribution <String>

Specifies the load balancer distribution algorithm. Valid values are:



-- sourceIP. A two tuple affinity: Source IP, Destination IP



-- sourceIPProtocol. A three tuple affinity: Source IP, Destination IP, Protocol



-- none. A five tuple affinity: Source IP, Source Port, Destination IP, Destination Port, Protocol





The default value is none.





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-VirtualIPName <String>

Specifies the name of a virtual IP address that Azure associates to the endpoint. Your service can have multiple virtual IPs. To create virtual IPs,

use the Add-AzureVirtualIP cmdlet.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-VM <IPersistentVM>

Specifies the virtual machine to which the endpoint belongs.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue, ByPropertyName)

Accept wildcard characters? false



-Profile <AzureSMProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

System.Object







NOTES









-------------------------- Example 1: Modify an endpoint to listen on a port --------------------------



PS C:\\>Get-AzureVM -ServiceName "ContosoService" -Name "VirutalMachine01" | Set-AzureEndpoint -Name "Web" -PublicPort 443 -LocalPort 443 -Protocol tcp |

Update-AzureVM



This command retrieves the configuration of a virtual machine named VirtualMachine01 by using the Get-AzureVM cmdlet. The command passes it to the

current cmdlet by using the pipeline operator. This cmdlet modifies the endpoint named Web to listen on port 443. The command passes the virtual machine

object to the Update-AzureVM cmdlet, which implements your changes.



RELATED LINKS

Add-AzureEndpoint

Add-AzureVirtualIP

Get-AzureEndpoint

Get-AzureVM

Remove-AzureEndpoint

Update-AzureVM