Set-AuthServer
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
Set-AuthServer コマンドレットを使用して、パートナー アプリケーションが Microsoft Exchange によって認識されるトークンを取得するために使用できる承認サーバーを構成します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
AuthMetadataUrl
Set-AuthServer
[-Identity] <AuthServerIdParameter>
[-AuthMetadataUrl <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>]
説明
Exchange によって承認されたパートナー アプリケーションは、サーバー間認証を使用して認証された後にリソースにアクセスできます。 パートナー アプリケーションは、Exchange によって信頼された自己発行トークンを使用するか、Exchange によって信頼された承認サーバーを使用して認証できます。 New-AuthServer コマンドレットを使用して、Exchange で信頼された承認サーバー オブジェクトを作成できます。これにより、承認サーバーによって発行されたトークンを信頼できます。
Set-AuthServer コマンドレットを使用して、承認サーバーの有効化または無効化、AuthMetadataUrl パラメーターの変更、承認メタデータの更新を行います。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事ではコマンドレットのすべてのパラメーターを一覧表示しますが、割り当てられたアクセス許可にパラメーターが含まれていない場合は、一部のパラメーターにアクセスできない可能性があります。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Set-AuthServer ACS -Enabled $false
このコマンドは、承認サーバー ACS を無効にします。
パラメーター
-ApplicationIdentifier
適用対象: Exchange Server 2016、Exchange Server 2019
このパラメーターは、Exchange 2019 CU15 および Exchange 2016 CU23 の 2025 年 4 月 18 日修正プログラム更新プログラム (HU) で使用できます。
{{ Fill ApplicationIdentifier Description }}
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AppSecret
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AuthMetadataUrl
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
AuthMetadataUrl パラメーターは、認証サーバーの URL を指定します。 これは、Exchange Online organizationの AuthMetadataUrl にすることができます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AuthMetadataUrl
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
NativeClientAuthServer
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DomainController
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
パラメーターのプロパティ
| 型: | Fqdn |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DomainName
適用対象: Exchange Server 2016、Exchange Server 2019
このパラメーターは、Exchange Server 2016 (CU18 以降) および Exchange Server 2019 (CU7 以降) でのみ使用できます。
DomainName パラメーターは、クラウドベースのorganizationをマルチテナント Exchange ハイブリッド内の対応する AuthServer オブジェクトにリンクします。 このパラメーターは、構文 "___domain.onmicrosoft.com" を使用します。
たとえば、DomainName 値が contoso.onmicrosoft.com されている場合、AuthServer オブジェクトは contoso クラウドベースのorganizationに関連付けられます。
パラメーターのプロパティ
| 型: | MultiValuedProperty |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Enabled
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Enabled パラメーターは、認証サーバーを有効にするかどうかを指定します。 有効化された認証サーバーのみがトークンの発行および承認を実行できます。 認証サーバーを無効にすると、認証サーバーを使用するように構成されたパートナー アプリケーションでトークンを取得できなくなります。
Enabled パラメーターは、認証サーバーを有効にするかどうかを指定します。 有効な値は次のとおりです。
- $true: 承認サーバーによって発行された承認トークンが受け入れられます。 この値は既定値です
- $false: 承認サーバーは、承認トークンを発行したり受け入れたりしません。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Identity パラメーターは、変更する承認サーバー オブジェクトを指定します。 承認サーバーを一意に識別する任意の値を使用できます。 例:
- 名前
- 識別名 (DN)
- GUID
パラメーターのプロパティ
| 型: | AuthServerIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-IsDefaultAuthorizationEndpoint
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
IsDefaultAuthorizationEndpoint パラメーターは、このサーバーが既定の認証エンドポイントかどうかを指定します。 有効な値は次のとおりです。
$true: 承認サーバーの URL は、承認サーバーから OAuth アクセス トークンを取得する必要がある、呼び出し元のパートナー アプリケーションとアプリケーションにアドバタイズされます。
$false: 承認サーバーの URL はアドバタイズされません。 既定値は $false です。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
NativeClientAuthServer
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Name パラメーターは、承認サーバー オブジェクトの一意の名前を指定します。 最大の長さは 64 文字です。 値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RefreshAuthMetadata
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
RefreshAuthMetadata スイッチは、Exchange が指定された URL から認証メタデータを更新するかどうかを指定します。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
RefreshAuthMetadata
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-TrustAnySSLCertificate
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
TrustAnySSLCertificate スイッチを使用すると、Exchange は信頼されていない証明機関 (CA) からの証明書を受け入れます。 このスイッチで値を指定する必要はありません。
運用環境でのこのスイッチの使用はお勧めしません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AuthMetadataUrl
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
NativeClientAuthServer
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。