Set-AuthServer
此 cmdlet 仅适用于本地 Exchange。
使用 Set-AuthServer cmdlet 配置授权服务器,合作伙伴应用程序可以使用该服务器获取 Microsoft Exchange 识别的令牌。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
Set-AuthServer
[-Identity] <AuthServerIdParameter>
[-AuthMetadataUrl <String>]
[-TrustAnySSLCertificate]
[-Confirm]
[-DomainController <Fqdn>]
[-DomainName <MultiValuedProperty>]
[-Enabled <Boolean>]
[-Name <String>]
[-WhatIf]
[<CommonParameters>]
Set-AuthServer
[-Identity] <AuthServerIdParameter>
[-AuthMetadataUrl <String>]
[-IsDefaultAuthorizationEndpoint <Boolean>]
[-TrustAnySSLCertificate]
[-Confirm]
[-DomainController <Fqdn>]
[-DomainName <MultiValuedProperty>]
[-Enabled <Boolean>]
[-Name <String>]
[-WhatIf]
[<CommonParameters>]
Set-AuthServer
[-Identity] <AuthServerIdParameter>
[-RefreshAuthMetadata]
[-Confirm]
[-DomainController <Fqdn>]
[-DomainName <MultiValuedProperty>]
[-Enabled <Boolean>]
[-Name <String>]
[-WhatIf]
[<CommonParameters>]
说明
Exchange 授权的合作伙伴应用程序在使用服务器到服务器身份验证进行身份验证后可以访问其资源。 合作伙伴应用程序可以使用 Exchange 信任的自颁发令牌或使用 Exchange 信任的授权服务器进行身份验证。 可以使用 New-AuthServer cmdlet 在 Exchange 中创建受信任的授权服务器对象,该对象允许它信任授权服务器颁发的令牌。
使用 Set-AuthServer cmdlet 启用或禁用授权服务器、更改 AuthMetadataUrl 参数或刷新授权元数据。
您必须先获得权限,然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数,但如果这些参数并未包含在分配给您的权限中,那么您将无法使用这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet。
示例
示例 1
Set-AuthServer ACS -Enabled $false
此命令禁用授权服务器 ACS。
参数
-AuthMetadataUrl
AuthMetadataUrl 参数指定授权服务器的 URL。 这可以是Exchange Online组织的 AuthMetadataUrl。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Confirm
Confirm 开关指定是否显示确认提示。 此开关对 cmdlet 造成的影响取决于在你继续操作之前 cmdlet 是否需要确认。
- 破坏性 cmdlet (例如,Remove-* cmdlet) 具有内置的暂停,该暂停会强制你在继续操作之前确认命令。 对于这些 cmdlet,您可以使用此确切语法跳过确认提示:
-Confirm:$false
。 - 大多数其他 cmdlet (例如,New-* 和 Set-* cmdlet) 没有内置暂停。 对于这些 cmdlet,指定不含值的 Confirm 开关会引入暂停,从而强制要求你先确认命令,然后再继续操作。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-DomainController
DomainController 参数指定此 cmdlet 从 Active Directory 读取数据或向其写入数据时使用的域控制器。 可以使用完全限定的域名 (FQDN) 来标识域控制器。 例如,dc01.contoso.com。
Type: | Fqdn |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-DomainName
此参数仅在 Exchange Server 2016 (CU18 或更高版本) 和 Exchange Server 2019 (CU7 或更高版本) 中可用。
DomainName 参数指定与 AuthServer 对象链接的租户域。 此参数使用语法:“tenantname.onmicrosoft.com”。
此参数用于将 Tenant 链接到多租户 Exchange 混合中的相应 authserver 对象。 例如,如果 DomainName contoso.onmicrosoft.com,则 AuthServer 对象将与 contoso 租户相关联。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-Enabled
Enabled 参数指定是否已启用授权服务器。 只有已启用的授权服务器才能颁发和接受令牌。 禁用授权服务器会阻止配置为使用授权服务器的任何合作伙伴应用程序获取令牌。
Enabled 参数指定是否已启用授权服务器。 有效值包含:
- $true:接受授权服务器颁发的授权令牌。 此为默认值
- $false:授权服务器不颁发或接受授权令牌。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Identity
Identity 参数指定要修改的授权服务器对象。 可以使用唯一标识授权服务器的任何值。 例如:
- 名称
- 可分辨名称 (DN)
- GUID
Type: | AuthServerIdParameter |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-IsDefaultAuthorizationEndpoint
IsDefaultAuthorizationEndpoint 参数指定此服务器是否为默认授权终结点。 有效值包含:
$true:授权服务器的 URL 将播发到调用合作伙伴应用程序和需要从授权服务器获取其 OAuth 访问令牌的应用程序。
$false:不会播发授权服务器的 URL。 默认值为 $false。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Name
Name 参数指定授权服务器对象的唯一名称。 最大长度为 64 个字符。 如果值中有空格,请使用双引号 (") 将此值括起来。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-RefreshAuthMetadata
RefreshAuthMetadata 开关指定 Exchange 是否应刷新指定 URL 中的身份验证元数据。 不必为此开关指定值。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-TrustAnySSLCertificate
TrustAnySSLCertificate 开关允许 Exchange 接受来自不受信任的证书颁发机构的证书, (CA) 。 不必为此开关指定值。
我们建议不要在生产环境中使用此开关。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-WhatIf
WhatIf 开关模拟命令操作。 可以使用此开关在不实际应用将会发生的更改的情况下预览这些更改。 不必为此开关指定值。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
输入
Input types
若要了解此 cmdlet 接受的输入类型,请参阅 cmdlet 的输入和输出类型。 如果 cmdlet 的"输入类型"字段为空,则表明此 cmdlet 不接受输入数据。
输出
Output types
若要了解此 cmdlet 接受的返回类型(亦称为"输出类型"),请参阅 cmdlet 的输入和输出类型。 如果"输出类型"字段为空,则表明此 cmdlet 不返回任何数据。