你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Set-AIPAuthentication

设置 Azure 信息保护 客户端的身份验证凭据。

语法

Set-AIPAuthentication
   [-AppId <Guid>]
   [-AppSecret <String>]
   [-TenantId <String>]
   [-DelegatedUser <String>]
   [-OnBehalfOf <PSCredential>]
   [<CommonParameters>]

说明

Set-AIPAuthentication cmdlet 使用访问令牌设置凭据,以便你可以以其他用户身份登录,还可以以非交互方式使用标记 cmdlet。

例如:

  • 你希望使用 Azure 信息保护 扫描程序持续发现多个数据存储中的文件,并自动标记和保护文件。
  • 你想要运行计划的 PowerShell 脚本,该脚本使用 Set-AIPFileClassificationSet-AIPFileLabel cmdlet 自动标记和保护文件服务器上的文件。
  • 你有一个数据丢失防护 (DLP) 解决方案,你希望通过自动标记和保护此解决方案识别的文件来增强该解决方案。

使用或不带参数运行

如果在没有参数的情况下运行此 cmdlet,帐户将获取有效期为 90 天或密码过期的 Azure AD 访问令牌。

若要控制访问令牌的过期时间,请在运行此 cmdlet 时使用参数。 这使你可以将访问令牌配置为 1 年、2 年或永不过期。 此配置要求在 Azure Active Directory 中注册一个或多个应用程序。

有关详细信息,请参阅 为 AIP 统一标记客户端以非交互方式标记文件

统一标记客户端支持 OnBehalfOf 参数,该参数接受包含指定 Windows 用户名和密码的存储变量。

使用 DelegatedUser 参数在 Azure Active Directory 中指定一个用户帐户,该帐户从标记管理中心分配了一个或多个标签策略。

示例

示例 1:不使用在 Azure Active Directory 中注册的应用程序的情况下设置身份验证凭据

PS C:\> Set-AIPAuthentication 
Acquired access token

此命令会提示你输入用于获取有效 90 天或密码过期的访问令牌的 Azure AD 凭据。

示例 2:仅 (统一标记客户端) 使用在 Azure Active Directory 中注册的应用程序设置身份验证凭据

PS C:\>$pscreds = Get-Credential CONTOSO\scanner
PS C:\> Set-AIPAuthentication -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 变量中。 运行此命令时,系统会提示输入指定用户名的密码。

第二个命令获取与应用程序组合的访问令牌,以便根据 Azure AD 中已注册应用的配置,令牌的有效期为 1 年、2 年或永不过期。 的用户名scanner@contoso.com设置用户上下文以从标签管理中心下载标签和标签策略,例如Office 365安全 & 合规中心。

参数

-AppId

相关内容: 仅限 AIP 统一标记客户端

为在 Azure AD 中注册的应用指定“应用程序 (客户端) ID”。

类型:Guid
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-AppSecret

相关内容: 仅限 AIP 统一标记客户端

指定在 Azure AD 中注册应用时生成的客户端机密值。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DelegatedUser

相关内容: 仅限 AIP 统一标记客户端

指定从标签管理中心下载带有敏感度标签的标签策略时要使用的用户帐户凭据。

  • 使用的凭据必须是可用于获取策略和联机配置的 Azure Active Directory 帐户。

    • 如果此帐户已同步到 Azure Active Directory,它可以是用于 ServiceUserCredentials 的 同一帐户,也可以是其他帐户。

    • 如果此帐户需要重新保护文件、从文件中删除保护或检查受保护的文件,请使其成为 Azure 信息保护的超级用户

  • 使用 UPN 设置此参数的值。 例如: scannerservice@contoso.com

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-OnBehalfOf

相关内容: 仅限 AIP 统一标记客户端

指定包含 AIP 统一标记客户端使用的凭据对象的变量。

当无法向计划的 PowerShell 命令授予登录权限时,将使用此参数。

  • 使用与运行扫描程序所用的相同凭据,该凭据由 ServiceUserCredentials 参数定义。

  • 若要使用此参数,必须使用“ 以管理员身份运行 ”选项运行 PowerShell 会话。

使用 Get-Credential cmdlet 创建存储凭据的变量。 要了解详情,请键入 Get-Help Get-Cmdlet

类型:PSCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-TenantId

相关内容: 仅限 AIP 统一标记客户端

指定包含 Azure AD 中已注册应用的租户 GUID。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输入

None

输出

System.Object