New-SqlAvailabilityReplica

構文

ByPath (既定)

New-SqlAvailabilityReplica
    [-Name] <String>
    [[-Path] <String>]
    -AvailabilityMode <AvailabilityReplicaAvailabilityMode>
    -FailoverMode <AvailabilityReplicaFailoverMode>
    -EndpointUrl <String>
    [-SessionTimeout <Int32>]
    [-ConnectionModeInPrimaryRole <AvailabilityReplicaConnectionModeInPrimaryRole>]
    [-ConnectionModeInSecondaryRole <AvailabilityReplicaConnectionModeInSecondaryRole>]
    [-BackupPriority <Int32>]
    [-ReadOnlyRoutingList <String[]>]
    [-ReadonlyRoutingConnectionUrl <String>]
    [-SeedingMode <AvailabilityReplicaSeedingMode>]
    [-LoadBalancedReadOnlyRoutingList <String[][]>]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AsTemplate

New-SqlAvailabilityReplica
    [-Name] <String>
    -AvailabilityMode <AvailabilityReplicaAvailabilityMode>
    -FailoverMode <AvailabilityReplicaFailoverMode>
    -EndpointUrl <String>
    [-SessionTimeout <Int32>]
    [-ConnectionModeInPrimaryRole <AvailabilityReplicaConnectionModeInPrimaryRole>]
    [-ConnectionModeInSecondaryRole <AvailabilityReplicaConnectionModeInSecondaryRole>]
    [-BackupPriority <Int32>]
    [-ReadOnlyRoutingList <String[]>]
    [-ReadonlyRoutingConnectionUrl <String>]
    [-SeedingMode <AvailabilityReplicaSeedingMode>]
    [-LoadBalancedReadOnlyRoutingList <String[][]>]
    [-AsTemplate]
    [-Version <ServerVersion>]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObject

New-SqlAvailabilityReplica
    [-Name] <String>
    [-InputObject] <AvailabilityGroup>
    -AvailabilityMode <AvailabilityReplicaAvailabilityMode>
    -FailoverMode <AvailabilityReplicaFailoverMode>
    -EndpointUrl <String>
    [-SessionTimeout <Int32>]
    [-ConnectionModeInPrimaryRole <AvailabilityReplicaConnectionModeInPrimaryRole>]
    [-ConnectionModeInSecondaryRole <AvailabilityReplicaConnectionModeInSecondaryRole>]
    [-BackupPriority <Int32>]
    [-ReadOnlyRoutingList <String[]>]
    [-ReadonlyRoutingConnectionUrl <String>]
    [-SeedingMode <AvailabilityReplicaSeedingMode>]
    [-LoadBalancedReadOnlyRoutingList <String[][]>]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

例

Example 1: Creates a representation of an availability replica

PS C:\> $ServerObject = Get-Item "SQLSERVER:\Sql\PrimaryServer\InstanceName"
PS C:\> New-SqlAvailabilityReplica -Name "PrimaryServer\Instance" -EndpointUrl "TCP://PrimaryServerName.domain.com:5022" -FailoverMode Automatic -AvailabilityMode SynchronousCommit -AsTemplate -Version $ServerObject.Version

Example 2: Creates an availability replica that supports manual failover and the asynchronouscommit

PS C:\> $ServerObject = Get-Item "SQLSERVER:\Sql\PrimaryServer\InstanceName"
PS C:\> New-SqlAvailabilityReplica -Name "SecondaryServer\Instance" -EndpointUrl "TCP://PrimaryServerName.domain.com:5022" -FailoverMode Manual -AvailabilityMode AsynchronousCommit -AsTemplate -Version $ServerObject.Version

Example 3: Add an availability replica to an availability group

PS C:\> New-SqlAvailabilityReplica -Name "SecondaryServer\Instance" -EndpointUrl "TCP://PrimaryServerName.domain.com:5022" -FailoverMode Manual -AvailabilityMode AsynchronousCommit -ConnectionModeInSecondaryRole AllowAllConnections -Path "SQLSERVER:\Sql\PrimaryServer\InstanceName\AvailabilityGroups\MainAG"

パラメーター

-AccessToken

The access token used to authenticate to SQL Server, as an alternative to user/password or Windows Authentication.

This can be used, for example, to connect to SQL Azure DB and SQL Azure Managed Instance using a Service Principal or a Managed Identity.

The parameter to use can be either a string representing the token or a PSAccessToken object as returned by running Get-AzAccessToken -ResourceUrl https://database.windows.net.

This parameter is new in v22 of the module.

パラメーターのプロパティ

パラメーター セット

-AsTemplate

Indicates that this cmdlet creates a temporary AvailabilityReplica object in memory. Specify this parameter to create an availability group before you create an availability replica. Create an availability group by using the New-SqlAvailabilityGroup cmdlet. Specify the temporary availability replica as the value of the AvailabilityReplica parameter.

If you specify AsTemplate, this cmdlet ignores values for the InputObject and Path parameters.

If you specify this parameter, you must also specify a SQL Server version for the Version parameter, or your current session must have an active connection to an instance.

パラメーターのプロパティ

パラメーター セット

-AvailabilityMode

Specifies the replica availability mode.

You can specify a value of $Null.

パラメーターのプロパティ

パラメーター セット

-BackupPriority

Specifies the desired priority of the replicas in performing backups. The acceptable values for this parameter are integers from 0 through 100. Of the set of replicas which are online and available, the replica that has the highest priority performs the backup.

