New-SqlAvailabilityGroupListener

Синтаксис

ByPath (по умолчанию)

New-SqlAvailabilityGroupListener
    [-Name] <String>
    [[-Path] <String>]
    [-DhcpSubnet <String>]
    [-StaticIp <String[]>]
    [-Port <Int32>]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObject

New-SqlAvailabilityGroupListener
    [-Name] <String>
    [-InputObject] <AvailabilityGroup>
    [-DhcpSubnet <String>]
    [-StaticIp <String[]>]
    [-Port <Int32>]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Описание

Примеры

Example 1: Create a listener for an availability group

PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -Path "SQLSERVER:\SQL\PrimaryServer\InstanceName\AvailabilityGroups\MainAG"

Example 2: Create a listener for an availability group that has a nondefault port

PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -Path "SQLSERVER:\SQL\PrimaryServer\InstanceName\AvailabilityGroups\MainAG" -Port 1434

Example 3: Create a listener for an availability group that uses DHCP

PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -DhcpSubnet "192.169.0.1/255.255.252.0" -Path "SQLSERVER:\SQL\PrimaryServer\InstanceName\AvailabilityGroups\MainAG"

Example 4: Create a listener for an availability group that uses a static address

PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -StaticIp "192.168.3.1/255.255.252.0" -Path "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAG"

Example 5: Create a script that creates a listener

PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -Path "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAG" -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.

Свойства параметра

Наборы параметров

-Confirm

Prompts you for confirmation before running the cmdlet.

Свойства параметра

Наборы параметров

-DhcpSubnet

Specifies an IPv4 address and subnet mask of a network. The listener determines the address on this network by using DHCP. Specify the address in for following format: 192.168.0.1/255.255.255.0.

If you specify this parameter, do not specify the StaticIp parameter.

Свойства параметра

Наборы параметров

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

Свойства параметра

Наборы параметров

-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 this cmdlet attaches the listener.

Свойства параметра

Наборы параметров

-Name

Specifies a name for the listener.

Свойства параметра

Наборы параметров

-Path

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

Свойства параметра

Наборы параметров

-Port

Specifies the port on which the listener listens for connections. The default port is TCP port 1433.

Свойства параметра

Наборы параметров

-Script

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

Свойства параметра

Наборы параметров

-StaticIp

Specifies an array of addresses. Each address entry is either an IPv4 address and subnet mask or an IPv6 address. The listener listens on the addresses that this parameter specifies.

If you specify this parameter, do not specify the DhcpSubnet parameter.

Свойства параметра

Наборы параметров

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

Связанные ссылки

• Add-SqlAvailabilityGroupListenerStaticIp
• Set-SqlAvailabilityGroupListener