共用方式為

Get-SqlInstance

模組:
SqlServer Module

取得目標計算機上每個 SQL Server 實例的 SQL Instance 物件。

語法

ByPath (預設值) 

Get-SqlInstance
    [[-Path] <String[]>]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByName 

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

ByObject 

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 Instance 或 。 Service PrincipalManaged Identity

要使用的參數可以是字串，表示令牌或 PSAccessToken 物件，如執行 Get-AzAccessToken -ResourceUrl https://database.windows.net所傳回。

此參數是模組 v22 的新功能。

參數屬性

類型:PSObject
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False
別名:cf

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ConnectionTimeout

指定要在逾時失敗前等候伺服器連線的秒數。 逾時值必須是介於 0 到 65534 之間的整數。 如果指定了 0，連線嘗試就不會逾時。

參數屬性

類型:Int32
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ByName
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Credential

指定連接 SQL Server 的 PSCredential 物件。 若要取得認證物件，請使用 Get-Credential Cmdlet。 如需詳細資訊，請輸入 Get-Help Get-Credential。

參數屬性

類型:PSCredential
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ByName
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Encrypt

線上到 SQL Server 時要使用的加密類型。

此值會對應至 Encrypt Microsoft.Data.SqlClient 驅動程式之 SqlConnection 物件上的 屬性 SqlConnectionEncryptOption 。

在模組的 v22 中，預設值為 Optional （為了與 v21 相容）。 在模組的 v23+ 中，預設值會是 「強制」，這可能會為現有的腳本建立重大變更。

此參數是模組 v22 的新功能。

參數屬性

類型:String
預設值:None
接受的值:Mandatory, Optional, Strict
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-HostNameInCertificate

用於驗證 SQL Server TLS/SSL 憑證的主機名稱。 如果您的 SQL Server 實例已啟用強制加密，而且您想要使用主機名/shortname 連線到實例，則必須傳遞此參數。 如果省略此參數，則必須將完整功能變數名稱 （FQDN） 傳遞至 -ServerInstance 才能連線到啟用強制加密的 SQL Server 實例。 如果您的 SQL Server 實例已啟用強制加密，而且您想要使用主機名/shortname 連線到實例，則必須傳遞此參數。 如果省略此參數，則必須將完整功能變數名稱 （FQDN） 傳遞至 -ServerInstance 才能連線到啟用強制加密的 SQL Server 實例。

此參數是模組 v22 的新功能。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-InputObject

指定 SQL Server 管理物件 （SMO） 物件，代表此 Cmdlet 運作所在的 SQL Server。

參數屬性

類型:

Server[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

ByObject
Position:1
必要:True
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Path

指定此 Cmdlet 執行作業的 SQL Server 路徑。 預設值為目前的工作目錄。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

ByPath
Position:1
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Script

指出此 Cmdlet 會傳回執行此 Cmdlet 所執行工作的 Transact-SQL 腳本。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ServerInstance

指定 SQL Server 實例的名稱。 針對預設實例，指定計算機名稱。 針對具名實例，請使用 ComputerName\InstanceName 格式。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

ByName
Position:1
必要:False
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-TrustServerCertificate

指出通道是否會在略過憑證鏈結以驗證信任時加密。

在模組的 v22 中，預設值為 $true （為了與 v21 相容）。 在模組的 v23+ 中，預設值會是 『$false』，這可能會為現有的腳本建立重大變更。

此參數是模組 v22 的新功能。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 指令未執行。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False
別名:無線

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

輸入

System.String