Get-EntraContact
Microsoft Entra IDから連絡先を取得します。
構文
GetQuery (既定)
Get-EntraContact
[-Filter <String>]
[-All]
[-Top <Int32>]
[-Property <String[]>]
[-HasErrorsOnly]
[<CommonParameters>]
GetById
Get-EntraContact
-OrgContactId <String>
[-All]
[-Property <String[]>]
[-HasErrorsOnly]
[<CommonParameters>]
説明
Get-EntraContact コマンドレットは、Microsoft Entra IDから連絡先を取得します。
職場または学校アカウントを含む委任されたシナリオの場合、サインインしているユーザーは、サポートされているMicrosoft Entraロールまたは必要なアクセス許可を持つカスタム ロールを持っている必要があります。 この操作は、次の最小特権ロールでサポートされています。
- ディレクトリ 閲覧者: 基本プロパティの読み取り
- グローバルリーダー
- ディレクトリ製作者
- Intune 管理者
- ユーザー管理者
例
例 1: ディレクトリ内のすべての連絡先オブジェクトを取得する
Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact
DisplayName Id Mail MailNickname
----------- -- ---- ------------
Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact
Contoso Contact1 bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com Contoso Contact 1
Contoso Contact2 cccccccc-2222-3333-4444-dddddddddddd contact2@contoso.com Contoso Contact 2
Contoso Contact3 dddddddd-3333-4444-5555-eeeeeeeeeeee contact3@contoso.com Contoso Contact 3
次の使用例は、ディレクトリ内のすべての連絡先オブジェクトを取得します。
例 2: ディレクトリ内の特定の連絡先オブジェクトを取得する
Connect-Entra -Scopes 'OrgContact.Read.All'
$contact = Get-EntraContact -Filter "displayName eq 'Contoso Contact'"
Get-EntraContact -OrgContactId $contact.Id
DisplayName Id Mail MailNickname
----------- -- ---- ------------
Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact
この例では、ディレクトリ内の指定した連絡先を取得します。
-
-OrgContactIdパラメーターは、連絡先 ID を指定します。
例 3: ディレクトリ内のすべての連絡先オブジェクトを取得する
Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact -All
DisplayName Id Mail MailNickname
----------- -- ---- ------------
Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact
Contoso Contact1 bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com Contoso Contact 1
Contoso Contact2 cccccccc-2222-3333-4444-dddddddddddd contact2@contoso.com Contoso Contact 2
Contoso Contact3 dddddddd-3333-4444-5555-eeeeeeeeeeee contact3@contoso.com Contoso Contact 3
次の使用例は、ディレクトリ内のすべての連絡先を取得します。
例 4: ディレクトリ内の上位 2 つの連絡先オブジェクトを取得する
Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact -Top 2
DisplayName Id Mail MailNickname
----------- -- ---- ------------
Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact
Contoso Contact1 bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com Contoso Contact 1
この例では、ディレクトリ内の上位 2 つの連絡先を取得します。
-Limitのエイリアスとして-Topを使用できます。
例 5: DisplayName でディレクトリ フィルター内のすべての連絡先オブジェクトを取得する
Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact -Filter "displayName eq 'Contoso Contact'"
DisplayName Id Mail MailNickname
----------- -- ---- ------------
Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact
Contoso Contact1 bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com Contoso Contact 1
Contoso Contact2 cccccccc-2222-3333-4444-dddddddddddd contact2@contoso.com Contoso Contact 2
Contoso Contact3 dddddddd-3333-4444-5555-eeeeeeeeeeee contact3@contoso.com Contoso Contact 3
次の使用例は、指定した表示名を持つ連絡先を取得します。
例 6: サービス プロビジョニング エラーが発生した連絡先を取得する
Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact -HasErrorsOnly
DisplayName Id Mail ServiceProvisioningErrors
----------- -- ---- -------------------------
Failed Contact eeeeeeee-4444-5555-6666-ffffffffffff contact-error@contoso.com {@{ErrorDetail=...}}
この例では、サービス プロビジョニング エラーがある連絡先のみを取得します。
パラメーター
-All
すべてのページを一覧表示します。
パラメーターのプロパティ
| 型: | System.Management.Automation.SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Filter
OData v4.0 フィルター ステートメントを指定します。 このパラメーターは、返されるオブジェクトを制御します。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
GetQuery
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-HasErrorsOnly
サービス プロビジョニング エラーがある連絡先のみを返します。
パラメーターのプロパティ
| 型: | System.Management.Automation.SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-OrgContactId
Microsoft Entra IDの連絡先の ID を指定します。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | オブジェクト識別子 |
パラメーター セット
GetById
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Property
返されるプロパティを指定します。
パラメーターのプロパティ
| 型: | System.String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | Select |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Top
返されるレコードの最大数を指定します。
パラメーターのプロパティ
| 型: | System.Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | 極限 |
パラメーター セット
GetQuery
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。