共用方式為

Set-SqlCredential

  • 參考
模組:
SQLServer

設定 SQL Credential 物件的屬性。

語法

Set-SqlCredential
   [-Identity] <String>
   [[-Secret] <SecureString>]
   [[-Path] <String>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-SqlCredential
   [-Identity] <String>
   [[-Secret] <SecureString>]
   [-InputObject] <Credential>
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Set-SqlCredential Cmdlet 會使用此 Cmdlet 設定 SQL Credential 物件的 Identity 和 password 属性。 此 Cmdlet 支援下列兩種作業模式：

  • 指定認證的路徑或位置，包括使用Path參數的認證名稱。
  • 將 Smo.Credential 對象傳遞至使用 InputObject 參數的物件。

範例

範例 1：設定 SQL 認證物件的身分識別

PS C:\> Set-SqlCredential -Path SQLSERVER:\SQL\Computer\Instance\Credentials\MySqlCredential -Identity "MyStorageAccount"

此命令會藉由指定 SQL 認證的路徑，將 MySqlCredential 的身分識別設定為 MyStorageAccount。

範例 2：使用管線設定 SQL 認證物件的身分識別

PS C:\> $Cred = Get-SqlCredential -Name "MySqlCredential"
PS C:\> $Cred | Set-SqlCredential -Identity "MyStorageAccount"

第一個命令會從 Get-Credential Cmdlet 取得認證物件，並將結果儲存在名為 $Cred的變數中。

範例 3：設定提示使用者的 SQL 認證物件的身分識別

PS C:\> $Secret = Read-Host "Please enter the storage account access key"
PS C:\> Set-SqlCredential -Identity "MyStorageAccount" -Secret $Secret

第一個命令會提示記憶體存取金鑰資訊，並將結果儲存在名為 $Secret的變數中。

參數

-AccessToken

用來向 SQL Server 驗證的存取令牌，作為使用者/密碼或 Windows 驗證的替代方案。

例如，這可用來使用 Service Principal 或 Managed Identity來連線到 SQL Azure DB 和 SQL Azure Managed Instance。

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

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

類型:PSObject
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Confirm

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

類型:SwitchParameter
別名:cf
Position:Named
預設值:False
必要: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

-HostNameInCertificate

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

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

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Identity

指定 SQL Server 需要驗證的資源使用者或帳戶名稱。 針對 Windows Azure 記憶體服務，這是 Windows Azure 記憶體帳戶的名稱。

類型:String
Position:2
預設值:None
必要:True
接受管線輸入:False
接受萬用字元:False

-InputObject

指定輸入 Credential 物件。 若要取得此物件，請使用 Get-SqlCredential Cmdlet。

類型:Credential
Position:1
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-Path

指定此 Cmdlet 執行此作業的認證路徑。 例如，SQLSERVER:\SQL\Computer\Instance\Credentials\Credential。

類型:String
Position:1
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-ProgressAction

決定 PowerShell 如何回應腳本、Cmdlet 或提供者所產生的進度更新，例如 Write-Progress Cmdlet 所產生的進度列。 Write-Progress Cmdlet 會建立顯示命令狀態的進度列。

類型:ActionPreference
別名:proga
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Script

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

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Secret

指定使用者或帳戶的密碼。 針對 Windows Azure 記憶體服務，這是 Windows Azure 記憶體帳戶的存取密鑰值。

類型:SecureString
Position:3
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-TrustServerCertificate

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

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

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

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-WhatIf

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

類型:SwitchParameter
別名:wi
Position:Named
預設值:False
必要:False
接受管線輸入:False
接受萬用字元:False

輸入

Microsoft.SqlServer.Management.Smo.Credential