Partager via


New-SqlAvailabilityGroupListener

Crée un écouteur de groupe de disponibilité et l’attache à un groupe de disponibilité.

Syntaxe

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

La cmdlet New-SqlAvailabilityGroupListener crée un écouteur de groupe de disponibilité et l’attache à un groupe de disponibilité. Exécutez cette applet de commande sur l’instance de serveur qui héberge le réplica principal.

Exemples

Exemple 1 : Créer un écouteur pour un groupe de disponibilité

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

Cette commande crée un écouteur de groupe de disponibilité nommé « MainListener » pour le groupe de disponibilité nommé « MainAG ». Cet écouteur acquiert une adresse IP virtuelle à l’aide de DHCP. Exécutez cette commande sur l’instance de serveur qui héberge le réplica principal.

Exemple 2 : Créer un écouteur pour un groupe de disponibilité qui a un port nondefault

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

Cette commande crée un écouteur de groupe de disponibilité nommé « MainListener » pour le groupe de disponibilité nommé « MainAG ». Comme dans l’exemple précédent, cet écouteur acquiert une adresse IP virtuelle à l’aide de DHCP. Cet exemple affecte le port 1434 sur lequel il écoute.

Exemple 3 : Créer un écouteur pour un groupe de disponibilité qui utilise DHCP

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

Cette commande crée un écouteur de groupe de disponibilité nommé « MainListener » pour le groupe de disponibilité nommé « MainAG ». Cet écouteur acquiert une adresse IP virtuelle dans le sous-réseau spécifié à l’aide de DHCP.

Exemple 4 : Créer un écouteur pour un groupe de disponibilité qui utilise une adresse statique

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

Cette commande crée un écouteur de groupe de disponibilité nommé « MainListener » pour le groupe de disponibilité nommé « MainAG ». Cet écouteur utilise l’adresse IPv4 spécifiée par le paramètre StaticIp comme adresse IP virtuelle.

Exemple 5 : Créer un script qui crée un écouteur

PS C:\> New-SqlAvailabilityGroupListener -Name "MainListener" -Path "SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MainAG" -Script

Cette commande crée un script Transact-SQL qui crée un écouteur de groupe de disponibilité nommé « MainListener » pour le groupe de disponibilité nommé « MainAG ». La commande ne crée pas d’écouteur.

Paramètres

-AccessToken

Jeton d’accès utilisé pour s’authentifier auprès de SQL Server, comme alternative à l’authentification utilisateur/mot de passe ou Windows.

Cela peut être utilisé, par exemple, pour se connecter à SQL Azure DB et SQL Azure Managed Instance à l’aide d’un Service Principal ou d’un Managed Identity.

Le paramètre à utiliser peut être une chaîne représentant le jeton ou un objet PSAccessToken tel qu’il est retourné en exécutant Get-AzAccessToken -ResourceUrl https://database.windows.net.

Ce paramètre est nouveau dans v22 du module.

Type:PSObject
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DhcpSubnet

Spécifie une adresse IPv4 et un masque de sous-réseau d’un réseau. L’écouteur détermine l’adresse sur ce réseau à l’aide de DHCP. Spécifiez l’adresse au format suivant : 192.168.0.1/255.255.255.255.0.

Si vous spécifiez ce paramètre, ne spécifiez pas le paramètre StaticIp.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Encrypt

Type de chiffrement à utiliser lors de la connexion à SQL Server.

Cette valeur est mappée à la propriété EncryptSqlConnectionEncryptOption sur l’objet SqlConnection du pilote Microsoft.Data.SqlClient.

Dans la version 22 du module, la valeur par défaut est Optional (pour la compatibilité avec v21). Dans la version 23+ du module, la valeur par défaut est « Obligatoire », ce qui peut créer une modification cassant pour les scripts existants.

Ce paramètre est nouveau dans v22 du module.

Type:String
Valeurs acceptées:Mandatory, Optional, Strict
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-HostNameInCertificate

Nom d’hôte à utiliser pour valider le certificat TLS/SSL SQL Server. Vous devez passer ce paramètre si votre instance SQL Server est activée pour Forcer le chiffrement et que vous souhaitez vous connecter à une instance à l’aide du nom d’hôte/shortname. Si ce paramètre est omis, le passage du nom de domaine complet (FQDN) à -ServerInstance est nécessaire pour se connecter à une instance SQL Server activée pour Forcer le chiffrement.

Ce paramètre est nouveau dans v22 du module.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-InputObject

Spécifie le groupe de disponibilité, en tant qu’objet AvailabilityGroup, auquel cette applet de commande attache l’écouteur.

Type:AvailabilityGroup
Position:2
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Name

Spécifie un nom pour l’écouteur.

Type:String
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Path

Spécifie le chemin d’accès du groupe de disponibilité auquel cette applet de commande attache un écouteur. Si vous ne spécifiez pas ce paramètre, cette applet de commande utilise l’emplacement de travail actuel.

Type:String
Position:2
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Port

Spécifie le port sur lequel l’écouteur écoute les connexions. Le port par défaut est le port TCP 1433.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ProgressAction

Détermine comment PowerShell répond aux mises à jour de progression générées par un script, une applet de commande ou un fournisseur, telles que les barres de progression générées par l’applet de commande Write-Progress. L’applet de commande Write-Progress crée des barres de progression qui affichent l’état d’une commande.

Type:ActionPreference
Alias:proga
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Script

Indique que cette applet de commande retourne un script Transact-SQL qui effectue la tâche effectuée par cette applet de commande.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-StaticIp

Spécifie un tableau d’adresses. Chaque entrée d’adresse est une adresse IPv4 et un masque de sous-réseau ou une adresse IPv6. L’écouteur écoute les adresses spécifiées par ce paramètre.

Si vous spécifiez ce paramètre, ne spécifiez pas le paramètre DhcpSubnet.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-TrustServerCertificate

Indique si le canal sera chiffré lors du contournement de la marche à pied de la chaîne de certificats pour valider l’approbation.

Dans la version 22 du module, la valeur par défaut est $true (pour la compatibilité avec v21). Dans v23+ du module, la valeur par défaut est « $false », ce qui peut créer une modification cassant pour les scripts existants.

Ce paramètre est nouveau dans v22 du module.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

Microsoft.SqlServer.Management.Smo.AvailabilityGroup