Get-SqlInstance

  • Referenz
Modul:
SQLServer

Ruft ein SQL-Instanzobjekt für jede instance von SQL Server ab, die auf dem Zielcomputer vorhanden ist.

Syntax

Get-SqlInstance
   [[-Path] <String[]>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-SqlInstance
   [[-ServerInstance] <String[]>]
   [-Credential <PSCredential>]
   [-ConnectionTimeout <Int32>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-SqlInstance
   [-InputObject] <Server[]>
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Beschreibung

Das Cmdlet Get-SqlInstance ruft ein SQL-Instanz-Objekt für jede instance von SQL Server ab, die auf dem Zielcomputer vorhanden ist. Wenn der Name des instance von SQL Server angegeben wird, erhält das Cmdlet nur diesen spezifischen instance von SQL Server.

Beispiele

Beispiel 1: Abrufen eines SQL Server instance auf einem Computer

PS C:\> Get-SqlInstance -Credential -ServerInstance "Computer002\InstanceName"

Mit diesem Befehl wird die SQL Server instance namens InstanceName auf dem Computer computer002 abgerufen.

Beispiel 2: Abrufen von Instanzen von SQL Server auf mehreren Computern

PS C:\Users\matteot> @('Server1', 'Server2', 'Server3') | % { Get-SqlInstance -ServerInstance $_}

Instance Name                   Version    ProductLevel UpdateLevel
-------------                   -------    ------------ -----------
Server1                         11.0.6607  SP3          CU10
Server2                         12.0.5600  SP2          CU14
Server3                         13.0.1742  RTM          n/a

Mit diesem Befehl werden alle Instanzen von SQL Server abgerufen, die auf 3 diffenten Computern ausgeführt werden. Beachten Sie, dass die Ausgabe so formatiert ist, dass die Version, der ProductLevel und der ProductUpdateLevel (alias und abgekürzt mit "UpdateLevel") angezeigt werden, sofern verfügbar.

Parameter

-AccessToken

Das Zugriffstoken, das zur Authentifizierung bei SQL Server verwendet wird, als Alternative zur Benutzer-/Kennwort- oder Windows-Authentifizierung.

Dies kann z. B. verwendet werden, um eine Verbindung mit SQL Azure DB und SQL Azure Managed Instance mithilfe Service Principal von herzustellen Managed Identity.

Der zu verwendende Parameter kann entweder eine Zeichenfolge sein, die das Token darstellt, oder ein PSAccessToken Objekt, das durch ausführen Get-AzAccessToken -ResourceUrl https://database.windows.netzurückgegeben wird.

Dieser Parameter ist neu in v22 des Moduls.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionTimeout

Gibt die Anzahl der Sekunden an, die vor einem Timeoutfehler auf eine Serververbindung gewartet werden müssen. Der Timeoutwert muss einer ganzen Zahl zwischen 0 und 65.534 entsprechen. Wenn 0 angegeben wird, verursachen Verbindungsversuche kein Timeout.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Gibt ein PSCredential-Objekt für die Verbindung mit dem SQL Server an. Verwenden Sie zum Abrufen eines Anmeldeinformationsobjekts das Cmdlet Get-Credential. Weitere Informationen erhalten Sie, indem Sie Get-Help Get-Credential eingeben.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encrypt

Der Verschlüsselungstyp, der beim Herstellen einer Verbindung mit SQL Server verwendet werden soll.

Dieser Wert wird der Encrypt Eigenschaft SqlConnectionEncryptOption des SqlConnection-Objekts des Microsoft.Data.SqlClient-Treibers zugeordnet.

In v22 des Moduls ist Optional der Standardwert (aus Kompatibilität mit v21). In v23+ des Moduls lautet der Standardwert "Obligatorisch", wodurch möglicherweise eine Breaking Change für vorhandene Skripts entsteht.

Dieser Parameter ist neu in v22 des Moduls.

Type:String
Accepted values:Mandatory, Optional, Strict
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostNameInCertificate

Der Hostname, der beim Überprüfen des TLS/SSL-Zertifikats von SQL Server verwendet werden soll. Sie müssen diesen Parameter übergeben, wenn Ihr SQL Server instance für Verschlüsselung erzwingen aktiviert ist und Sie eine Verbindung mit einer instance mithilfe von hostname/shortname herstellen möchten. Wenn dieser Parameter nicht angegeben wird, ist das Übergeben des vollqualifizierten Domänennamens (Fully Qualified Domain Name, FQDN) an -ServerInstance erforderlich, um eine Verbindung mit einem für Die Verschlüsselung erzwingen aktivierten SQL Server instance herzustellen. Sie müssen diesen Parameter übergeben, wenn Ihr SQL Server instance für Verschlüsselung erzwingen aktiviert ist und Sie eine Verbindung mit einer instance mithilfe von hostname/shortname herstellen möchten. Wenn dieser Parameter nicht angegeben wird, ist das Übergeben des vollqualifizierten Domänennamens (Fully Qualified Domain Name, FQDN) an -ServerInstance erforderlich, um eine Verbindung mit einem für Die Verschlüsselung erzwingen aktivierten SQL Server instance herzustellen.

Dieser Parameter ist neu in v22 des Moduls.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Gibt ein SMO-Objekt (SQL Server Management Objects) an, das die SQL Server darstellt, für die dieses Cmdlet ausgeführt wird.

Type:Server[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

Gibt den Pfad des SQL Server an, auf dem dieses Cmdlet den Vorgang ausführt. Der Standardwert ist das aktuelle Arbeitsverzeichnis.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Script

Gibt an, dass dieses Cmdlet ein Transact-SQL-Skript zurückgibt, das die Aufgabe ausführt, die dieses Cmdlet ausführt.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerInstance

Gibt den Namen einer instance von SQL Server an. Geben Sie für die Standard-instance den Computernamen an. Verwenden Sie für benannte Instanzen das Format ComputerName\Instanzname.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TrustServerCertificate

Gibt an, ob der Kanal verschlüsselt wird, während das Durchlaufen der Zertifikatkette zur Überprüfung der Vertrauensstellung umgangen wird.

In v22 des Moduls ist $true der Standardwert (aus Kompatibilität mit v21). In v23+ des Moduls lautet der Standardwert "$false", wodurch möglicherweise eine Breaking Change für vorhandene Skripts entsteht.

Dieser Parameter ist neu in v22 des Moduls.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

System.String[]