Share via

Add-AzureEndpoint

  • リファレンス
モジュール:
Azure

仮想マシンにエンドポイントを追加します。

注意

このドキュメントで参照されているコマンドレットは、Service Management API を使用するレガシ Azure リソースを管理するためのものです。 Azure Resource Manager リソースを管理するためのコマンドレットについては、Az PowerShell モジュールを参照してください。

構文

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

説明

Add-AzureEndpoint コマンドレットは 、 エンドポイントを Azure 仮想マシン オブジェクトに追加します。

例

例 1: エンドポイントを追加する

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

このコマンドは、Get-AzureVM コマンドレットを使用して、VirtualMachine01 という名前の仮想マシンの構成を取得します。 このコマンドは、パイプライン演算子を使用して現在のコマンドレットに渡します。 このコマンドレットは、HttpIn という名前のエンドポイントを追加します。 エンドポイントにはパブリック ポート 80 とローカル ポート 8080 があります。 このコマンドは、変更を実装する Update-AzureVM コマンドレットに仮想マシン オブジェクトを渡します。

例 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 という名前の仮想マシンの構成を取得します。 現在のコマンドレットは、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 という名前の仮想マシンの構成を取得します。 現在のコマンドレットは、HttpIn という名前のエンドポイントを追加します。 エンドポイントにはパブリック ポート 80 とローカル ポート 8080 があります。 このコマンドは、仮想 IP をエンドポイントに関連付けます。 このコマンドは変更を実装します。

パラメーター

-ACL

エンドポイントのアクセス制御リスト (ACL) 構成オブジェクトを指定します。

Type:NetworkAclObject
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProbe

このコマンドレットが既定のプローブ設定を使用することを示します。

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DirectServerReturn

このコマンドレットでダイレクト サーバーの戻り値を有効にするかどうかを指定します。 有効にする$Trueを指定するか、無効にする$Falseを指定します。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IdleTimeoutInMinutes

エンドポイントの TCP アイドル タイムアウト期間を分単位で指定します。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationAction

このコマンドレットが情報イベントに応答する方法を指定します。

このパラメーターの有効値は、次のとおりです。

  • 続行
  • 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

情報変数を指定します。

Type:String
Aliases:iv
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InternalLoadBalancerName

内部ロード バランサーの名前を指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LBSetName

エンドポイントに設定されたロード バランサーの名前を指定します。

Type:String
Aliases:LoadBalancedEndpointSetName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-LoadBalancerDistribution

ロード バランサー分散アルゴリズムを指定します。 有効な値は次のとおりです。

  • sourceIP。 2 つのタプル アフィニティ: ソース IP、宛先 IP
  • sourceIPProtocol。 3 つのタプル アフィニティ: ソース IP、宛先 IP、プロトコル
  • なし。 5 つのタプル アフィニティ: 送信元 IP、送信元ポート、宛先 IP、宛先ポート、プロトコル

既定値は none です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LocalPort

このエンドポイントが使用するローカル、プライベート、ポートを指定します。 仮想マシン内のアプリケーションは、このポートでこのエンドポイントのサービス入力要求をリッスンします。

Type:Int32
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

エンドポイントの名前を指定します。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NoProbe

このコマンドレットがプローブなし設定を使用することを示します。

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ProbeIntervalInSeconds

エンドポイントのプローブ ポーリング間隔を秒単位で指定します。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProbePath

HTTP プローブへの相対パスを指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProbePort

エンドポイントが使用するポートを指定します。

Type:Int32
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ProbeProtocol

ポート プロトコルを指定します。 有効な値は次のとおりです。

  • tcp
  • http
Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ProbeTimeoutInSeconds

プローブポーリングタイムアウト期間を秒単位で指定します。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Profile

このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Protocol

エンドポイントのプロトコルを指定します。 有効な値は次のとおりです。

  • tcp
  • udp
Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PublicPort

エンドポイントが使用するパブリック ポートを指定します。 値を指定しない場合、Azure は使用可能なポートを割り当てます。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtualIPName

Azure がエンドポイントに関連付ける仮想 IP アドレスの名前を指定します。 サービスには複数の仮想 IP を含めることができます。 仮想 IP を作成するには、Add-AzureVirtualIP コマンドレットを使用します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VM

エンドポイントが属する仮想マシンを指定します。

Type:IPersistentVM
Aliases:InputObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

出力

Object