Get-ExchangeSettings

  • リファレンス
モジュール:
ExchangePowerShell
適用対象:
Exchange Server 2016, Exchange Server 2019

このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。

Get-ExchangeSettings コマンドレットを使用して、Active Directory に格納されているカスタマイズされた Exchange 設定オブジェクトを表示します。 New-ExchangeSettings を使用して設定オブジェクトを作成し、Set-ExchangeSettings コマンドレットを使用して実際の設定を定義します。

以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。

構文

Get-ExchangeSettings
   [[-Identity] <ExchangeSettingsIdParameter>]
   [-ConfigName <String>]
   [-Database <DatabaseIdParameter>]
   [-Diagnostic]
   [-DiagnosticArgument <String>]
   [-DomainController <Fqdn>]
   [-Force]
   [-GenericScopeName <String>]
   [-GenericScopes <String[]>]
   [-GenericScopeValue <String>]
   [-Organization <OrganizationIdParameter>]
   [-Process <String>]
   [-Server <ServerIdParameter>]
   [-User <Guid>]
   [<CommonParameters>]

説明

このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。

例

例 1

Get-ExchangeSettings

次の使用例は、すべての Exchange 設定オブジェクトの概要リストを返します。

例 2

Get-ExchangeSettings -Identity Audit | Format-List

次の使用例は、すべての Exchange 設定オブジェクトの概要リストを返します。

パラメーター

-ConfigName

ConfigName パラメーターは、指定したプロパティ名で結果をフィルター処理します。 指定した値は EffectiveSetting プロパティで表示されます。

使用可能な値は、Exchange 設定オブジェクトのスキーマによって決まります。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-Database

Database パラメーターは、メールボックス データベースによって結果をフィルター処理します。 データベースを一意に識別する、任意の値を使用できます。 以下に例を示します。

  • 名前
  • 識別名 (DN)
  • ExchangeLegacyDN
  • GUID
Type:DatabaseIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-Diagnostic

Diagnostic スイッチは、非常に詳細な情報を結果に入れて戻すかどうかを指定します。 このスイッチで値を指定する必要はありません。

詳細情報は DiagnosticInfo プロパティに表示されます。

通常、このスイッチは、問題をトラブルシューティングするために Microsoft カスタマー サービスおよびサポートからの要請があった場合に限り使用してください。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-DiagnosticArgument

DiagnosticArgument パラメーターは、Diagnostic スイッチを使用して返される結果を変更します。 通常、Diagnostic スイッチと DiagnosticArgument パラメーターは、問題をトラブルシューティングするために Microsoft カスタマー サービスおよびサポートからの要請があった場合に限り使用してください。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-DomainController

DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは 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 2016, Exchange Server 2019

-Force

[強制] スイッチは、警告メッセージまたは確認メッセージを非表示にします。 このスイッチで値を指定する必要はありません。

管理者の入力を求めることが不適切な場合に、このスイッチを使用してタスクをプログラムによって実行することができます。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-GenericScopeName

GenericScopeName パラメーターは、スコープによって結果をフィルター処理します。 使用可能な値は、Exchange 設定オブジェクトのスキーマによって決まります。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-GenericScopes

GenericScopes パラメーターは、範囲で結果をフィルター処理します。 使用可能な値は、Exchange 設定オブジェクトのスキーマによって決まります。 このパラメーターには、構文 "key1=value1","key2=value2", "keyN=valueN を使用します。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-GenericScopeValue

GenericScopeValue パラメーターは、GenericScopeName パラメーターで指定されたスコープの値によって結果をフィルター処理します。 使用可能な値は、Exchange 設定オブジェクトのスキーマによって決まります。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-Identity

Identity パラメーターは、Exchange 設定オブジェクトの名前を指定します。 オブジェクトを一意に識別する任意の値を使用できます。 次に例を示します。

  • 名前
  • 識別名 (DN)
  • GUID
Type:ExchangeSettingsIdParameter
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-Organization

このパラメーターは、Microsoft の内部使用のために予約されています。

Type:OrganizationIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-Process

Process パラメーターは、指定したプロセスによって結果をフィルター処理します。 使用可能な値は、Exchange 設定オブジェクトのスキーマによって決まります。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-Server

Server パラメーターは、Exchange サーバーによって結果をフィルター処理します。 サーバーを一意に識別する任意の値を使用できます。 次に例を示します。

  • 名前
  • 識別名 (DN)
  • ExchangeLegacyDN
  • GUID
Type:ServerIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-User

User パラメーターは、ユーザーによって結果をフィルター処理します。 ユーザーを GUID 値で識別します (たとえば、87246450-1b19-4c81-93dc-1a4200eff66c)。 ユーザーの GUID を見つけるには、次のコマンドを実行します。 Get-User <UserIdentity> | Format-List Name,GUID

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019