New-SqlHADREndpoint
SQL Server インスタンスにデータベース ミラーリング エンドポイントを作成します。
構文
New-SqlHADREndpoint
[-Port <Int32>]
[-Owner <String>]
[-Certificate <String>]
[-IpAddress <IPAddress>]
[-AuthenticationOrder <EndpointAuthenticationOrder>]
[-Encryption <EndpointEncryption>]
[-EncryptionAlgorithm <EndpointEncryptionAlgorithm>]
[-Name] <String>
[[-Path] <String>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-SqlHADREndpoint
[-Port <Int32>]
[-Owner <String>]
[-Certificate <String>]
[-IpAddress <IPAddress>]
[-AuthenticationOrder <EndpointAuthenticationOrder>]
[-Encryption <EndpointEncryption>]
[-EncryptionAlgorithm <EndpointEncryptionAlgorithm>]
[-Name] <String>
[-InputObject] <Server>
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
New-SqlHADREndpoint コマンドレットは、SQL Server インスタンスにデータベース ミラーリング エンドポイントを作成します。 このエンドポイントは、任意の可用性グループの可用性レプリカをホストするすべてのサーバー インスタンスで必要です。 各サーバー インスタンスは、データベース ミラーリング エンドポイントを 1 つだけ持つことができます。 サーバー インスタンスにデータベース ミラーリング エンドポイントが存在する場合は、既存のエンドポイントを使用します。
例
例 1: データベース ミラーリング エンドポイントを作成する
PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint"このコマンドは、指定したパスにあるサーバー インスタンスに MainEndpoint という名前のデータベース ミラーリング エンドポイントを作成します。 このエンドポイントは、既定のポートである 5022を使用します。
例 2: 暗号化を必要とするデータベース ミラーリング エンドポイントを作成する
PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint" -Port 4022 -EncryptionAlgorithm Aes -Encryption Requiredこのコマンドは、指定したパスにあるサーバー インスタンスに MainEndpoint という名前のデータベース ミラーリング エンドポイントを作成します。 このエンドポイントは、ポート 4022でリッスンします。
エンドポイントは暗号化に AES アルゴリズムを使用し、接続で暗号化を使用する必要があります。
例 3: 証明書で暗号化されたデータベース ミラーリング エンドポイントを作成する
PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint" -AuthenticationOrder Certificate -Certificate "EncryptionCertificate"このコマンドは、指定したパスにあるサーバー インスタンスに MainEndpoint という名前のデータベース ミラーリング エンドポイントを作成します。 このエンドポイントは、EncryptionCertificate という名前の証明書を使用して接続を認証します。
例 4: データベース ミラーリング エンドポイント スクリプトを作成する
PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint" -Scriptこのコマンドは、指定したパスにあるサーバー インスタンスに MainEndpoint という名前のデータベース ミラーリング エンドポイントを作成する 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 |
-AuthenticationOrder
エンドポイントによって使用される認証の順序と種類を指定します。
指定したオプションが証明書を呼び出す場合は、Certificate パラメーターを設定する必要があります。
| 型: | EndpointAuthenticationOrder |
| 指定可能な値: | Ntlm, Kerberos, Negotiate, Certificate, NtlmCertificate, KerberosCertificate, NegotiateCertificate, CertificateNtlm, CertificateKerberos, CertificateNegotiate |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Certificate
エンドポイントが接続の認証に使用する証明書の名前を指定します。 遠方エンドポイントには、証明書の秘密キーと一致する公開キーを持つ証明書が必要です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | False |
| 必須: | 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 |
-Encryption
エンドポイントの暗号化オプションを指定します。
既定値は Requiredです。
| 型: | EndpointEncryption |
| 指定可能な値: | Disabled, Supported, Required |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-EncryptionAlgorithm
エンドポイントで使用される暗号化の形式を指定します。
既定では、エンドポイントは Aes 暗号化を使用します。
注: RC4 アルゴリズムは下位互換性のためにのみサポートされています。
データベースが互換性レベル 90 または 100 の場合にのみ、RC4 またはRC4_128を使用して新しいマテリアルを暗号化できますが、これは推奨されません。 セキュリティを強化するために、代わりに AES アルゴリズムの 1 つなどの新しいアルゴリズムを使用します。
| 型: | EndpointEncryptionAlgorithm |
| 指定可能な値: | None, RC4, Aes, AesRC4, RC4Aes |
| 配置: | 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
エンドポイントが作成される SQL Server インスタンスのサーバー オブジェクトを指定します。
| 型: | Server |
| 配置: | 2 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-IpAddress
エンドポイントの IP アドレスを指定します。 既定値は ALL で、リスナーが任意の有効な IP アドレスで接続を受け入れることを示します。
| 型: | IPAddress |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Name
エンドポイント名を指定します。
| 型: | String |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Owner
エンドポイントの所有者のログインを指定します。 既定では、これは現在のログインです。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Path
エンドポイントの SQL Server インスタンスへのパスを指定します。 指定しない場合は、現在の作業場所が使用されます。
| 型: | String |
| 配置: | 2 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Port
エンドポイントが接続をリッスンする TCP ポートを指定します。
既定値は 5022です。
| 型: | 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 |
-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.Server
出力
SMO.Endpoint