Set-AzureEndpoint
Modifies an endpoint assigned to a virtual machine.
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.
The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.
Syntax
Set-AzureEndpoint
[-Name] <String>
[[-Protocol] <String>]
[[-LocalPort] <Int32>]
[-PublicPort <Int32>]
[-DirectServerReturn <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.
Examples
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-AzureVMThis 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.
Parameters
-ACL
Specifies an access control list (ACL) configuration object that this cmdlet applies to the endpoint.
| Type: | NetworkAclObject |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DirectServerReturn
Specifies whether this cmdlet enables direct server return. Specify $True to enable, or $False to disable.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IdleTimeoutInMinutes
Specifies the TCP idle time-out period, in minutes, for the endpoint.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InformationAction
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
| Type: | ActionPreference |
| Aliases: | infa |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InformationVariable
Specifies an information variable.
| Type: | String |
| Aliases: | iv |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InternalLoadBalancerName
Specifies the name of the internal load balancer.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoadBalancerDistribution
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LocalPort
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.
| Type: | Int32 |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of the endpoint.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Profile
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
| Type: | AzureSMProfile |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Protocol
Specifies the protocol of the endpoint. Valid values are:
- tcp
- udp
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PublicPort
Specifies the public port that the endpoint uses.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VirtualIPName
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VM
Specifies the virtual machine to which the endpoint belongs.
| Type: | IPersistentVM |
| Aliases: | InputObject |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |