Invoke-SqlNotebook
執行 SQL Notebook 檔案 （.ipynb），並輸出具體化的筆記本。
語法
Invoke-SqlNotebook
[-ServerInstance <Object>]
[-Database <Object>]
[-Username <Object>]
[-Password <Object>]
[-Credential <PSCredential>]
[-InputFile <Object>]
[-InputObject <Object>]
[-OutputFile <Object>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-Encrypt <String>]
[-HostNameInCertificate <String>]
[-Force]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Invoke-SqlNotebook
[-ConnectionString <Object>]
[-InputFile <Object>]
[-InputObject <Object>]
[-OutputFile <Object>]
[-Force]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Invoke-SqlNotebook
-InputFile <Object>
[-OutputFile <Object>]
[-Force]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Invoke-SqlNotebook
-InputObject <Object>
[-OutputFile <Object>]
[-Force]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Description
Invoke-SqlNotebook Cmdlet 會執行 SQL Notebook 檔案 （.ipynb），並輸出具體化的筆記本。
Notebook 將會在提供的 ServerInstance 和 Database 上執行。
執行 Cmdlet 時，產生的 Notebook 檔案將會位於使用者定義的位置，或位於輸入筆記本檔案的相同目錄中。
可能會省略 Cmdlet outfile：如果是這種情況，則會使用輸入檔名稱和附加至檔案的 _out 來建立。
範例
範例 1：對本地伺服器執行 Notebook（預設實例）
PS C:\> Invoke-SqlNotebook -ServerInstance localhost -Database TestNotebook -InputFile C:\notebook.ipynb
Directory: C:\
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 8/1/2019 1:00 PM 4656 notebook_out.ipynb此命令會針對執行 Cmdlet 之機器上執行之 SQL Server 的預設實例執行筆記本。 根據默認，由於未傳入任何 -OutputFile，具體化筆記本會儲存在磁碟上，其名稱與 InputFile 相同，_out 作為檔名後綴 （notebook.ipynb -> notebook_out.ipynb）
範例 2：在本機伺服器上執行 Notebook（defaut 實例），並將具體化的 Notebook 儲存至指定的檔案
PS C:\> Invoke-SqlNotebook -ServerInstance localhost -Database TestNotebook -InputFile C:\notebook.ipynb -OutputFile C:\new_notebook.ipynb
Directory: C:\
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 8/1/2019 1:00 PM 44656 new_notebook.ipynb此命令會針對執行 Cmdlet 之機器上執行之 SQL Server 的預設實例執行筆記本。 然後，執行中的筆記本會儲存至使用 -OutputFile 參數指定的檔案。
範例 3：使用 -ConnectionString 參數執行筆記本
PS C:\> Invoke-Sqlnotebook -ConnectionString 'Server=Localhost;Database=TestNotebook;Trusted_Connection=True;' -InputFile C:\notebook.ipynb
Directory: C:\
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 8/1/2019 1:00 PM 44656 notebook_out.ipynb這與範例 1 相同，只有透過 -ConnectionString 參數來指定與伺服器的連線。
範例 4：對所有已註冊的伺服器執行筆記本
dir 'SQLSERVER:\SQLRegistration\Database Engine Server Group' |
WHERE { $_.Mode -ne 'd'} |
foreach {
$datetime = Get-Date -Format yyyyMMddhhmm;
Get-SqlInstance -ServerInstance $_.Name |
foreach {
Invoke-SqlNotebook -ServerInstance $_.Name -Database master -InputFile '$home\Documents\SQL Server Management Studio\BPCheck.ipynb' `
-OutputFile "BPCheck_output_$($_.NetName)_$($datetime).ipynb";
}
}使用已註冊的伺服器或中央管理伺服器對多部伺服器執行 Invoke-SqlNotebook。
在此範例中，SQL Server 實例的 NetName 屬性會包含在輸出檔的名稱中;具體化的筆記本將會以年月-日-小時分鐘時間戳。
範例 5：執行 Notebook，在 Azure Data Studio 中開啟結果
從 Azure Data Studio 市集安裝 PowerShell 擴充功能。
使用 Azure Data Studio 中的 PowerShell 整合式主控台來執行 Invoke-SqlNotebook，並使用 Open-EditorFile 直接在 Azure Data Studio 中開啟 SQL Notebook 的結果。
Invoke-SqlNotebook -ServerInstance ServerA -Database master -InputFile "$home\Documents\SQL Server Management Studio\BPCheck.ipynb" |
Open-EditorFile注意：Open-EditorFile 命令只能在PowerShell整合式控制台中使用。
範例 6：執行 Notebook、使用服務主體連線到 Azure SQL Database （或受控實例）
Import-Module SQLServer
Import-Module Az.Accounts -MinimumVersion 2.2.0
### Obtain the Access Token interactively.
### Note: help for Invoke-Sqlcmd has examples on other ways to acquire the token.
Connect-AzAccount
$access_token = (Get-AzAccessToken -ResourceUrl https://database.windows.net).Token
# Now that we have the token, we use it to connect to the database 'mydb' on server 'myserver'
Invoke-SqlNotebook -ServerInstance myserver.database.windows.net -Database master -AccessToken $access_token`
-InputFile MyNotebook.ipynb參數
-AccessToken
用來向 SQL Server 驗證的存取令牌，作為使用者/密碼或 Windows 驗證的替代方案。
例如，這可以用來使用 Service Principal 或 Managed Identity 連線到 SQL Azure DB 和 SQL Azure Managed Instance（請參閱此頁面底部的參考）
在常見的案例中，這個參數是使用類似 (Get-AzAccessToken -ResourceUrl https://database.windows.net).Token 取得的（需要 Az.Account 模組）
使用此參數時，請勿指定 UserName、Password或 Credential。
| 類型: | PSObject |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-ConnectionString
指定要連線到伺服器的連接字串。
| 類型: | Object |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Credential
PSCredential 物件，其 [用戶名稱] 和 [密碼] 字段將用來連線到 SQL 實例。
| 類型: | PSCredential |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Database
此 Cmdlet 會連線到 ServerInstance 參數中所指定實例中的這個資料庫。
| 類型: | Object |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Encrypt
線上到 SQL Server 時要使用的加密類型。
此值會對應至 Microsoft.Data.SqlClient 驅動程式之 SqlConnection 物件上的 Encrypt 屬性 SqlConnectionEncryptOption。
在模組的 v22 中，預設值為 Optional （為了與 v21 相容）。 在模組的 v23+ 中，預設值會是 「強制」，這可能會為現有的腳本建立重大變更。
此參數是模組 v22 的新功能。
| 類型: | String |
| 接受的值: | Mandatory, Optional, Strict |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Force
根據預設，當 Cmdlet 將具體化筆記本寫入檔案時，會執行檢查以防止使用者意外覆寫現有的檔案。 使用 -Force 略過這項檢查，並允許 Cmdlet 覆寫現有的檔案。
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-HostNameInCertificate
用來驗證 SQL Server TLS/SSL 憑證的主機名。
此參數是模組 v22 的新功能。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-InputFile
指定將透過 Cmdlet 執行的 Notebook 檔案 （.ipynb）。
| 類型: | Object |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-InputObject
將 Notebook 指定為將做為輸入筆記本的 Json 字串。
| 類型: | Object |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-OutputFile
指定要儲存執行筆記本的所需輸出 Notebook 檔案。
| 類型: | Object |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Password
指定 Username 參數中指定的 SQL Server 驗證登入識別符密碼。
密碼會區分大小寫。 可能的話，請使用 Windows 驗證，或考慮改用 -Credential 參數。
如果您指定 Password 參數後面接著您的密碼，則任何可以看到您監視器的使用者都可以看見密碼。
如果您在 .ps1 文稿中撰寫密碼後接密碼，則任何讀取腳本檔案的人都會看到您的密碼。
將適當的NTFS許可權指派給檔案，以防止其他使用者讀取檔案。
| 類型: | Object |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-ProgressAction
決定 PowerShell 如何回應腳本、Cmdlet 或提供者所產生的進度更新，例如 Write-Progress Cmdlet 所產生的進度列。 Write-Progress Cmdlet 會建立顯示命令狀態的進度列。
| 類型: | ActionPreference |
| 別名: | proga |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-ServerInstance
指定指定 Database Engine 實例名稱的字元字串或 SQL Server 管理物件 （SMO） 物件。
| 類型: | Object |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-TrustServerCertificate
指出通道是否會在略過憑證鏈結以驗證信任時加密。
在模組的 v22 中，預設值為 $true （為了與 v21 相容）。 在模組的 v23+ 中，預設值會是 『$false』，這可能會為現有的腳本建立重大變更。
此參數是模組 v22 的新功能。
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Username
指定對 Database Engine 實例進行 SQL Server 驗證連線的登入標識碼。
密碼必須透過Password參數指定。
如果未指定 Username 和 Password，此 Cmdlet 會嘗試使用執行 Windows PowerShell 會話的 Windows 帳戶進行 Windows 驗證連線。 可能的話，請使用 Windows 驗證。
| 類型: | Object |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
輸入
System.Object
System.Management.Automation.PSCredential
輸出
System.Object
備註
可視化具體化筆記本的好方法是使用 Azure Data Studio。