Set-AuthServer

模組:
Exchange PowerShell

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

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

如需下方＜語法＞一節中參數集的詳細資訊，請參閱 Exchange Cmdlet 語法。

語法

AuthMetadataUrl 

Set-AuthServer
    [-Identity] <AuthServerIdParameter>
    [-AuthMetadataUrl <String>]
    [-GraphBaseUrl <String>]
    [-TrustAnySSLCertificate]
    [-Confirm]
    [-DomainController <Fqdn>]
    [-DomainName <MultiValuedProperty>]
    [-Enabled <Boolean>]
    [-Name <String>]
    [-WhatIf]
    [<CommonParameters>]

NativeClientAuthServer 

Set-AuthServer
    [-Identity] <AuthServerIdParameter>
    [-AuthMetadataUrl <String>]
    [-IsDefaultAuthorizationEndpoint <Boolean>]
    [-TrustAnySSLCertificate]
    [-Confirm]
    [-DomainController <Fqdn>]
    [-DomainName <MultiValuedProperty>]
    [-Enabled <Boolean>]
    [-Name <String>]
    [-WhatIf]
    [<CommonParameters>]

RefreshAuthMetadata 

Set-AuthServer
    [-Identity] <AuthServerIdParameter>
    [-RefreshAuthMetadata]
    [-Confirm]
    [-DomainController <Fqdn>]
    [-DomainName <MultiValuedProperty>]
    [-Enabled <Boolean>]
    [-Name <String>]
    [-WhatIf]
    [<CommonParameters>]

AppSecret 

Set-AuthServer
    [-Identity] <AuthServerIdParameter>
    [-ApplicationIdentifier <String>]
    [-Confirm]
    [-DomainController <Fqdn>]
    [-DomainName <MultiValuedProperty]>]
    [-Enabled <Boolean>]
    [-Name <String>]
    [-WhatIf]
    [<CommonParameters>]

Description

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

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

您必須已獲指派權限，才能執行此指令程式。 雖然本文列出 Cmdlet 的所有參數，但如果指派給您的權限中未包含某些參數，您可能無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限，請參閱 Find the permissions required to run any Exchange cmdlet。

範例

範例 1

Set-AuthServer ACS -Enabled $false

此命令禁用授權伺服器 ACS。

參數

-ApplicationIdentifier

適用項目：Exchange Server 2016、Exchange Server 2019、Exchange Server SE

此參數可在適用於 Exchange 2019 CU15 和 Exchange 2016 CU23 的 HU) (2025 年 4 月 18 日 Hotfix 更新中取得。

{{ 填滿 ApplicationIdentifier 描述 }}

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AppSecret
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-AuthMetadataUrl

適用項目：Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

AuthMetadataUrl 參數會指定授權伺服器的 URL。 這可以是 Exchange Online 組織的 AuthMetadataUrl。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthMetadataUrl
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
NativeClientAuthServer
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Confirm

適用項目：Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Confirm 參數會指定要顯示或隱藏確認提示。 此參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續。

  • 破壞性的 Cmdlet (如 Remove-* cmdlets) 有內建暫停，它會先強迫您確認命令才會繼續作業。 對於這些 Cmdlet，您可以使用以下確切語法來略過確認提示：-Confirm:$false。
  • 其他大部分的 Cmdlet (如 New-* 和 Set-* cmdlets) 則沒有內建暫停。 針對這些 Cmdlet，指定不帶值的 Confirm 參數會造成暫停，強制您在繼續之前先確認命令。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:CF

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DomainController

適用項目：Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

DomainController 參數會指定此 Cmdlet 用來向 Active Directory 讀取或寫入資料的網域控制站。 您可以透過網域控制站的完整網域名稱 (FQDN) 來識別網域控制站。 例如，dc01.contoso.com。

參數屬性

類型:Fqdn
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DomainName

適用項目：Exchange Server 2016、Exchange Server 2019、Exchange Server SE

此參數僅適用於 Exchange Server 2016 (CU18 或更新) 和 Exchange Server 2019 (CU7 或更新) 。

DomainName 參數會將雲端式組織連結至多租用戶 Exchange 混合式中對應的 AuthServer 物件。 此參數使用語法：“domain.onmicrosoft.com”。

例如，如果 DomainName 值為 contoso.onmicrosoft.com，AuthServer 物件就會與 contoso 雲端組織相關聯。

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Enabled

適用項目：Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Enabled 參數會指定是否已啟用授權伺服器。 只有啟用的授權伺服器才能發行和接受權杖。 停用授權伺服器可防止設定為使用授權伺服器的任何合作夥伴應用程式取得權杖。

Enabled 參數會指定是否已啟用授權伺服器。 有效值為：

  • $true：接受授權伺服器所發出的授權權杖。 此值為預設值
  • $false：授權伺服器不會發行或接受授權權杖。

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-GraphBaseUrl

適用項目：Exchange Server 2019、Exchange Server SE

{{ 填滿 GraphBaseUrl 描述 }}

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthMetadataUrl
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Identity

適用項目：Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Identity 參數會指定您要修改的授權伺服器物件。 您可以使用唯一識別授權伺服器的任何值。 例如：

  • 名稱
  • 辨別名稱 (DN)
  • GUID

參數屬性

類型:AuthServerIdParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:1
必要:True
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-IsDefaultAuthorizationEndpoint

適用項目：Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

IsDefaultAuthorizationEndpoint 參數會指定此伺服器是否為預設授權端點。 有效值為：

$true：授權伺服器的 URL 會公告給呼叫合作夥伴應用程式，以及需要從授權伺服器取得其 OAuth 存取權杖的應用程式。

$false：不會公告授權伺服器的 URL。 預設值為 $false。

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

NativeClientAuthServer
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Name

適用項目：Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Name 參數會指定授權伺服器物件的唯一名稱。 最大長度為 64 個字元。 如果值包含空格，請使用引號 (") 括住值。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RefreshAuthMetadata

適用項目：Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

RefreshAuthMetadata 參數會指定 Exchange 是否應該從指定的 URL 重新整理驗證中繼資料。 您不需要使用此參數指定值。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

RefreshAuthMetadata
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-TrustAnySSLCertificate

適用項目：Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

TrustAnySSLCertificate 參數允許 Exchange 接受來自不受信任的憑證授權單位 (CA) 的憑證。 您不需要使用此參數指定值。

我們不建議在生產環境中使用此開關。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthMetadataUrl
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
NativeClientAuthServer
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-WhatIf

適用項目：Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

WhatIf 參數會顯示命令在不進行任何變更的情況下執行的動作。 您不需要使用此參數指定值。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:WI

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援常見參數： -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

輸入

Input types

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

輸出

Output types

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