你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Add-AzureEndpoint

将终结点添加到虚拟机。

注释

本文档中引用的 cmdlet 用于管理使用 Azure Service Manager (ASM) API 的旧式 Azure 资源。 创建新资源时,建议不要使用旧的 PowerShell 模块,因为计划将停用 ASM。 有关详细信息,请参阅 Azure Service Manager 停用

Az PowerShell 模块是建议用于管理 PowerShell 的 Azure 资源管理器 (ARM) 资源的 PowerShell 模块。

语法

NoLB (默认值)

Add-AzureEndpoint
    [-Name] <String>
    [-Protocol] <String>
    [-LocalPort] <Int32>
    -VM <IPersistentVM>
    [-PublicPort <Int32>]
    [-DirectServerReturn <Boolean>]
    [-ACL <NetworkAclObject>]
    [-InternalLoadBalancerName <String>]
    [-IdleTimeoutInMinutes <Int32>]
    [-LoadBalancerDistribution <String>]
    [-VirtualIPName <String>]
    [-Profile <AzureSMProfile>]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [<CommonParameters>]

LBNoProbe

Add-AzureEndpoint
    [-Name] <String>
    [-Protocol] <String>
    [-LocalPort] <Int32>
    -LBSetName <String>
    -VM <IPersistentVM>
    [-PublicPort <Int32>]
    [-DirectServerReturn <Boolean>]
    [-ACL <NetworkAclObject>]
    [-NoProbe]
    [-InternalLoadBalancerName <String>]
    [-IdleTimeoutInMinutes <Int32>]
    [-LoadBalancerDistribution <String>]
    [-VirtualIPName <String>]
    [-Profile <AzureSMProfile>]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [<CommonParameters>]

LBDefaultProbe

Add-AzureEndpoint
    [-Name] <String>
    [-Protocol] <String>
    [-LocalPort] <Int32>
    -LBSetName <String>
    -VM <IPersistentVM>
    [-PublicPort <Int32>]
    [-DirectServerReturn <Boolean>]
    [-ACL <NetworkAclObject>]
    [-DefaultProbe]
    [-InternalLoadBalancerName <String>]
    [-IdleTimeoutInMinutes <Int32>]
    [-LoadBalancerDistribution <String>]
    [-VirtualIPName <String>]
    [-Profile <AzureSMProfile>]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [<CommonParameters>]

LBCustomProbe

Add-AzureEndpoint
    [-Name] <String>
    [-Protocol] <String>
    [-LocalPort] <Int32>
    -LBSetName <String>
    -ProbePort <Int32>
    -ProbeProtocol <String>
    -VM <IPersistentVM>
    [-PublicPort <Int32>]
    [-DirectServerReturn <Boolean>]
    [-ACL <NetworkAclObject>]
    [-ProbePath <String>]
    [-ProbeIntervalInSeconds <Int32>]
    [-ProbeTimeoutInSeconds <Int32>]
    [-InternalLoadBalancerName <String>]
    [-IdleTimeoutInMinutes <Int32>]
    [-LoadBalancerDistribution <String>]
    [-VirtualIPName <String>]
    [-Profile <AzureSMProfile>]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [<CommonParameters>]

说明

Add-AzureEndpoint cmdlet 将终结点添加到 Azure 虚拟机对象。

示例

示例 1:添加终结点

PS C:\> Get-AzureVM -ServiceName "ContosoService" -Name "VirtualMachine01" | Add-AzureEndpoint -Name "HttpIn" -Protocol "tcp" -PublicPort 80 -LocalPort 8080 | Update-AzureVM

此命令使用 Get-AzureVM cmdlet 检索名为 VirtualMachine01 的虚拟机的配置。 该命令使用管道运算符将其传递给当前 cmdlet。 此 cmdlet 添加名为 HttpIn 的终结点。 终结点具有公共端口 80 和本地端口 8080。 该命令将虚拟机对象传递给 Update-AzureVM cmdlet,该 cmdlet 可实现更改。

示例 2:添加属于负载均衡组的终结点

PS C:\> Get-AzureVM -ServiceName "LoadBalancedService" -Name "VirtualMachine12" | Add-AzureEndpoint -Name "HttpIn" -Protocol "tcp" -PublicPort 80 -LocalPort 8080 -LBSetName "WebFarm" -ProbePort 80 -ProbeProtocol "http" -ProbePath '/' | Update-AzureVM

