Join-SqlAvailabilityGroup
ローカル セカンダリ レプリカを可用性グループに参加させます。
構文
Join-SqlAvailabilityGroup
[-Name] <String>
[[-Path] <String>]
[-ClusterType <AvailabilityGroupClusterType>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Join-SqlAvailabilityGroup
[-Name] <String>
[-InputObject] <Server>
[-ClusterType <AvailabilityGroupClusterType>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Join-SqlAvailabilityGroup コマンドレットは、ローカル セカンダリ レプリカを可用性グループに参加させます。
可用性グループに参加していないセカンダリ レプリカをホストする SQL Server のインスタンスで、このコマンドレットを実行します。
例
例 1: セカンダリ レプリカを可用性グループに参加させる
PS C:\> Join-SqlAvailabilityGroup -Path "SQLSERVER:\SQL\SecondaryServer\InstanceName" -Name "MainAG"
このコマンドは、セカンダリ レプリカを 'MainAG' という名前の可用性グループに参加させます。 このサーバー インスタンスは、この可用性グループ内のセカンダリ レプリカをホストする必要があります。
例 2: セカンダリ レプリカを可用性グループに参加させるスクリプトを作成する
PS C:\> Join-SqlAvailabilityGroup -Path "SQLSERVER:\SQL\SecondaryServer\InstanceName" -Name "MainAG" -Script
このコマンドは、セカンダリ レプリカを 'MainAG' という名前の可用性グループに参加させる 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 |
-ClusterType
AG をバックアップするクラスターの種類。 使用可能な値は次のとおりです。
- Wsfc。 AG は Windows Server フェールオーバー クラスターに統合されます。 これにより、SQL Server 2016 以降の AG が作成されます。 これが既定値です。
- 何一つ。 AG はクラスターに依存しません。
- 外。 AG は、Linux 上の Pacemaker などの Windows Server フェールオーバー クラスターではないクラスター マネージャーによって管理されます。 これは、SQL Server 2017 以降でサポートされています。 SQL Server on Linux を対象とする場合は、この値を指定する必要があります。または、エラーが発生します。
型: | AvailabilityGroupClusterType |
指定可能な値: | Wsfc, None, External |
配置: | Named |
規定値: | Wsfc |
必須: | 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 |
-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 |
-Name
このコマンドレットがセカンダリ レプリカに参加する可用性グループの名前を指定します。
型: | String |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Path
このコマンドレットが可用性グループに参加するセカンダリ レプリカをホストする SQL Server のインスタンスのパスを指定します。 このパラメーターを指定しない場合、このコマンドレットは現在の作業場所を使用します。
型: | String |
配置: | 2 |
規定値: | 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
サーバー インスタンスをこのコマンドレットに渡すことができます。
メモ
高可用性データ復旧サービスは、サーバー インスタンスで有効にする必要があります。 Path パラメーターで指定された可用性レプリカが存在する必要があります。