New-SqlAvailabilityGroupListener

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

可用性グループ リスナーを作成し、可用性グループにアタッチします。

構文

New-SqlAvailabilityGroupListener
   [-DhcpSubnet <String>]
   [-StaticIp <String[]>]
   [-Port <Int32>]
   [-Name] <String>
   [[-Path] <String>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-SqlAvailabilityGroupListener
   [-DhcpSubnet <String>]
   [-StaticIp <String[]>]
   [-Port <Int32>]
   [-Name] <String>
   [-InputObject] <AvailabilityGroup>
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

New-SqlAvailabilityGroupListener コマンドレットは、可用性グループ リスナーを作成し、可用性グループにアタッチします。 プライマリ レプリカをホストするサーバー インスタンスでこのコマンドレットを実行します。

例

例 1: 可用性グループのリスナーを作成する

PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -Path "SQLSERVER:\SQL\PrimaryServer\InstanceName\AvailabilityGroups\MainAG"

このコマンドは、'MainAG' という名前の可用性グループの 'MainListener' という名前の可用性グループ リスナーを作成します。 このリスナーは、DHCP を使用して仮想 IP アドレスを取得します。 プライマリ レプリカをホストするサーバー インスタンスでこのコマンドを実行します。

例 2: 既定以外のポートを持つ可用性グループのリスナーを作成する

PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -Path "SQLSERVER:\SQL\PrimaryServer\InstanceName\AvailabilityGroups\MainAG" -Port 1434

このコマンドは、'MainAG' という名前の可用性グループの 'MainListener' という名前の可用性グループ リスナーを作成します。 前の例と同様に、このリスナーは DHCP を使用して仮想 IP アドレスを取得します。 この例では、リッスンするポート 1434 を割り当てます。

例 3: DHCP を使用する可用性グループのリスナーを作成する

PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -DhcpSubnet "192.169.0.1/255.255.252.0" -Path "SQLSERVER:\SQL\PrimaryServer\InstanceName\AvailabilityGroups\MainAG"

このコマンドは、'MainAG' という名前の可用性グループの 'MainListener' という名前の可用性グループ リスナーを作成します。 このリスナーは、DHCP を使用して、指定されたサブネット内の仮想 IP アドレスを取得します。

例 4: 静的アドレスを使用する可用性グループのリスナーを作成する

PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -StaticIp "192.168.3.1/255.255.252.0" -Path "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAG"

このコマンドは、'MainAG' という名前の可用性グループの 'MainListener' という名前の可用性グループ リスナーを作成します。 このリスナーは、StaticIp パラメーターで指定された IPv4 アドレスを仮想 IP アドレスとして使用します。

例 5: リスナーを作成するスクリプトを作成する

PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -Path "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAG" -Script

このコマンドは、'MainAG' という名前の可用性グループの 'MainListener' という名前の可用性グループ リスナーを作成する Transact-SQL スクリプトを作成します。 このコマンドはリスナーを作成しません。

パラメーター

-AccessToken

ユーザー/パスワードまたは Windows 認証の代わりに、SQL Server に対する認証に使用されるアクセス トークン。

これは、たとえば、Service Principal または Managed Identityを使用して SQL Azure DB と SQL Azure Managed Instance に接続するために使用できます。

使用するパラメーターには、トークンを表す文字列、または Get-AzAccessToken -ResourceUrl https://database.windows.netを実行して返される PSAccessToken オブジェクトを指定できます。

このパラメーターは、モジュールの v22 の新機能です。

型:PSObject
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DhcpSubnet

ネットワークの IPv4 アドレスとサブネット マスクを指定します。 リスナーは、DHCP を使用してこのネットワーク上のアドレスを決定します。 192.168.0.1/255.255.255.0 の形式でアドレスを指定します。

このパラメーターを指定する場合は、StaticIp パラメーターを指定しないでください。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Encrypt

SQL Server に接続するときに使用する暗号化の種類。

この値は、Microsoft.Data.SqlClient ドライバーの SqlConnection オブジェクトの Encrypt プロパティ SqlConnectionEncryptOption にマップされます。

モジュールの v22 では、既定値は Optional です (v21 との互換性のため)。 モジュールの v23 以降では、既定値は "必須" になり、既存のスクリプトに重大な変更が生じる可能性があります。

このパラメーターは、モジュールの v22 の新機能です。

型:String
指定可能な値:Mandatory, Optional, Strict
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-HostNameInCertificate

SQL Server TLS/SSL 証明書の検証に使用するホスト名。 SQL Server インスタンスで Force Encryption が有効になっていて、ホスト名/短縮名を使用してインスタンスに接続する場合は、このパラメーターを渡す必要があります。 このパラメーターを省略した場合、強制暗号化が有効になっている SQL Server インスタンスに接続するには、完全修飾ドメイン名 (FQDN) を -ServerInstance に渡す必要があります。

このパラメーターは、モジュールの v22 の新機能です。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InputObject

可用性グループを、このコマンドレットがリスナーをアタッチする AvailabilityGroup オブジェクトとして指定します。

型:AvailabilityGroup
配置:2
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Name

リスナーの名前を指定します。

型:String
配置:1
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Path

このコマンドレットがリスナーをアタッチする可用性グループのパスを指定します。 このパラメーターを指定しない場合、このコマンドレットは現在の作業場所を使用します。

型:String
配置:2
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Port

リスナーが接続をリッスンするポートを指定します。 既定のポートは TCP ポート 1433 です。

型:Int32
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ProgressAction

スクリプト、コマンドレット、またはプロバイダーによって生成された進行状況の更新 (Write-Progress コマンドレットによって生成された進行状況バーなど) に対する PowerShell の応答方法を決定します。 Write-Progress コマンドレットは、コマンドの状態を示す進行状況バーを作成します。

型:ActionPreference
Aliases:proga
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Script

このコマンドレットは、このコマンドレットが実行するタスクを実行する Transact-SQL スクリプトを返します。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-StaticIp

アドレスの配列を指定します。 各アドレス エントリは、IPv4 アドレスとサブネット マスク、または IPv6 アドレスです。 リスナーは、このパラメーターが指定したアドレスをリッスンします。

このパラメーターを指定する場合は、DhcpSubnet パラメーターを指定しないでください。

型:String[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-TrustServerCertificate

信頼を検証するために証明書チェーンのウォークをバイパスしながらチャネルを暗号化するかどうかを示します。

モジュールの v22 では、既定値は $true です (v21 との互換性のため)。 モジュールの v23 以降では、既定値は "$false" になり、既存のスクリプトに重大な変更が生じる可能性があります。

このパラメーターは、モジュールの v22 の新機能です。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

Microsoft.SqlServer.Management.Smo.AvailabilityGroup