Set-AuthServer

內部部署 Exchange 才有提供此 Cmdlet。

使用 Set-AuthServer Cmdlet 來設定授權伺服器,合作夥伴應用程式可用來取得 Microsoft Exchange 所辨識的權杖。

如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法

Syntax

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>]

Description

Exchange 授權的合作夥伴應用程式可以在使用伺服器對伺服器驗證進行驗證之後存取其資源。 合作夥伴應用程式可以使用 Exchange 信任的自我發行權杖,或使用 Exchange 信任的授權伺服器進行驗證。 您可以使用 New-AuthServer Cmdlet 在 Exchange 中建立受信任的授權伺服器物件,以允許它信任授權伺服器所簽發的權杖。

使用 Set-AuthServer Cmdlet 來啟用或停用授權伺服器、變更 AuthMetadataUrl 參數或重新整理授權中繼資料。

您必須已獲指派權限,才能執行此指令程式。 雖然本主題已列出這個指令程式的所有參數,不過,如果某些參數並未包含在指派給您的權限中,您可能就無法存取這些參數。 若要尋找在組織中執行任何 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

此參數僅適用于 2016 Exchange Server (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

若要查看此指令程式可接受的輸入類型,請參閱指令程式輸入和輸出類型。 如果指令程式的 [輸入類型] 欄位是空的,表示指令程式不接受輸入資料。

輸出

Output types

若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型),請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的,表示指令程式不會傳回資料。