New-SqlHADREndpoint

语法

ByPath （默认值）

New-SqlHADREndpoint
    [-Name] <String>
    [[-Path] <String>]
    [-Port <Int32>]
    [-Owner <String>]
    [-Certificate <String>]
    [-IpAddress <IPAddress>]
    [-AuthenticationOrder <EndpointAuthenticationOrder>]
    [-Encryption <EndpointEncryption>]
    [-EncryptionAlgorithm <EndpointEncryptionAlgorithm>]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObject

New-SqlHADREndpoint
    [-Name] <String>
    [-InputObject] <Server>
    [-Port <Int32>]
    [-Owner <String>]
    [-Certificate <String>]
    [-IpAddress <IPAddress>]
    [-AuthenticationOrder <EndpointAuthenticationOrder>]
    [-Encryption <EndpointEncryption>]
    [-EncryptionAlgorithm <EndpointEncryptionAlgorithm>]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

示例

Example 1: Create a database mirroring endpoint

PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint"

Example 2: Create a database mirroring endpoint that requires encryption

PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint" -Port 4022 -EncryptionAlgorithm Aes -Encryption Required

Example 3: Create a database mirroring endpoint that is encrypted with a certificate

PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint" -AuthenticationOrder Certificate -Certificate "EncryptionCertificate"

Example 4: Create a database mirroring endpoint script

PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint" -Script

参数

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

参数属性

参数集

-AuthenticationOrder

Specifies the order and type of authentication that is used by the endpoint.

If the specified option calls for a certificate, the Certificate parameter must be set.

参数属性

参数集

-Certificate

Specifies the name of the certificate that the endpoint will use to authenticate connections. The far endpoint must have a certificate with the public key matching the private key of the certificate.

参数属性

参数集

-Confirm

Prompts you for confirmation before running the cmdlet.

参数属性

参数集

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

参数属性

参数集

-Encryption

Specifies the encryption option for the endpoint.

The default value is Required.

参数属性

参数集

-EncryptionAlgorithm

Specifies the form of encryption used by the endpoint.

By default the endpoint will use Aes encryption.

NOTE: The RC4 algorithm is only supported for backward compatibility. New material can only be encrypted using RC4 or RC4_128 when the database is in compatibility level 90 or 100, but this is not recommended. For increased security, use a newer algorithm such as one of the AES algorithms instead.

参数属性

参数集

-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 server object of the SQL Server instance where the endpoint is created.

参数属性

参数集

-IpAddress

Specifies the IP address of the endpoint. The default is ALL, which indicates that the listener accepts a connection on any valid IP address.

参数属性

参数集

-Name

Specifies the endpoint name.

参数属性

参数集

-Owner

Specifies the login of the owner of the endpoint. By default, this is the current login.

参数属性

参数集

-Path

Specifies the path to the SQL Server instance of the endpoint. If not specified, the current working location is used.

参数属性

参数集

-Port

Specifies the TCP port on which the endpoint will listen for connections. The default is 5022.

参数属性

参数集

-Script

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

参数属性

参数集

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

参数属性

参数集

-WhatIf

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

参数属性

参数集

CommonParameters

输入

Microsoft.SqlServer.Management.Smo.Server

输出

SMO.Endpoint

相关链接

• Set-SqlHADREndpoint