チュートリアル:PowerShell を使用して Microsoft Entra B2B コラボレーションユーザーを一括で招待する

[アーティクル]
02/08/2024

Microsoft Entra B2B コラボレーションを使用して外部パートナーと協力する場合は、ポータルまたは PowerWhell を使って複数のゲストユーザーを組織に同時に招待できます。このチュートリアルでは、PowerShell を使用して、外部ユーザーに招待状を一括送信する方法について説明します。具体的には、以下を実行します。

ユーザー情報を含むコンマ区切り値 (.csv) ファイルを準備する
PowerShell スクリプトを実行して招待状を送信する
ユーザーがディレクトリに追加されたことを確認する

Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。

前提条件

最新の Microsoft Graph PowerShell モジュールをインストールする

必ず最新バージョンの Microsoft Graph PowerShell モジュールをインストールしてください。

最初に、インストールされているモジュールを調べます。管理者特権で PowerShell を開き (管理者として実行)、次のコマンドを実行します。

Get-InstalledModule Microsoft.Graph

SDK の v1 モジュールを PowerShell Core または Windows PowerShell にインストールするには、次のコマンドを実行します。

Install-Module Microsoft.Graph -Scope CurrentUser

必要に応じて、-Scope パラメーターを使ってインストールのスコープを変更できます。これには管理者のアクセス許可が必要です。

Install-Module Microsoft.Graph -Scope AllUsers

ベータモジュールをインストールするには、次のコマンドを実行します。

Install-Module Microsoft.Graph.Beta

信頼されていないリポジトリからモジュールをインストールしていることを示すメッセージが表示される場合があります。これは、PSGallery リポジトリを信頼されたリポジトリとして事前に設定していない場合に発生します。 Y を押してモジュールをインストールします。

テスト用の電子メールアカウントを取得する

招待状の送信先となる、複数のテスト用の電子メールアカウントが必要です。このアカウントは、組織外にある必要があります。 gmail.com や outlook.com のアドレスなどのソーシャルアカウントを含む任意の種類のアカウントを使用できます。

CSV ファイルを準備する

Microsoft Excel で、被招待者のユーザー名と電子メールアドレスの一覧を含む CSV ファイルを作成します。列見出しとして Name と InvitedUserEmailAddress を必ず含めてください。

たとえば、次の形式のワークシートを作成します。

Screenshot that shows the csv file columns of Name and InvitedUserEmailAddress.

ファイルを C:\BulkInvite\Invitations.csv として保存します。

Excel をお持ちでない場合は、メモ帳などの任意のテキストエディターで CSV ファイルを作成できます。行ごとに値をコンマで区切って入力します。

次のコマンドを実行してテナントに接続します。

Connect-MgGraph -TenantId "<YOUR_TENANT_ID>"

たとえば、Connect-MgGraph -TenantId "11111111-aaaa-2222-bbbb-33333333" のようにします。テナントドメインも使用できますが、パラメーターは -TenantId のままです。たとえば、Connect-MgGraph -TenantId "contoso.onmicrosoft.com" のようにします。

メッセージが表示されたら、資格情報を入力します。

招待状を一括送信する

招待メールを送信するには、次の PowerShell スクリプトを実行します (c:\bulkinvite\invitations.csv は CSV ファイルのパスです)。

$invitations = import-csv c:\bulkinvite\invitations.csv

$messageInfo = New-Object Microsoft.Open.MSGraph.Model.InvitedUserMessageInfo

$messageInfo.customizedMessageBody = "Hello. You are invited to the Contoso organization."

foreach ($email in $invitations)
   {New-MgInvitation `
      -InvitedUserEmailAddress $email.InvitedUserEmailAddress `
      -InvitedUserDisplayName $email.Name `
      -InviteRedirectUrl https://myapps.microsoft.com `
      -InvitedUserMessageInfo $messageInfo `
      -SendInvitationMessage $true
   }

このスクリプトは、invitations.csv ファイル内の電子メールアドレスに招待状を送信します。次の例のようなユーザーごとの出力が表示されます。

Screenshot that shows PowerShell output that includes pending user acceptance.

ユーザーがディレクトリに存在することを確認する

招待されたユーザーが Microsoft Entra ID に追加されたことを確認するには、次のコマンドを実行します。

 Get-MgUser -Filter "UserType eq 'Guest'"

招待したユーザーが表示されていることを確認します。emailaddress#EXT#@domain 形式のユーザープリンシパル名 (UPN) になっています。たとえば、msullivan_fabrikam.com#EXT#@contoso.onmicrosoft.com では、contoso.onmicrosoft.com が招待状を送信した組織になります。

リソースをクリーンアップする

不要になったら、ディレクトリ内のテスト用のユーザーアカウントを削除できます。ユーザーアカウントを削除するには、次のコマンドを使用します。

 Remove-MgUser -UserId "<String>"

例: Remove-MgUser -UserId "11111111-aaaa-2222-bbbb-33333333"

次のステップ

このチュートリアルでは、組織の外部のゲストユーザーに招待状を一括送信しました。次に、ポータルでゲストユーザーを一括招待する方法と、そのユーザーに MFA を適用する方法について説明します。

ポータルを使用したゲストユーザーの一括招待

チュートリアル:PowerShell を使用して Microsoft Entra B2B コラボレーション ユーザーを一括で招待する