Connect-AadrmService
連接到 Rights Management。
Syntax
Connect-AadrmService
[-Credential <PSCredential>]
[-TenantId <Guid>]
[<CommonParameters>]
Connect-AadrmService
[-AccessToken <String>]
[-TenantId <Guid>]
[<CommonParameters>]
Description
注意
AADRM 模組中的這個 Cmdlet 現在已被取代。 在 2020 年 7 月 15 日之後,此 Cmdlet 名稱僅支援為 AIPService 模組中取代的別名。
如需詳細資訊,請參閱 概觀頁面。
Connect-AadrmService Cmdlet 會將您連線到租使用者的 Azure Rights Management 服務,以便您接著執行此服務的系統管理命令。 此 Cmdlet 也可供為您管理租用戶的合作夥伴公司使用。
您必須先執行此 Cmdlet,才能執行本課程模組中的其他 Rights Management Cmdlet。
若要連線到 Azure Rights Management 服務,請使用下列其中一個帳戶:
- Office 365租使用者的全域管理員。
- Azure 租使用者的全域管理員。 不過,此帳戶不能是 MICROSOFT 帳戶 (MSA) 或其他 Azure 租使用者。
- 租使用者中已使用 Add-AadrmRoleBasedAdministrator Cmdlet 授與 Azure Rights Management 系統管理許可權的使用者帳戶。
- Azure 資訊保護系統管理員、合規性系統管理員或合規性資料管理員的 Azure AD 系統管理員角色。
提示:如果您未提示您輸入認證,且看到錯誤訊息,例如 [若沒有認證就無法使用此功能],請確認 Internet Explorer 已設定為使用 Windows 整合式驗證。 如果未啟用此設定,請加以啟用、重新開機 Internet Explorer,然後重試 Rights Management 服務的驗證。
範例
範例 1:連線到 Azure RMS,並提示您輸入使用者名稱和其他認證
PS C:\> Connect-AadrmService
此命令會連線到 Rights Management 服務。 這是連線到 Azure Rights Management 的最簡單方式,方法是執行不含參數的 Cmdlet。
系統會提示您輸入使用者名稱和密碼。 如果您的帳戶設定為使用多重要素驗證,系統會提示您輸入替代的驗證方法,然後連線到服務。
如果您的帳戶設定為使用多重要素驗證,您必須使用此方法連線到 Azure RMS。
範例 2:使用預存認證連線到 Azure RMS
PS C:\>$AdminCredentials = Get-Credential "Admin@aadrm.contoso.com"
PS C:\> Connect-AadrmService -Credential $AdminCredentials
第一個命令會建立 PSCredential 物件,並將您指定的使用者名稱和密碼儲存在 $AdminCredentials 變數中。 當您執行此命令時,系統會提示您輸入所指定使用者名稱的密碼。
第二個命令會使用儲存在 $AdminCredentials中的認證來連線到 Rights Management 服務。 如果您中斷與服務的連接,並在變數仍在使用中時重新連線,只要重新執行第二個命令即可。
範例 3:使用權杖連線至 Azure RMS
PS C:\>[Reflection.Assembly]::LoadFile("C:\Program Files\WindowsPowerShell\Modules\AADRM\2.13.1.0\Microsoft.IdentityModel.Clients.ActiveDirectory.dll")
PS C:\> $clientId='90f610bf-206d-4950-b61d-37fa6fd1b224';
PS C:\> $resourceId = 'https://api.aadrm.com/';
PS C:\> $clientId='90f610bf-206d-4950-b61d-37fa6fd1b224';
PS C:\> $userName='admin@contoso.com';
PS C:\> $password='Passw0rd!';
PS C:\> $redirectUri = new-object System.Uri("https://aadrm.com/AADRMAdminPowershell");
PS C:\> $authority = "https://login.microsoftonline.com/common";
PS C:\> $authContext = New-Object Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext($authority);
PS C:\> $userCreds = New-Object Microsoft.IdentityModel.Clients.ActiveDirectory.UserCredential($userName, $password);
PS C:\> $authenticationResult = $authContext.AcquireToken($resourceId,$clientId,$userCreds);
PS C:\> Import-module aadrm
PS C:\> Connect-Aadrmservice -AccessToken $authenticationResult.AccessToken
此範例示範如何使用 AccessToken 參數連線到 Azure RMS,這可讓您在沒有提示的情況下進行驗證。 此連線方法會要求您指定用戶端識別碼 '90f610bf-206d-4950-b61d-37fa6fd1b224' 和資源識別碼 ' https://api.aadrm.com/ '。 連線開啟之後,您可以接著執行所需的 Azure RMS 系統管理命令。
確認這些命令會導致成功連線到 Azure RMS 服務之後,您可以從腳本以非互動方式執行這些命令。
請注意,此範例會在第一行的路徑中使用 AADRM 模組的版本號碼,因此您可能需要更新已安裝版本的這個號碼。 此外,此範例包含 「」 的使用者名稱 admin@contoso.com ,其密碼為 「Passw0rd!」,您必須加以變更。 在生產環境中,當您以非互動方式使用此連線方法時,請使用其他方法來保護密碼,使其不會以純文字儲存。 例如,使用ConvertTo-SecureString命令或使用金鑰保存庫將密碼儲存為秘密。
參數
-AccessToken
使用此參數,使用您從 Azure Active Directory 取得的權杖,使用用戶端識別碼 '90f610bf-206d-4950-b61d-37fa6fd1b224' 和資源識別碼 ' https://api.aadrm.com/ '來連線到 Azure RMS。 此連線方法可讓您以非互動方式登入 Azure RMS 服務。
若要取得存取權杖,請確定您從租使用者使用的帳戶未使用多重要素驗證 (MFA) 。 如需如何執行這項操作,請參閱範例 3。
您無法搭配 Credential 參數使用此參數。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
指定 PSCredential 物件。 若要取得 PSCredential 物件,請使用 Get-Credential Cmdlet。 如需詳細資訊,請鍵入 Get-Help Get-Cmdlet
。
此 Cmdlet 會提示您提供密碼。
如果您的帳戶已設定為使用多重要素驗證, (MFA) ,則您無法搭配 AccessToken 參數使用此參數。
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TenantId
指定租使用者 GUID。Cmdlet 會針對您由 GUID 指定的租使用者連線到 Rights Management。
如果您未指定此參數,Cmdlet 會連線到您帳戶所屬的租使用者。
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |