Get-SqlInstance
取得目標計算機上存在之每個 SQL Server 實例的 SQL Instance 物件。
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>] Description
Get-SqlInstance Cmdlet 會針對目標計算機上存在之每個 SQL Server 實例取得 SQL Instance 物件。 如果提供 SQL Server 實例的名稱，Cmdlet 只會取得此特定實例 SQL Server。
範例
範例 1：在計算機上取得 SQL Server 實例
PS C:\> Get-SqlInstance -Credential -ServerInstance "Computer002\InstanceName"此命令會在名為 Computer002 的電腦上取得名為 InstanceName 的 SQL Server 實例。
範例 2：取得多部計算機上的 SQL Server 實例
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此命令會取得在 3 個差異電腦上執行之 SQL Server 的所有實例。 請注意，輸出會格式化為在可用時顯示 Version、ProductLevel 和 ProductUpdateLevel (別名和縮寫為 “UpdateLevel”) 。
參數
-AccessToken
用來驗證 SQL Server 的存取令牌，作為使用者/密碼或 Windows 驗證的替代方案。
例如，這可用來連線至 SQL Azure DB 或使用 或使用 SQL Azure Managed InstanceService Principal 或 Managed Identity。
要使用的參數可以是字串，代表令牌或 PSAccessToken 執行 所傳 Get-AzAccessToken -ResourceUrl https://database.windows.net回的物件。
這個參數是模組 v22 的新功能。
| Type: | PSObject |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
在執行 Cmdlet 前提示您確認。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConnectionTimeout
指定在逾時失敗之前等候伺服器連線的秒數。 逾時值必須是介於 0 到 65534 之間的整數。 如果指定了 0，連線嘗試就不會逾時。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
指定與 SQL Server 連線的 PSCredential 物件。 若要取得認證物件，請使用 Get-Credential Cmdlet。 如需詳細資訊，請輸入 Get-Help Get-Credential。
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Encrypt
連接到 SQL Server 時要使用的加密類型。
這個值會對應至 Encrypt Microsoft.Data.SqlClient 驅動程式之 SqlConnection 物件上的 屬性 SqlConnectionEncryptOption 。
在模組的 v22 中，預設值為 Optional (，以便與 v21) 相容。 在模組 v23+ 中，預設值會是「強制」，這可能會為現有的腳本建立重大變更。
這個參數是模組 v22 的新功能。
| Type: | String |
| Accepted values: | Mandatory, Optional, Strict |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HostNameInCertificate
用於驗證 SQL Server TLS/SSL 憑證的主機名稱。 如果您的 SQL Server 實例已啟用強制加密，而且您想要使用主機名/shortname 連線到實例，則必須傳遞此參數。 如果省略此參數，則必須將完整域名 (FQDN) 傳遞至 -ServerInstance，才能連線到啟用強制加密的 SQL Server 實例。 如果您的 SQL Server 實例已啟用強制加密，而且您想要使用主機名/shortname 連線到實例，則必須傳遞此參數。 如果省略此參數，則必須將完整域名 (FQDN) 傳遞至 -ServerInstance，才能連線到啟用強制加密的 SQL Server 實例。
這個參數是模組 v22 的新功能。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
指定 SQL Server 管理物件 (SMO) 物件，此物件代表此 Cmdlet 運作所在的 SQL Server。
| Type: | Server[] |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Path
指定此 Cmdlet 執行作業所在的 SQL Server 路徑。 預設值為目前的工作目錄。
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Script
指出此 Cmdlet 會傳回 Transact-SQL 腳本，以執行此 Cmdlet 執行的工作。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServerInstance
指定實例的名稱 SQL Server。 針對預設實例，指定計算機名稱。 針對具名實例，請使用 ComputerName\InstanceName 格式。
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TrustServerCertificate
指出通道是否會在略過憑證鏈結以驗證信任時加密。
在模組的 v22 中，預設值為 $true (，以便與 v21) 相容。 在模組 v23+ 中，預設值會是 『$false』，這可能會為現有的腳本建立重大變更。
這個參數是模組 v22 的新功能。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
顯示執行 Cmdlet 後會發生的情況。 Cmdlet 並不會執行。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
輸入
System.String[]