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>]
   [-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>]
   [-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の認証に使用されるアクセス トークン。

これは、たとえば、 または 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

-AuthenticationOrder

エンドポイントで使用される認証の順序と種類を指定します。

指定したオプションが証明書を呼び出す場合は、Certificate パラメーターを設定する必要があります。

Type:EndpointAuthenticationOrder
Accepted values:Ntlm, Kerberos, Negotiate, Certificate, NtlmCertificate, KerberosCertificate, NegotiateCertificate, CertificateNtlm, CertificateKerberos, CertificateNegotiate
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Certificate

エンドポイントが接続の認証に使用する証明書の名前を指定します。 遠方エンドポイントには、証明書の秘密キーと一致する公開キーを持つ証明書が必要です。

Type:String
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

-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

-Encryption

エンドポイントの暗号化オプションを指定します。

既定値は Required です。

Type:EndpointEncryption
Accepted values:Disabled, Supported, Required
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EncryptionAlgorithm

エンドポイントで使用される暗号化の形式を指定します。

既定では、エンドポイントは AES 暗号化を使用します。

注: RC4 アルゴリズムは、下位互換性のためにのみサポートされています。 データベースが互換性レベル 90 または 100 の場合にのみ、RC4 またはRC4_128を使用して新しいマテリアルを暗号化できますが、これは推奨されません。 セキュリティを強化するために、代わりにアルゴリズムの 1 つなどの新しいアルゴリズムを AES 使用します。

Type:EndpointEncryptionAlgorithm
Accepted values:None, RC4, Aes, AesRC4, RC4Aes
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

エンドポイントが作成されるSQL Server インスタンスのサーバー オブジェクトを指定します。

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

-IpAddress

エンドポイントの IP アドレスを指定します。 既定値は ALL です。これは、リスナーが任意の有効な IP アドレスでの接続を受け入れることを示します。

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

-Name

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

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

-Owner

エンドポイントの所有者のログインを指定します。 既定では、これが現在のログインです。

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

-Path

エンドポイントのSQL Server インスタンスへのパスを指定します。 指定しない場合は、現在の作業場所が使用されます。

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

-Port

エンドポイントが接続をリッスンする TCP ポートを指定します。 既定値は、5022 です。

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

-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.Server

出力

SMO.Endpoint