パラメーターのプロパティ

パラメーター セット

-Confirm

Prompts you for confirmation before running the cmdlet.

パラメーターのプロパティ

パラメーター セット

-ConnectionModeInPrimaryRole

Specifies how the availability replica handles connections when in the primary role.

The acceptable values for this parameter are:

• AllowReadWriteConnections. Allows read/write connections
• AllowAllConnections. Allows all connections

パラメーターのプロパティ

パラメーター セット

-ConnectionModeInSecondaryRole

Specifies how the availability replica handles connections when in the secondary role. The acceptable values for this parameter are:

• AllowNoConnections. Disallows connections
• AllowReadIntentConnectionsOnly. Allows only read-intent connections
• AllowAllConnections. Allows all connections

パラメーターのプロパティ

パラメーター セット

-Encrypt

The encryption type to use when connecting to SQL Server.

This value maps to the Encrypt property SqlConnectionEncryptOption on the SqlConnection object of the Microsoft.Data.SqlClient driver.

In v22 of the module, the default is Optional (for compatibility with v21). In v23+ of the module, the default value will be 'Mandatory', which may create a breaking change for existing scripts.

This parameter is new in v22 of the module.

パラメーターのプロパティ

パラメーター セット

-EndpointUrl

Specifies the URL of the database mirroring endpoint. This URL is a TCP address in the following form:

TCP://system-address:port

パラメーターのプロパティ

パラメーター セット

-FailoverMode

Specifies the failover mode.

You can specify a value of $Null

パラメーターのプロパティ

パラメーター セット

-HostNameInCertificate

The host name to be used in validating the SQL Server TLS/SSL certificate. You must pass this parameter if your SQL Server instance is enabled for Force Encryption and you want to connect to an instance using hostname/shortname. If this parameter is omitted then passing the Fully Qualified Domain Name (FQDN) to -ServerInstance is necessary to connect to a SQL Server instance enabled for Force Encryption.

This parameter is new in v22 of the module.

パラメーターのプロパティ

パラメーター セット

-InputObject

Specifies the availability group, as an AvailabilityGroup object, to which the replica belongs.

パラメーターのプロパティ

パラメーター セット

-LoadBalancedReadOnlyRoutingList

Specifies the load-balanced read-only routing list.

The routing list is a list of load-balanced sets, which in turn are lists of replicas.

For example, passing a value like

@('Server1','Server2'),@('Server3'),@('Server4')

means what we are passing 3 load-balanced sets: 1 with 2 replicas (Server1 and Server2) and 2 with just one (Server3 and Server4, respectively).

At runtime, SQL Server will look sequentially at all the load-balanced sets until finds one such that at least on replica in it is available and use it for load-balancing.

So, in the example above, if both Server1 and Server2 are not available, but Server3 is, SQL Server will pick Server3.

This cmdlet only sets the read-only routing list and does not check on the availablility of the specified replicas.

パラメーターのプロパティ

パラメーター セット

-Name

Specifies a name for the availability replica in the following format: Computer\Instance

パラメーターのプロパティ

パラメーター セット

-Path

Specifies the path of the availability group to which the replica belongs. If you do not specify this parameter, this cmdlet uses current working location.

パラメーターのプロパティ

パラメーター セット

-ReadonlyRoutingConnectionUrl

Specifies the fully-qualified domain name (FQDN) and port to use when routing to the replica for read only connections, as in the following example: TCP://DBSERVER8.manufacturing.Contoso.com:7024

パラメーターのプロパティ

パラメーター セット

-ReadOnlyRoutingList

Specifies an ordered list of replica server names that represent the probe sequence for connection director to use when redirecting read-only connections through this availability replica. This parameter applies if the availability replica is the current primary replica of the availability group.

パラメーターのプロパティ

パラメーター セット

-Script

Indicates that this cmdlet returns a Transact-SQL script that performs the task that this cmdlet performs.

パラメーターのプロパティ

パラメーター セット

-SeedingMode

Specifies how the secondary replica will be initially seeded.

Allowed values:

• Automatic. Enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica.
• Manual. Specifies manual seeding. This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica.

パラメーターのプロパティ

パラメーター セット

-SessionTimeout

Specifies the amount of time, in seconds, to wait for a response between the primary replica and this replica before the connection fails.

パラメーターのプロパティ

パラメーター セット

-TrustServerCertificate

Indicates whether the channel will be encrypted while bypassing walking the certificate chain to validate trust.

In v22 of the module, the default is $true (for compatibility with v21). In v23+ of the module, the default value will be '$false', which may create a breaking change for existing scripts.

This parameter is new in v22 of the module.

パラメーターのプロパティ

パラメーター セット

-Version

Specifies a SQL Server version. If you specify the AsTemplate parameter, you must specify a version. The template object is created in design mode on a server that includes this version. You can specify an integer or a string, as in the following examples (SQL Server 2017):

• 14
• '14.0.0'

パラメーターのプロパティ

パラメーター セット

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

パラメーターのプロパティ

パラメーター セット

CommonParameters

入力

Microsoft.SqlServer.Management.Smo.AvailabilityGroup

出力

Microsoft.SqlServer.Management.Smo.AvailabilityReplica

関連リンク

• New-SqlAvailabilityGroup
• Remove-SqlAvailabilityReplica
• Set-SqlAvailabilityReplica
• Test-SqlAvailabilityReplica