Set-OMEConfiguration

このコマンドレットは、クラウドベースのサービスでのみ使用できます。

Set-OMEConfiguration コマンドレットを使用してMicrosoft Purview Message Encryptionを構成します。

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

構文

Default (既定)

Set-OMEConfiguration
    [-Identity] <OMEConfigurationIdParameter>
    [-BackgroundColor <String>]
    [-Confirm]
    [-DisclaimerText <String>]
    [-EmailText <String>]
    [-ExternalMailExpiryInDays <Int32>]
    [-Image <Byte[]>]
    [-IntroductionText <String>]
    [-OTPEnabled <Boolean>]
    [-PortalText <String>]
    [-PrivacyStatementUrl <String>]
    [-ReadButtonText <String>]
    [-SocialIdSignIn <Boolean>]
    [-WhatIf]
    [<CommonParameters>]

説明

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

例 1

Set-OMEConfiguration -Identity "OME Configuration" -EmailText "Encrypted message enclosed." -PortalText "This portal is encrypted." -DisclaimerText "Encryption security disclaimer." -Image ([System.IO.File]::ReadAllBytes('C:\Temp\OME Logo.gif'))

この例では、"OME Configuration" という名前の既定の OME 構成に指定された値を構成します。

パラメーター

-BackgroundColor

適用対象: Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

BackgroundColor パラメーターは、背景色を指定します。 有効な値は次のとおりです。

  • 引用符で囲まれた HTML の 16 進数のカラー コード値 (#RRGGBB)。 たとえば、 "#FFFFFF" は白です。
  • 有効な色名の値。 たとえば、 yellow は #ffff00 です。 有効な色の名前の一覧については、「 背景色リファレンス」を参照してください。
  • $null (空白)。 この値が既定値です。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Confirm

適用対象: Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットに与える影響は、コマンドレットが続行する前に確認を必要とするかどうかによって異なります。

  • データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文-Confirm:$falseを使用して、確認プロンプトを省略できます。
  • 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値を指定せずに Confirm スイッチを指定すると、一時停止が発生し、続行する前にコマンドの確認を強制されます。

このコマンドレットには一時停止が組み込まれているため、 -Confirm:$false を使用して確認をスキップします。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:Cf

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DisclaimerText

適用対象: Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

DisclaimerText パラメーターは、暗号化されたメッセージを含むメールの免責事項テキストを指定します。 最大の長さは 1024 文字です。 値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。

既存のテキストを削除して既定値を使用するには、このパラメーターの値 $null を使用します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-EmailText

適用対象: Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

EmailText パラメーターは、暗号化された電子メール メッセージに付属する既定のテキストを指定します。 既定のテキストは、暗号化されたメッセージを表示するための指示の上に表示されます。 最大の長さは 1024 文字です。 値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。

既存のテキストを削除して既定値を使用するには、このパラメーターの値 $null を使用します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ExternalMailExpiryInDays

適用対象: Exchange Online

このパラメーターは、Microsoft 365 Advanced Message Encryption サブスクリプションでのみ使用できます。

ExternalMailExpiryInDays パラメーターは、Microsoft 365 ポータルで外部受信者が暗号化されたメッセージを使用できる日数を指定します。 有効な値は 0 から 730 の整数です。 値 0 は、メッセージの有効期限が切れないことを意味します。 既定値は 0 です。

既定の OME 構成では、このパラメーターの値を更新することはできません。 この値は、カスタマイズされた構成でのみ変更できます。

Get-OMEConfiguration コマンドレットの出力では、このパラメーターの値は ExternalMailExpiryInterval プロパティに表示されます。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Int32
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Identity

適用対象: Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

Identity パラメーターには、変更する OME 構成を指定します。 既定の OME 構成には、"OME Configuration" という ID 値があります。

パラメーターのプロパティ

型:OMEConfigurationIdParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:1
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Image

適用対象: Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

Image パラメーターは、電子メール メッセージと Microsoft 365 管理センターに表示される画像を識別してアップロードします。

このパラメーターの有効な値を指定するには、次の構文を使用してファイルをバイト エンコード オブジェクトに読み取る必要があります。 ([System.IO.File]::ReadAllBytes('<Path>\<FileName>'))。 このコマンドはパラメーター値として使用することも、出力を変数 ($data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')) に書き込み、変数をパラメーター値 ($data) として使用することもできます。

  • サポートされているファイル形式: .png、.jpg、.bmp、.tiff
  • ロゴ ファイルの最適なサイズ:40 KB 未満
  • ロゴ画像の最適な寸法: 170x70 ピクセル

既存の画像を削除して既定の画像を使用するには、このパラメーターの値 $null を使用します。

パラメーターのプロパティ

型:

Byte[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-IntroductionText

適用対象: Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

IntroductionText パラメーターは、送信者の名前とメール アドレスの横に表示されるテキストを指定します。 値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。

既存のテキストを削除して既定値を使用するには、このパラメーターの値 $null を使用します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-OTPEnabled

適用対象: Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

OTPEnabled パラメーターは、暗号化されたメッセージの表示にワンタイム パスコードの使用を受信者に許可するかどうかを指定します。 有効な値は次のとおりです。

  • $true: 受信者はワンタイム パスコードを使用して、暗号化されたメッセージを表示できます。 この値が既定値です。
  • $false: 受信者は、暗号化されたメッセージを表示するためにワンタイム パスコードを使用することはできません。 受信者は、Microsoft 365 の職場または学校アカウントを使用してサインインする必要があります。

パラメーターのプロパティ

型:Boolean
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-PortalText

適用対象: Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

PortalText パラメーターは、暗号化されたメール表示ポータルの上部に表示されるテキストを指定します。 最大の長さは 128 文字です。 値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。

既存のテキストを削除して既定値を使用するには、このパラメーターの値 $null を使用します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-PrivacyStatementUrl

適用対象: Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

PrivacyStatementUrl パラメーターは、暗号化された電子メール通知メッセージ内のプライバシーに関する声明リンクを指定します。

このパラメーターを使用しない場合、[プライバシーに関する声明] リンクは既定の Microsoft プライバシーに関する声明に移動します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ReadButtonText

適用対象: Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

ReadButtonText パラメーターは、[メッセージを読む] ボタンに表示されるテキストを指定します。 値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。

既存のテキストを削除して既定値を使用するには、このパラメーターの値 $null を使用します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-SocialIdSignIn

適用対象: Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

SocialIdSignIn パラメーターは、ユーザーが自分のソーシャル ネットワーク ID (Google、Yahoo、および Microsoft アカウント) を使用して Microsoft 365 管理センターで暗号化されたメッセージを表示できるようにするかどうかを指定します。 有効な値は次のとおりです。

  • $true: ソーシャル ネットワーク ID サインインが許可されています。 この値が既定値です。
  • $false: ソーシャル ネットワーク ID のサインインは許可されていません。 受信者がワンタイム パスコード、または Microsoft 365 の職場または学校アカウントを使用できるかどうかは、OTPEnabled パラメーターによって制御されます。

パラメーターのプロパティ

型:Boolean
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WhatIf

適用対象: Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン

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

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:wi

パラメーター セット

(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

このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。