此命令检索名为 VirtualMachine07 的虚拟机的配置。 当前 cmdlet 添加名为 HttpIn 的终结点。 终结点具有公共端口 80 和本地端口 8080。 终结点属于名为 WebFarm 的共享负载均衡组。 端口 80 上的 HTTP 探测(路径为“/”)监视终结点的可用性。 该命令实现更改。

示例 3:将虚拟 IP 关联到终结点

PS C:\> Get-AzureVM -ServiceName "ContosoService" -Name "VirtualMachine25" | Add-AzureEndpoint -Name "HttpIn" -Protocol "tcp" -LocalPort 8080 -PublicPort 80 -VirtualIPName "ContosoVip11" | Update-AzureVM

此命令检索名为 VirtualMachine25 的虚拟机的配置。 当前 cmdlet 添加名为 HttpIn 的终结点。 终结点具有公共端口 80 和本地端口 8080。 此命令将虚拟 IP 关联到终结点。 该命令实现更改。

参数

-ACL

指定终结点的访问控制列表 (ACL) 配置对象。

参数属性

类型:NetworkAclObject
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultProbe

指示此 cmdlet 使用默认探测设置。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

LBDefaultProbe
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DirectServerReturn

指定此 cmdlet 是否启用直接服务器返回。 指定要启用的$True,或指定要禁用的$False。

参数属性

类型:Boolean
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-IdleTimeoutInMinutes

指定终结点的 TCP 空闲超时期限(以分钟为单位)。

参数属性

类型:Int32
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-InformationAction

指定此 cmdlet 如何响应信息事件。

此参数的可接受值为:

  • 继续
  • 忽略
  • 查询
  • 静默继续
  • 停下
  • 暂停

参数属性

类型:ActionPreference
默认值:None
支持通配符:False
不显示:False
别名:infa

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-InformationVariable

指定信息变量。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-InternalLoadBalancerName

指定内部负载均衡器的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-LBSetName

指定终结点的负载均衡器集的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:LoadBalancedEndpointSetName

参数集

LBNoProbe
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
LBDefaultProbe
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
LBCustomProbe
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-LoadBalancerDistribution

指定负载均衡器分发算法。 有效值为:

  • sourceIP。 两个元组相关性:源 IP、目标 IP
  • sourceIPProtocol。 三个元组相关性:源 IP、目标 IP、协议
  • 无。 五个元组相关性:源 IP、源端口、目标 IP、目标端口、协议

默认值为 none。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-LocalPort

指定此终结点使用的本地专用端口。 虚拟机中的应用程序侦听此端口,以获取此终结点的服务输入请求。

参数属性

类型:Int32
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:2
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Name

指定终结点的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:0
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-NoProbe

指示此 cmdlet 不使用探测设置。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

LBNoProbe
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ProbeIntervalInSeconds

指定终结点的探测轮询间隔(以秒为单位)。

参数属性

类型:Int32
默认值:None
支持通配符:False
不显示:False

参数集

LBCustomProbe
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ProbePath

指定 HTTP 探测的相对路径。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

LBCustomProbe
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ProbePort

指定终结点使用的端口。

参数属性

类型:Int32
默认值:None
支持通配符:False
不显示:False

参数集

LBCustomProbe
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ProbeProtocol

指定端口协议。 有效值为:

  • TCP
  • http

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

LBCustomProbe
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ProbeTimeoutInSeconds

指定探测轮询超时周期(以秒为单位)。

参数属性

类型:Int32
默认值:None
支持通配符:False
不显示:False

参数集

LBCustomProbe
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Profile

指定此 cmdlet 从中读取的 Azure 配置文件。 如果未指定配置文件,此 cmdlet 将从本地默认配置文件中读取。

参数属性

类型:AzureSMProfile
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Protocol

指定终结点的协议。 有效值为:

  • TCP
  • udp

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:1
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PublicPort

指定终结点使用的公共端口。 如果未指定值,Azure 会分配可用端口。

参数属性

类型:Int32
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-VirtualIPName

指定 Azure 关联到终结点的虚拟 IP 地址的名称。 服务可以有多个虚拟 IP。 若要创建虚拟 IP,请使用 Add-AzureVirtualIP cmdlet。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-VM

指定终结点所属的虚拟机。

参数属性

类型:IPersistentVM
默认值:None
支持通配符:False
不显示:False
别名:InputObject

参数集

(All)
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):True
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输出

Object