Microsoft Entra PowerShell は、PowerShell から直接 Entra リソースを管理するための強力なツールです。
この記事は、モジュールを理解し、その中核となる概念を把握するのに役立ちます。
前提条件
サインイン
Microsoft Entra PowerShell の各コマンドレットは、1 つ以上のアクセス許可スコープによって保護されます。 PowerShell Microsoft Entra使用するには、サインインするユーザーは、使用する予定のコマンドレットに必要なアクセス許可スコープに同意する必要があります。
Connect-Entra コマンドレットでアクセス許可を指定します。 メッセージが表示されたら、テナントの管理者アカウントでサインインします。
Connect-Entra -Scopes 'User.Read.All'
Microsoft Entra PowerShell では、委任されたアクセスとアプリ専用アクセスの 2 種類の認証がサポートされています。 使用可能なすべてのオプションを確認するには、 認証シナリオを参照してください。
使用可能なコマンドを見つける
Microsoft Entra PowerShell コマンドレットは、Verb-Noun PowerShell の標準的な名前付け規則に従います。 動詞はアクションを記述し (例: New、 Get、 Set、 Remove)、名詞はリソースの種類 (例: User、 Group、 ServicePrincipal、 Device) を記述します。 Microsoft Entra PowerShell の名詞は、常にプレフィックス Entraで始まります。 標準動詞の完全な一覧については、 PowerShell コマンドの承認された動詞を参照してください。
Note
Beta コマンドレットの場合は、リソース名に Beta プレフィックスを追加します。 たとえば、ベータ版のGet-EntraBetaUserの代わりにGet-EntraUserを使用します。
次のコマンドを使用して、Microsoft Entra PowerShell モジュールで使用可能なすべてのコマンドを取得できます。
Get-Command -Module Microsoft.Entra*
たとえば、これを絞り込み、アプリケーションに関連するコマンドを検索するには、次のコマンドを実行します。
Get-Command -Module Microsoft.Entra* -Noun *application*
このコマンドは、アプリケーション リソースのモジュールに含まれるすべてのコマンドレット、関数、エイリアスを表示します。
CommandType Name Version Source
----------- ---- ------- ------
Function Add-EntraApplicationOwner 1.0.1 Microsoft.Entra
Function Get-EntraApplication 1.0.1 Microsoft.Entra
Function Get-EntraApplicationExtensionProperty 1.0.1 Microsoft.Entra
Function Get-EntraApplicationKeyCredential 1.0.1 Microsoft.Entra
Function Get-EntraApplicationLogo 1.0.1 Microsoft.Entra
Function Get-EntraApplicationOwner 1.0.1 Microsoft.Entra
Function Get-EntraApplicationPasswordCredential 1.0.1 Microsoft.Entra
コマンドでサポートされているプロパティとメソッドを表示する
既定の出力以外のプロパティを表示するには、次のコマンドを実行して、サポートされているすべてのプロパティを表示します。
Get-EntraUser -UserId 'rsmith@contoso.com' | Get-Member
このコマンドは、すべてのユーザー プロパティとメソッドを表示します。
accountEnabled NoteProperty bool accountEnabled=True
ageGroup NoteProperty object ageGroup=null
businessPhones NoteProperty Object[]
city NoteProperty string city=Bellevue
companyName NoteProperty object companyName=null
consentProvidedForMinor NoteProperty object
country NoteProperty string
createdDateTime NoteProperty datetime createdDateTime
creationType NoteProperty object creationType=null
deletedDateTime NoteProperty object deletedDateTime=null
DeletionTimestamp NoteProperty object DeletionTimestamp=null
department NoteProperty string department=Retail
DirSyncEnabled NoteProperty object DirSyncEnabled=null
displayName NoteProperty string displayName=Adele Vance
employeeHireDate NoteProperty object employeeHireDate=null
employeeId NoteProperty object employeeId=null
employeeLeaveDateTime NoteProperty object employeeLeaveDateTime=null
employeeOrgData NoteProperty object employeeOrgData=null
employeeType NoteProperty object employeeType=null
ヘルプを取得する
Microsoft Entra PowerShell コマンドレットのヘルプを見つけるには、Get-Help コマンドを使用して、構文、パラメーター、使用例など、特定のコマンドに関する詳細なヘルプを参照してください。
たとえば、 Get-EntraUser コマンドの詳細については、次のコマンドを実行します。
Get-Help Get-EntraUser -Detailed
このコマンドは、コマンドレットの説明、パラメーター、使用例、関連コマンドなど、詳細なヘルプ ドキュメントを提供し、さまざまなシナリオで効果的に使用する方法を理解するのに役立ちます。
基本を学ぶ
詳細なハウツー ガイドを使用して、Microsoft Entra PowerShell を使用して実践的な操作を行います。