New-SqlAvailabilityGroupListener
Cria um ouvinte de grupo de disponibilidade e o anexa a um grupo de disponibilidade.
Sintaxe
New-SqlAvailabilityGroupListener
[-DhcpSubnet <String>]
[-StaticIp <String[]>]
[-Port <Int32>]
[-Name] <String>
[[-Path] <String>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-SqlAvailabilityGroupListener
[-DhcpSubnet <String>]
[-StaticIp <String[]>]
[-Port <Int32>]
[-Name] <String>
[-InputObject] <AvailabilityGroup>
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet New-SqlAvailabilityGroupListener cria um ouvinte de grupo de disponibilidade e o anexa a um grupo de disponibilidade. Execute este cmdlet na instância do servidor que hospeda a réplica primária.
Exemplos
Exemplo 1: criar um ouvinte para um grupo de disponibilidade
PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -Path "SQLSERVER:\SQL\PrimaryServer\InstanceName\AvailabilityGroups\MainAG"
Esse comando cria um ouvinte de grupo de disponibilidade chamado 'MainListener' para o grupo de disponibilidade chamado 'MainAG'. Esse ouvinte adquire um endereço IP virtual usando DHCP. Execute este comando na instância do servidor que hospeda a réplica primária.
Exemplo 2: criar um ouvinte para um grupo de disponibilidade que tenha uma porta não padrão
PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -Path "SQLSERVER:\SQL\PrimaryServer\InstanceName\AvailabilityGroups\MainAG" -Port 1434
Esse comando cria um ouvinte de grupo de disponibilidade chamado 'MainListener' para o grupo de disponibilidade chamado 'MainAG'. Como no exemplo anterior, esse ouvinte adquire um endereço IP virtual usando DHCP. Este exemplo atribui a porta 1434 na qual ela escuta.
Exemplo 3: criar um ouvinte para um grupo de disponibilidade que usa DHCP
PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -DhcpSubnet "192.169.0.1/255.255.252.0" -Path "SQLSERVER:\SQL\PrimaryServer\InstanceName\AvailabilityGroups\MainAG"
Esse comando cria um ouvinte de grupo de disponibilidade chamado 'MainListener' para o grupo de disponibilidade chamado 'MainAG'. Esse ouvinte adquire um endereço IP virtual na sub-rede especificada usando DHCP.
Exemplo 4: criar um ouvinte para um grupo de disponibilidade que usa um endereço estático
PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -StaticIp "192.168.3.1/255.255.252.0" -Path "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAG"
Esse comando cria um ouvinte de grupo de disponibilidade chamado 'MainListener' para o grupo de disponibilidade chamado 'MainAG'. Esse ouvinte usa o endereço IPv4 especificado pelo parâmetro StaticIp como seu endereço IP virtual.
Exemplo 5: criar um script que cria um ouvinte
PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -Path "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAG" -Script
Esse comando cria um script Transact-SQL que cria um ouvinte de grupo de disponibilidade chamado 'MainListener' para o grupo de disponibilidade chamado 'MainAG'. O comando não cria um ouvinte.
Parâmetros
-AccessToken
O token de acesso usado para autenticar no SQL Server, como uma alternativa ao usuário/senha ou à Autenticação do Windows.
Isso pode ser usado, por exemplo, para se conectar a SQL Azure DB
e SQL Azure Managed Instance
usando um Service Principal
ou um Managed Identity
.
O parâmetro a ser usado pode ser uma cadeia de caracteres que representa o token ou um objeto PSAccessToken
conforme retornado executando Get-AzAccessToken -ResourceUrl https://database.windows.net
.
Esse parâmetro é novo na v22 do módulo.
Tipo: | PSObject |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Confirm
Solicita a confirmação antes de executar o cmdlet.
Tipo: | SwitchParameter |
Aliases: | cf |
Cargo: | Named |
Valor padrão: | False |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-DhcpSubnet
Especifica um endereço IPv4 e uma máscara de sub-rede de uma rede. O ouvinte determina o endereço nessa rede usando DHCP. Especifique o endereço para o seguinte formato: 192.168.0.1/255.255.255.0.
Se você especificar esse parâmetro, não especifique o parâmetro StaticIp.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Encrypt
O tipo de criptografia a ser usado ao se conectar ao SQL Server.
Esse valor é mapeado para a propriedade Encrypt
SqlConnectionEncryptOption
no objeto SqlConnection do driver Microsoft.Data.SqlClient.
Na v22 do módulo, o padrão é Optional
(para compatibilidade com v21). Na v23+ do módulo, o valor padrão será 'Obrigatório', o que pode criar uma alteração significativa para scripts existentes.
Esse parâmetro é novo na v22 do módulo.
Tipo: | String |
Valores aceitos: | Mandatory, Optional, Strict |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-HostNameInCertificate
O nome do host a ser usado na validação do certificado TLS/SSL do SQL Server. Você deve passar esse parâmetro se a instância do SQL Server estiver habilitada para o Force Encryption e quiser se conectar a uma instância usando nome de host/nome curto. Se esse parâmetro for omitido, passar o FQDN (Nome de Domínio Totalmente Qualificado) para -ServerInstance será necessário para se conectar a uma instância do SQL Server habilitada para o Force Encryption.
Esse parâmetro é novo na v22 do módulo.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-InputObject
Especifica o grupo de disponibilidade, como um objeto AvailabilityGroup, ao qual esse cmdlet anexa o ouvinte.
Tipo: | AvailabilityGroup |
Cargo: | 2 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-Name
Especifica um nome para o ouvinte.
Tipo: | String |
Cargo: | 1 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Path
Especifica o caminho do grupo de disponibilidade ao qual esse cmdlet anexa um ouvinte. Se você não especificar esse parâmetro, esse cmdlet usará o local de trabalho atual.
Tipo: | String |
Cargo: | 2 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Port
Especifica a porta na qual o ouvinte escuta conexões. A porta padrão é a porta TCP 1433.
Tipo: | Int32 |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ProgressAction
Determina como o PowerShell responde às atualizações de progresso geradas por um script, cmdlet ou provedor, como as barras de progresso geradas pelo cmdlet Write-Progress. O cmdlet Write-Progress cria barras de progresso que mostram o status de um comando.
Tipo: | ActionPreference |
Aliases: | proga |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Script
Indica que esse cmdlet retorna um script Transact-SQL que executa a tarefa executada por esse cmdlet.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-StaticIp
Especifica uma matriz de endereços. Cada entrada de endereço é um endereço IPv4 e uma máscara de sub-rede ou um endereço IPv6. O ouvinte escuta nos endereços especificados por esse parâmetro.
Se você especificar esse parâmetro, não especifique o parâmetro dhcpSubnet
Tipo: | String[] |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-TrustServerCertificate
Indica se o canal será criptografado ao ignorar a cadeia de certificados para validar a confiança.
Na v22 do módulo, o padrão é $true
(para compatibilidade com v21). Na v23+ do módulo, o valor padrão será "$false", o que pode criar uma alteração significativa para scripts existentes.
Esse parâmetro é novo na v22 do módulo.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Tipo: | SwitchParameter |
Aliases: | wi |
Cargo: | Named |
Valor padrão: | False |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Entradas
Microsoft.SqlServer.Management.Smo.AvailabilityGroup