Get-SecurityPrincipal

リファレンス

モジュール:: ExchangePowerShell

適用対象:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

このコマンドレットは、オンプレミスの Exchange およびクラウドベースのサービスで使用できます。一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。

Get-SecurityPrincipal コマンドレットを使用して、セキュリティプリンシパルの一覧を返します。セキュリティプリンシパルは、ユーザーやセキュリティグループなどのエンティティであり、アクセス許可とユーザー権限を割り当てることができます。

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

構文

Get-SecurityPrincipal
   [[-Identity] <ExtendedSecurityPrincipalIdParameter>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IncludeDomainLocalFrom <SmtpDomain>]
   [-OrganizationalUnit <ExtendedOrganizationalUnitIdParameter>]
   [-ResultSize <Unlimited>]
   [-RoleGroupAssignable]
   [-Types <MultiValuedProperty>]
   [<CommonParameters>]

説明

Get-SecurityPrincipal コマンドレットは、Exchange 管理センターによって、受信者情報を表示するフィールドを設定するために使用されます。

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

例

例 1

Get-SecurityPrincipal -OrganizationalUnit OU=People,DC=Contoso,DC=com

この例では、People OU からセキュリティプリンシパルを取得します。

例 2

Get-SecurityPrincipal -Filter "Department -eq 'Legal'"

この例は、Filter パラメーターを使用して、Legal 部門からセキュリティプリンシパルを取得します。フィルター条件を満たすセキュリティプリンシパルのみが取得されます。

例 3

Get-SecurityPrincipal -Identity Administrator

この例は、Identity パラメーターで明示的に指定された 1 つのセキュリティプリンシパルを取得します。

例 4

Get-SecurityPrincipal -Types WellKnownSecurityPrincipal | Format-Table Name,SID -AutoSize

この例では、既知のセキュリティプリンシパルを取得し、Name および SID プロパティのみを結果に表示します。

パラメーター

-DomainController

このパラメーターは、オンプレミスの Exchange でのみ使用できます。

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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Filter

Filter パラメーターは、OPATH 構文を使用して、指定したプロパティと値で結果をフィルター処理します。検索条件は構文"Property -ComparisonOperator 'Value'"を使用します。

OPATH フィルター全体を二重引用符 " " で囲みます。フィルターにシステム値 (例えば、$true、$false、または $null) が含まれている場合は、代わりに単一引用符 ' ' を使用します。このパラメーターは文字列 (システムブロックではありません) ですが、波かっこ { } を使用することもできますが、これはフィルターに変数が含まれていない場合のみです。
Property はフィルタリング可能なプロパティです。 Exchange サーバーとExchange Onlineのフィルター可能なプロパティの詳細については、「Filter パラメーターのフィルター可能なプロパティ」を参照してください。
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 構文情報」を参照してください。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-Identity

Identity パラメーターには、セキュリティプリンシパルを指定します。このパラメーターを使用してセキュリティプリンシパルを明示的に指定する場合、その他のセキュリティプリンシパルが返されません。

Type:	ExtendedSecurityPrincipalIdParameter
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-IncludeDomainLocalFrom

このパラメーターは、オンプレミスの Exchange でのみ使用できます。

IncludeDomainLocalFrom パラメーターは、結果で指定された Active Directory ドメインの FQDN (たとえば、contoso.com) からドメインローカルグループを返すかどうかを指定します。

このパラメーターは、Filter または Identity パラメーターと併用することはできません。

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

-OrganizationalUnit

OrganizationalUnit パラメーターは、Active Directory 内のオブジェクトの場所に基づいて結果をフィルタリングします。指定された場所に存在するオブジェクトのみが返されます。このパラメーターの有効な入力値は、Get-OrganizationalUnit コマンドレットによって返される組織単位 (OU) またはドメインです。 OU またはドメインを一意に識別する、任意の値を使用できます。以下に例を示します。

名前
識別名 (DN)
識別名 (DN)
GUID

Type:	ExtendedOrganizationalUnitIdParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-ResultSize

ResultSize パラメーターは、返される結果の最大数を指定します。クエリに一致するすべてのリクエストを返す場合は、このパラメーターの値に unlimited を使用します。既定値は 1,000 です。

Type:	Unlimited
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-RoleGroupAssignable

RoleGroupAssignable スイッチは、RBAC 役割グループに割り当てることができるオブジェクトのみを返すことによって、セキュリティプリンシパルをフィルター処理します。このスイッチで値を指定する必要はありません。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-Types

Types パラメーターは、オブジェクトの型で結果をフィルター処理します。有効な値は次のとおりです。

コンピューター
GlobalSecurityGroup
Group
UniversalSecurityGroup
User
WellknownSecurityPrincipal

複数の値をコンマで区切って指定できます。

Type:	MultiValuedProperty
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

入力

Input types

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

出力

Output types

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

次の方法で共有