Set-ExchangeSettings
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
New-ExchangeSettings コマンドレットを使用して作成した Exchange 設定オブジェクトを構成するには、Set-ExchangeSettings コマンドレットを使用します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Set-ExchangeSettings
[-Identity] <ExchangeSettingsIdParameter>
-Reason <String>
[-ClearHistory]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-WhatIf]
[<CommonParameters>]
Set-ExchangeSettings
[-Identity] <ExchangeSettingsIdParameter>
-ConfigName <String>
-ConfigValue <String>
-Reason <String>
[-UpdateSetting]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-GroupName <String>]
[-WhatIf]
[<CommonParameters>]
Set-ExchangeSettings
[-Identity] <ExchangeSettingsIdParameter>
-ConfigName <String>
-Reason <String>
[-RemoveSetting]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-GroupName <String>]
[-WhatIf]
[<CommonParameters>]
Set-ExchangeSettings
[-Identity] <ExchangeSettingsIdParameter>
-ExpirationDate <DateTime>
-Reason <String>
[-ConfigPairs <String[]>]
[-Confirm]
[-CreateSettingsGroup]
[-Disable]
[-DomainController <Fqdn>]
[-Force]
[-GroupName <String>]
[-MaxVersion <String>]
[-MinVersion <String>]
[-NameMatch <String>]
[-Priority <Int32>]
[-Scope <ExchangeSettingsScope>]
[-ScopeFilter <String>]
[-WhatIf]
[<CommonParameters>]
Set-ExchangeSettings
[-Identity] <ExchangeSettingsIdParameter>
-ExpirationDate <DateTime>
-GuidMatch <Guid>
-Reason <String>
[-ConfigPairs <String[]>]
[-Confirm]
[-CreateSettingsGroup]
[-Disable]
[-DomainController <Fqdn>]
[-Force]
[-GroupName <String>]
[-Priority <Int32>]
[-Scope <ExchangeSettingsScope>]
[-WhatIf]
[<CommonParameters>]
Set-ExchangeSettings
[-Identity] <ExchangeSettingsIdParameter>
-Reason <String>
-SettingsGroup <String>
[-CreateSettingsGroup]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-WhatIf]
[<CommonParameters>]
Set-ExchangeSettings
[-Identity] <ExchangeSettingsIdParameter>
-ExpirationDate <DateTime>
-Reason <String>
[-CreateSettingsGroup]
[-ConfigPairs <String[]>]
[-GenericScopeName <String>]
[-GenericScopeValue <String>]
[-GroupName <String>]
[-Confirm]
[-Disable]
[-DomainController <Fqdn>]
[-Force]
[-Priority <Int32>]
[-Scope <ExchangeSettingsScope>]
[-WhatIf]
[<CommonParameters>]
Set-ExchangeSettings
[-Identity] <ExchangeSettingsIdParameter>
-Reason <String>
[-ExpirationDate <DateTime>]
[-GroupName <String>]
[-UpdateSettingsGroup]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-Priority <Int32>]
[-ScopeFilter <String>]
[-WhatIf]
[<CommonParameters>]
Set-ExchangeSettings
[-Identity] <ExchangeSettingsIdParameter>
-Reason <String>
-ConfigPairs <String[]>
[-GroupName <String>]
[-RemoveSetting]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-WhatIf]
[<CommonParameters>]
Set-ExchangeSettings
[-Identity] <ExchangeSettingsIdParameter>
-Reason <String>
[-GroupName <String>]
[-RemoveSettingsGroup]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-WhatIf]
[<CommonParameters>]
Set-ExchangeSettings
[-Identity] <ExchangeSettingsIdParameter>
-Reason <String>
-SettingsGroup <String>
[-UpdateSettingsGroup]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-WhatIf]
[<CommonParameters>]
Set-ExchangeSettings
[-Identity] <ExchangeSettingsIdParameter>
-Reason <String>
-ConfigPairs <String[]>
[-GroupName <String>]
[-UpdateSetting]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-WhatIf]
[<CommonParameters>]
Set-ExchangeSettings
[-Identity] <ExchangeSettingsIdParameter>
-Reason <String>
[-EnableGroup <String>]
[-DisableGroup <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-WhatIf]
[<CommonParameters>]
説明
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Set-ExchangeSettings Audit -UpdateSetting -ConfigName AuditLogPumperEnabled -ConfigValue $true -Reason "Enable Unified Audit Logging"
この例では、統合監査ログの結果を表示することができます。 この例では、-Name Audit コマンドを実行して、監査構成スキーマの Exchange 設定オブジェクトNew-ExchangeSettings作成済みであることを前提としています。
パラメーター
-ClearHistory
ClearHistory スイッチは、Exchange 設定オブジェクトの変更履歴のエントリをクリアすることを指定します。 このスイッチで値を指定する必要はありません。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-ConfigName
ConfigName パラメーターは、Exchange 設定オブジェクトで追加、削除、または更新する使用可能な Exchange 設定を指定します。 このパラメーターの有効な値は、New-ExchangeSettings コマンドレットの Name パラメーターで指定された構成スキーマによって決まります。
追加および更新の操作については、ConfigValue パラメーターも使用して設定の実際の値を指定する必要があります。 ConfigName パラメーターは ConfigPairs パラメーターと併用できません。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-ConfigPairs
ConfigName パラメーターは、Exchange 設定オブジェクトで追加、削除、または更新する使用可能な Exchange 設定を指定します。 このパラメーターの有効な値は、New-ExchangeSettings コマンドレットの Name パラメーターで指定された構成スキーマによって決まります。 値の構文は です <Key>=<Value>
。 複数の値をコンマで区切って指定できます。
ConfigPairs パラメーターは、ConfigName または ConfigValue パラメーターと併用できません。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-ConfigValue
ConfigValue パラメーターは、ConfigName パラメーターで指定した Exchange 設定の値を指定します。 値は設定の種類 (数値、期間、$true、$false など) によって決まります。
ConfigValue パラメーターは ConfigPairs パラメーターと併用できません。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-Confirm
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- 破壊的なコマンドレット (Remove-* コマンドレットなど) には、続行する前にコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$false
を使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (New-* コマンドレットや Set-* コマンドレットなど) には、一時停止が組み込まれています。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-CreateSettingsGroup
CreateSettingsGroup スイッチは、Exchange 設定グループ (関連する Exchange 設定のグループ) を作成することを指定します。 このスイッチで値を指定する必要はありません。
設定グループの構成方法に応じて、GroupName パラメーターまたは SettingsGroup パラメーターを使用して、Exchange 設定グループの名前を指定します。 既存の設定グループの名前は変更できないため、慎重に選択してください。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-Disable
[無効] スイッチは、Exchange 設定グループが無効になっていることを指定します。 このスイッチで値を指定する必要はありません。
このスイッチは CreateSettingsGroup スイッチのみと併用できます。
このスイッチを使用して Exchange 設定グループを有効にするには、次の正確な構文を使用します -Disable:$false
。
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 |
-DisableGroup
DisableGroup パラメーターは、無効にする有効な Exchange 設定グループの名前を指定します。 値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。
DisableGroup パラメーターと EnableGroup パラメーターを同じコマンドで同時に使用して、異なる 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 |
-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 |
-EnableGroup
EnableGroup パラメーターは、有効にする無効な Exchange 設定グループの名前を指定します。 値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。
DisableGroup パラメーターと EnableGroup パラメーターを同じコマンドで同時に使用して、異なる 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 |
-ExpirationDate
ExpirationDate パラメーターは、指定した Exchange 設定グループによって定義される Exchange 設定の終了日時を指定します。
コマンドを実行するコンピューターの [地域のオプション] 設定で定義されている短い日付形式を使用します。 たとえば、短い日付形式 mm/dd/yyyy を使用するようにコンピューターが構成されている場合は、「09/01/2018」と入力して 2018 年 9 月 1 日を指定します。 日付のみを入力したり、日付と時刻を入力することもできます。 日付と時刻を入力する場合は、値を引用符 (”) で囲む必要があります (例: "09/01/2018 5:00 PM")。
ExpirationDate パラメーターは、CreateSettingsGroup または UpdateSettings グループ パラメーターでのみ使用できます。
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | True |
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 |
-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 |
-GroupName
GroupName パラメーターは、グループ操作の Exchange 設定グループの名前を指定します。 例:
- Exchange 設定グループを作成し、グループのスコープと優先度を同時に構成します。
- 既存の Exchange 設定グループの ExpirationDate、Priority、ScopeFilter の値を変更します。
- 既存の Exchange 設定グループを削除します。
- 既存の Exchange 設定グループ内の 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 |
-GuidMatch
GuidMatch パラメーターは、オブジェクトの GUID (メールボックス データベースの GUID など) に基づいて Exchange 設定グループのスコープを指定します。 このパラメーターは、Forest を除くすべての Scope パラメーター値で使用できます。
GuidMatch パラメーターは、GroupName パラメーターで CreateSettingsGroup スイッチを使用して Exchange 設定グループを作成する場合にのみ使用します。
このパラメーターは、GenericScopeName、GenericScopeValue、MaxVersion、MinVersion、NameMatch パラメーターと併用できません。
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-Identity
Identity パラメーターは、構成する Exchange 設定を含む既存の Exchange 設定オブジェクトの名前を指定します。
このパラメーターの値は、Exchange 設定オブジェクトの作成時に、New-ExchangeSetting コマンドレットの Name パラメーターの値です。
Type: | ExchangeSettingsIdParameter |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-MaxVersion
MaxVersion パラメーターは、オブジェクトのバージョン (たとえば、サーバーにインストールされている Exchange のバージョン) に基づいて Exchange 設定グループのスコープを指定します。 このパラメーターは、Forest を除くすべての Scope パラメーター値で使用できます。
MaxVersion パラメーターは、CreateSettingsGroup スイッチと GroupName パラメーターを使用して Exchange 設定グループを作成する場合にのみ、MinVersion パラメーターと共に使用します。
このパラメーターは GuidMatch、GenericScopeName、GenericScopeValue パラメーターと併用できません。
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 |
-MinVersion
MinVersion パラメーターは、オブジェクトのバージョン (たとえば、サーバーにインストールされている Exchange のバージョン) に基づいて Exchange 設定グループのスコープを指定します。 このパラメーターは、Forest を除くすべての Scope パラメーター値で使用できます。
MinVersion パラメーターは、CreateSettingsGroup スイッチと GroupName パラメーターを使用して Exchange 設定グループを作成する場合にのみ、MaxVersion パラメーターと共に使用します。
このパラメーターは GuidMatch、GenericScopeName、GenericScopeValue パラメーターと併用できません。
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 |
-NameMatch
NameMatch パラメーターは、オブジェクトの名前 (プロセス名など) に基づいて Exchange 設定グループのスコープを指定します。 このパラメーターは、Forest を除くすべての Scope パラメーター値で使用できます。
NameMatch パラメーターは、CreateSettingsGroup スイッチと GroupName パラメーターを使用して Exchange 設定グループを作成する場合にのみ使用します。
このパラメーターは GuidMatch、GenericScopeName、GenericScopeValue パラメーターと併用できません。
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 |
-Priority
Priority パラメーターは、Exchange 設定グループの優先順位を指定します。 すべてのグループの優先順位の値は一意である必要があります。 優先順位の値が低いほど、優先順位が高いことを意味します。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-Reason
Reason パラメーターは、Exchange 設定または設定グループが作成または変更された理由の説明を指定します。 値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-RemoveSetting
RemoveSetting スイッチは、Exchange 設定オブジェクトから既存の Exchange 設定を削除することを指定します。 このスイッチで値を指定する必要はありません。
削除する設定を指定するには、ConfigPairs パラメーターまたは ConfigName パラメーターを使用します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-RemoveSettingsGroup
RemoveSettingsGroup スイッチは、Exchange 設定グループを削除することを指定します。 このスイッチで値を指定する必要はありません。
GroupName パラメーターを使用して、削除する Exchange 設定グループを指定します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-Scope
Scope パラメーターは、Exchange 設定オブジェクトのスコープを指定します。 有効な値は次のとおりです。
- Dag
- Database
- Forest
- Generic
- 組織
- プロセス
- サーバー
- User
Type: | ExchangeSettingsScope |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-ScopeFilter
ScopeFilter パラメーターは、OPATH フィルター構文を使用して、Exchange 設定グループのスコープを基に指定します。 構文は です "Property -ComparisonOperator 'Value'"
(例: "ServerRole -like 'Mailbox*'"
)。
- OPATH フィルター全体を二重引用符 " " で囲みます。 フィルターにシステム値 (例えば、
$true
、$false
、または$null
) が含まれている場合は、代わりに単一引用符 ' ' を使用します。 このパラメーターは文字列 (システム ブロックではありません) ですが、波かっこ { } を使用することもできますが、これはフィルターに変数が含まれていない場合のみです。 - Property はフィルタリング可能なプロパティです。
- ComparisonOperator は OPATH 比較演算子です (たとえば
-eq
、等しい場合や-like
文字列比較の場合)。 比較演算子の詳細については、「about_Comparison_Operators」を参照してください。 - Value は、検索するプロパティ値です。 テキスト値と変数を一重引用符 (
'Value'
または'$Variable'
) で囲みます。 変数値に一重引用符が含まれている場合、変数を正しく展開するには、一重引用符を識別する (エスケープする) 必要があります。 たとえば、'$User'
の代わりに'$($User -Replace "'","''")'
を使用します。 整数またはシステム値を引用符で囲まないでください (代わりに、500
、$true
、$false
など$null
)。
論理演算子 -and
および -or
を使用すると、複数の検索条件を連結することができます。 たとえば、"Criteria1 -and Criteria2"
または "(Criteria1 -and Criteria2) -or Criteria3"
です。
Exchange の OPATH フィルターの詳細については、「 その他の OPATH 構文情報」を参照してください。
Scope パラメーターと値 Forest またはその他のスコープ関連パラメーターでは、このパラメーターを使用できません。
このパラメーターは、UpdateSettingsGroup スイッチと GroupName パラメーターを使用して 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 |
-SettingsGroup
SettingsGroup パラメーターは、新しい設定グループの作成または既存の設定グループの変更に使用される既存の Exchange 設定グループを指定します。
SettingsGroup パラメーターは GroupName パラメーターと併用できません。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-UpdateSetting
UpdateSetting スイッチは、既存の Exchange 設定オブジェクトの Exchange 設定を更新することを指定します。 このスイッチで値を指定する必要はありません。
ConfigPairs パラメーターまたは ConfigName パラメーターと ConfigValue パラメーターを使用して、Exchange 設定を構成します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-UpdateSettingsGroup
UpdateSettingsGroup スイッチは、Exchange 設定グループを変更することを指定します。 このスイッチで値を指定する必要はありません。
設定グループの構成方法に応じて、GroupName パラメーターまたは SettingsGroup パラメーターを使用して、変更する Exchange 設定グループを指定します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | 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 2016, Exchange Server 2019 |