Set-Authentication
設定 Microsoft Purview 資訊保護客戶端的驗證認證。
語法
Set-Authentication
[-AppId <Guid>]
[-AppSecret <String>]
[-TenantId <String>]
[-DelegatedUser <String>]
[-OnBehalfOf <PSCredential>]
[<CommonParameters>]
Description
Set-Authentication Cmdlet 會使用存取令牌來設定認證,讓您可以以不同的使用者身分登入,並以非互動方式使用卷標 Cmdlet。
例如:
- 您想要使用 Microsoft Purview 資訊保護 掃描器,持續探索並自動標記和保護多個數據存放區中的檔案。
- 您想要執行排程的 PowerShell 腳本,以使用 Set-FileLabel Cmdlet 自動標記及保護檔伺服器上的檔案。
- 您有數據外洩防護 (DLP) 解決方案,您想要藉由自動標記和保護此解決方案所識別的檔案來增強。
使用或不使用參數執行
如果您在沒有參數的情況下執行此 Cmdlet,則帳戶會取得有效 90 天或密碼到期之前的 Microsoft Entra 存取令牌。
若要控制存取權杖到期的時間,請搭配參數執行此 Cmdlet。 這可讓您設定存取令牌 1 年、2 年或永不過期。 這個設定要求您在 Microsoft Entra 中註冊一或多個應用程式。
Microsoft Purview 資訊保護 客戶端支援 OnBehalfOf 參數,其會接受包含您指定 Windows 使用者名稱和密碼的預存變數。
使用DelegatedUser參數,在 Microsoft Entra 中指定已從標籤管理中心指派一或多個標籤原則的用戶帳戶。
範例
範例 1:設定驗證認證,而不使用已在 Microsoft Entra 中註冊的應用程式
PS C:\> Set-Authentication
Acquired access token
此命令會提示您輸入用來取得存取令牌的 Microsoft Entra 認證,該認證有效期為90天,或直到密碼到期為止。
範例 2:使用已在 Microsoft Entra 中註冊的應用程式來設定驗證認證
PS C:\>$pscreds = Get-Credential CONTOSO\scanner
PS C:\> Set-Authentication -AppId "77c3c1c3-abf9-404e-8b2b-4652836c8c66" -AppSecret "OAkk+rnuYc/u+]ah2kNxVbtrDGbS47L4" -DelegatedUser scanner@contoso.com -TenantId "9c11c87a-ac8b-46a3-8d5c-f4d0b72ee29a" -OnBehalfOf $pscreds
Acquired application access token on behalf of CONTOSO\scanner.
使用 OnBehalfOf 參數所需的 [以系統管理員身分執行] 選項,在此 PowerShell 會話中執行命令。
第一個命令會建立 PSCredential 物件,並將指定的 Windows 使用者名稱和密碼儲存在 $pscreds 變數中。 當您執行此命令時,系統會提示您輸入您指定之使用者名稱的密碼。
第二個命令會取得與應用程式結合的存取令牌,以便根據您在 Microsoft Entra 中註冊的應用程式組態,令牌在 1 年、2 年或永遠不會過期。 的使用者名稱scanner@contoso.com會設定用戶內容,以從 Microsoft Purview 入口網站或 Microsoft Purview 合規性入口網站 下載標籤和標籤原則。
參數
-AppId
指定在 Microsoft Entra 中註冊之應用程式的「應用程式 (用戶端) 識別碼」。
類型: | Guid |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-AppSecret
指定應用程式在 Microsoft Entra 中註冊時所產生的客戶端密碼值。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-DelegatedUser
指定從標籤管理中心下載具有敏感度標籤的標籤原則時要使用的使用者帳戶認證。
所使用的認證必須是 Microsoft Entra 帳戶,可用來取得原則和在線設定。
如果此帳戶同步處理至 Microsoft Entra 或不同的帳戶,則它可以是用於 ServiceUserCredentials 的相同帳戶。
如果此帳戶需要重新保護檔案、從檔案移除保護,或檢查受保護的檔案,請讓它成為進階使用者以進行 Microsoft Purview 資訊保護。
使用UPN設定此參數的值。 例如:
scannerservice@contoso.com
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-OnBehalfOf
指定變數,其中包含 Microsoft Purview 資訊保護 用戶端所使用的認證物件。
當無法授與已排程 PowerShell 命令的登入許可權時,會使用此參數。
針對此參數使用相同的認證來執行掃描器,由 ServiceUserCredentials 參數所定義。
若要使用此參數,您必須使用 [ 以系統管理員身分 執行] 選項來執行 PowerShell 會話。
使用 Get-Credential Cmdlet 來建立儲存認證的變數。 如需詳細資訊,請鍵入 Get-Help Get-Cmdlet
。
類型: | PSCredential |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-TenantId
指定租使用者 GUID,其中包含您在 Microsoft Entra 中註冊的應用程式。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
輸入
None
輸出
System.Object