New-SqlAvailabilityGroupListener
可用性グループ リスナーを作成し、可用性グループにアタッチします。
構文
New-SqlAvailabilityGroupListener
[-DhcpSubnet <String>]
[-StaticIp <String[]>]
[-Port <Int32>]
[-Name] <String>
[[-Path] <String>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-SqlAvailabilityGroupListener
[-DhcpSubnet <String>]
[-StaticIp <String[]>]
[-Port <Int32>]
[-Name] <String>
[-InputObject] <AvailabilityGroup>
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-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の認証に使用されるアクセス トークン。
これは、たとえば、 または Managed Identity
に接続SQL Azure DB
して SQL Azure Managed Instance
使用するために使用Service Principal
できます。
使用するパラメーターには、 を実行Get-AzAccessToken -ResourceUrl https://database.windows.net
して返されるトークンまたはオブジェクトをPSAccessToken
表す文字列を指定できます。
このパラメーターは、モジュールの v22 の新機能です。
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DhcpSubnet
ネットワークの IPv4 アドレスとサブネット マスクを指定します。 リスナーは、DHCP を使用してこのネットワーク上のアドレスを決定します。 192.168.0.1/255.255.255.0 の形式で アドレスを に指定します。
このパラメーターを指定する場合は、 StaticIp パラメーターを指定しないでください。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Encrypt
SQL Serverに接続するときに使用する暗号化の種類。
この値は、 Encrypt
Microsoft.Data.SqlClient ドライバーの SqlConnection オブジェクトの プロパティ SqlConnectionEncryptOption
にマップされます。
モジュールの v22 では、既定値は Optional
(v21 との互換性のために) です。 モジュールの v23 以降では、既定値は "必須" になります。これにより、既存のスクリプトに破壊的変更が発生する可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
Type: | String |
Accepted values: | Mandatory, Optional, Strict |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HostNameInCertificate
SQL Server TLS/SSL 証明書の検証に使われるホスト名。 SQL Server インスタンスが Force Encryption に対して有効になっており、hostname/shortname を使用してインスタンスに接続する場合は、このパラメーターを渡す必要があります。 このパラメーターを省略した場合、強制暗号化が有効になっているSQL Server インスタンスに接続するには、完全修飾ドメイン名 (FQDN) を -ServerInstance に渡す必要があります。
このパラメーターは、モジュールの v22 の新機能です。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
このコマンドレットがリスナーをアタッチする可用性グループを AvailabilityGroup オブジェクトとして指定します。
Type: | AvailabilityGroup |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
リスナーの名前を指定します。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
このコマンドレットがリスナーをアタッチする可用性グループのパスを指定します。 このパラメーターを指定しない場合、このコマンドレットは現在の作業場所を使用します。
Type: | String |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Port
リスナーが接続をリッスンするポートを指定します。 既定のポートは TCP ポート 1433 です。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Script
このコマンドレットによって、このコマンドレットが実行するタスクを実行する Transact-SQL スクリプトが返されることを示します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-StaticIp
アドレスの配列を指定します。 各アドレス エントリは、IPv4 アドレスとサブネット マスク、または IPv6 アドレスです。 リスナーは、このパラメーターが指定するアドレスをリッスンします。
このパラメーターを指定する場合は、 DhcpSubnet パラメーターを指定しないでください。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TrustServerCertificate
信頼を検証するために証明書チェーンのウォークをバイパスしながらチャネルを暗号化するかどうかを示します。
モジュールの v22 では、既定値は $true
(v21 との互換性のために) です。 モジュールの v23 以降では、既定値は "$false" になり、既存のスクリプトに破壊的変更が生じる可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
Microsoft.SqlServer.Management.Smo.AvailabilityGroup