Set-SqlHADREndpoint
データベース ミラーリング エンドポイントのプロパティを設定します。
構文
ByPath (既定)
Set-SqlHADREndpoint
[[-Path] <String>]
[-Owner <String>]
[-Certificate <String>]
[-IpAddress <IPAddress>]
[-AuthenticationOrder <EndpointAuthenticationOrder>]
[-Encryption <EndpointEncryption>]
[-EncryptionAlgorithm <EndpointEncryptionAlgorithm>]
[-Port <Int32>]
[-State <EndpointState>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByObject
Set-SqlHADREndpoint
[-InputObject] <Endpoint>
[-Owner <String>]
[-Certificate <String>]
[-IpAddress <IPAddress>]
[-AuthenticationOrder <EndpointAuthenticationOrder>]
[-Encryption <EndpointEncryption>]
[-EncryptionAlgorithm <EndpointEncryptionAlgorithm>]
[-Port <Int32>]
[-State <EndpointState>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Set-SqlHADREndpoint コマンドレットは、データベース ミラーリング エンドポイントのプロパティを変更します。
例
例 1: データベース ミラーリング エンドポイントのポート番号を設定する
PS C:\> Set-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance\Endpoints\MainDbmEndpoint" -Port 5050
このコマンドは、MainDbmEndpoint という名前のデータベース ミラーリング エンドポイントのポート番号を、5050という名前のサーバー インスタンスにComputer\Instanceするように設定します。
例 2: データベース ミラーリング エンドポイントを開始する
PS C:\> Set-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance\Endpoints\MainDbmEndpoint" -State Started
このコマンドは、サーバー インスタンス MainDbmEndpointで Computer\Instance という名前のデータベース ミラーリング エンドポイントを開始します。
パラメーター
-AccessToken
ユーザー/パスワードまたは Windows 認証の代わりに、SQL Server に対する認証に使用されるアクセス トークン。
これは、たとえば、SQL Azure DBまたはSQL Azure Managed Instanceを使用してService Principalに接続してManaged Identityするために使用できます。
使用するパラメーターには、トークンを表す文字列、または PSAccessToken を実行して返されるGet-AzAccessToken -ResourceUrl https://database.windows.net オブジェクトのいずれかを指定できます。
このパラメーターは、モジュールの v22 の新機能です。
パラメーターのプロパティ
型: PSObject
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-AuthenticationOrder
エンドポイントによって使用される認証の順序と種類を指定します。
指定したオプションが証明書を呼び出す場合は、証明書が既にエンドポイントに関連付けられていない限り、Certificate パラメーターを設定する必要があります。
パラメーターのプロパティ
型: EndpointAuthenticationOrder
規定値: None
指定可能な値: Ntlm, Kerberos, Negotiate, Certificate, NtlmCertificate, KerberosCertificate, NegotiateCertificate, CertificateNtlm, CertificateKerberos, CertificateNegotiate
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-Certificate
エンドポイントが接続の認証に使用する証明書の名前を指定します。
遠方エンドポイントには、指定された証明書の秘密キーと一致する公開キーを持つ証明書が必要です。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
型: SwitchParameter
規定値: False
ワイルドカードのサポート: False
DontShow: False
Aliases: cf
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-Encrypt
SQL Server に接続するときに使用する暗号化の種類。
この値は、Microsoft.Data.SqlClient ドライバーの SqlConnection オブジェクトの Encrypt プロパティ SqlConnectionEncryptOption にマップされます。
モジュールの v22 では、既定値は Optional です (v21 との互換性のため)。 モジュールの v23 以降では、既定値は "必須" になり、既存のスクリプトに重大な変更が生じる可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
パラメーターのプロパティ
型: String
規定値: None
指定可能な値: Mandatory, Optional, Strict
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-Encryption
エンドポイントの暗号化設定を指定します。
パラメーターのプロパティ
型: EndpointEncryption
規定値: None
指定可能な値: Disabled, Supported, Required
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-EncryptionAlgorithm
エンドポイントで使用される暗号化の形式を指定します。
注: RC4 アルゴリズムは下位互換性のためにのみサポートされています。
新しいマテリアルは、データベースが互換性レベルのRC4またはRC4_128にある場合にのみ、90または100を使用して暗号化できますが、これは推奨されません。
セキュリティを強化するために、代わりに AES アルゴリズムの 1 つなどの新しいアルゴリズムを使用します。
パラメーターのプロパティ
型: EndpointEncryptionAlgorithm
規定値: None
指定可能な値: None, RC4, Aes, AesRC4, RC4Aes
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-HostNameInCertificate
SQL Server TLS/SSL 証明書の検証に使われるホスト名。 SQL Server インスタンスで Force Encryption が有効になっていて、ホスト名/短縮名を使用してインスタンスに接続する場合は、このパラメーターを渡す必要があります。 このパラメーターを省略した場合、強制暗号化が有効になっている SQL Server インスタンスに接続するには、完全修飾ドメイン名 (FQDN) を -ServerInstance に渡す必要があります。
このパラメーターは、モジュールの v22 の新機能です。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
変更するエンドポイントを指定します。 これはデータベース ミラーリング エンドポイントである必要があります。
型: Endpoint
規定値: None
ワイルドカードのサポート: False
DontShow: False
ByObject
配置: 1
必須: True
パイプラインからの値: True
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-IpAddress
エンドポイントがリッスンする IP アドレスを指定します。
パラメーターのプロパティ
型: IPAddress
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-Owner
エンドポイントの所有者を指定します。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-Path
データベース ミラーリング エンドポイントへのパスを指定します。 指定しない場合は、現在の作業場所が使用されます。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
ByPath
配置: 1
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-Port
エンドポイントが接続をリッスンするために使用する TCP ポート番号を指定します。
パラメーターのプロパティ
型: Int32
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-Script
このコマンドレットが、タスクを実行する Transact-SQL スクリプトを出力することを示します。
パラメーターのプロパティ
型: SwitchParameter
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-State
エンドポイントの状態を指定します。
パラメーターのプロパティ
型: EndpointState
規定値: None
指定可能な値: Started, Stopped, Disabled
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-TrustServerCertificate
信頼を検証するために証明書チェーンのウォークをバイパスしながらチャネルを暗号化するかどうかを示します。
モジュールの v22 では、既定値は $true です (v21 との互換性のため)。 モジュールの v23 以降では、既定値は "$false" になり、既存のスクリプトに重大な変更が生じる可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
パラメーターのプロパティ
型: SwitchParameter
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
型: SwitchParameter
規定値: False
ワイルドカードのサポート: False
DontShow: False
Aliases: ウィスコンシン
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParameters を参照してください。
Microsoft.SqlServer.Management.Smo.Endpoint
出力
SMO.Endpoint