Azure Active Directory の PowerShell モジュール


こんにちは、 Azure ID チームの三浦です。今回は Azure Active Directory (Azure AD) PowerShell モジュールの種類、インストール方法についてご案内します。

Azure AD への操作は主に Azure ポータル、 Office 365 ポータル、 Graph API それに今回紹介します PowerShell からおこなうことができます。PowerShell モジュールについても複数ありますので、その種類をまず紹介します。

 

Azure AD PowerShell の種類

 Azure AD PowerShell には次のようなものがあります。

 

  1. MSOnline (Azure AD v1)

Office 365 をご利用いただいている方にとっては Office 365 のライセンスを割り当てるときにも利用しますので馴染み深いかもしれません。当初からあるもので、あとから紹介する Azure AD v2 と明示的に区別する際に Azure AD v1 モジュールとも呼びます。Connect-Msolservice のようにコマンドレットに “Msol” という文字列が含まれています。現状でも Azure AD に対する PowerShell を利用した操作では最もよく使われています。

 

  1. Azure AD for Graph (Azure AD v2)

当初は Azure AD の目的が Office 365 の認証基盤という意味合いが大きかったのですが、 Azure AD にどんどんと新しい機能が追加されることに伴い Azure AD PowerShell の機能も拡張していく必要がでてきました。その対応のために従来の MSOnline を拡張するのではなく、別途異なるモジュールを開発するというアプローチを取ることになり Azure AD for Graph (Azure AD v2 と言うほうが一般的で通りが良いので以降は Azure AD v2 とします) というモジュールが作成されました。基本的には MSOnline で提供していた機能は Azure AD v2 でも提供されます。例えばユーザー作成をおこなうときに MSOnline モジュールでは New-Msoluser というコマンドを使いますが、 Azure AD v2 では New-AzureADUser を利用するというような感じです。基本的に MSOL コマンドレットの拡張は予定されていないため、新しい機能などは Azure AD v2 のみで提供されます。というわけで今後は基本的に Azure AD v2 コマンドをご利用くださいと案内したいところなのですが、、、完全に MSOL コマンドで提供していたものをカバーしているわけではないため、残念なのですが (大変申し訳ないのですが)、従来の MSOL コマンドも併用していく必要があります。

 

  1. Azure AD for Graph preview (Azure AD v2 preview)

Azure AD v2 モジュールはかなり早いスピードで新しいコマンドが追加されています。なるべく早く新しいモジュールを提供できるようプレビュー版も用意しています。プレビュー版については実際の運用環境での利用は推奨していません。また、 Azure AD v2 の通常版 = General Availability 版がすでにインストールされている環境で通常版とプレビュー版を併用することはできず、 Preview 版をインストールするとプレビュー版が利用されます。

 

インストール方法について

<前提条件>

MSOnline (Azure AD v1) Azure AD v2 では前提となる .net Framework のバージョンが厳密には異なり、 MSOnline の場合には必ずしも必要にはならないのですが、古いものを利用していると問題が生じることがあるので、 Azure AD v1v2 を問わず、以下の前提条件を満たすようにしてください。

 

.NET Framework: バージョン 4.5 以降 (*1)

PowerShell: バージョン 5.0 以降 (*1)

OS: Windows 7 SP1 (*2) Windows Server 2008 R2 以降

 

*1 .NET Framework および PowerShell のバージョンについては、厳密にはこれを満たしていなくても動作するバージョンもありますが、モジュールのインストールのために 5.0 以降が必要になるほか、古いバージョンだと問題が生じることがあるので上記を満たすようにしてください。

*2 クライアント OS で利用する場合には 32 bit 環境ではなく 64 bit 環境の必要があります。

 

.NET Framework PowerShell のインストール方法、現在インストールされているバージョンの確認方法は次の通りです。

 

.NET Framework

以下のサイトから .NET Framework 4.5 をインストールします。

 

Microsoft .NET Framework 4.5

https://www.microsoft.com/ja-JP/download/details.aspx?id=30653

インストールを試みたときにすでにインストールされているという旨のメッセージが表示された場合にはすでにインストールされていますので不要です。

実際にインストール ウィザードを実行していなくとも .NET Framework でどのバージョンがインストールされているかは、 PowerShell のウィンドウを開き、次のコマンドを実行することで確認できます。

 

Get-ChildItem 'HKLM:\SOFTWARE\Microsoft\NET Framework Setup\NDP' -recurse | Get-ItemProperty -name Version,Release -EA 0 | Where { $_.PSChildName -match '^(?!S)\p{L}'} | Select PSChildName, Version, Release

 

 以下の例では 4.7.02046 という新しいバージョンがインストールされていることが確認できます (4.7 のバージョンは OS によっては追加のモジュールのインストールが必要なのでここでは 4.5 の紹介にしていますが、もちろん 4.7 のインストールで構いません)

PowerShell モジュール

PowerShell のバージョンを 5.0 以上にするために Windows Management Framework 5.0 を以下のサイトからダウンロードしてインストールします。

 

Windows Management Framework 5.0

URLhttps://www.microsoft.com/en-us/download/details.aspx?id=50395

 

システムの PowerShell のバージョンは $psversiontable で確認できます。

以下の例だと 5.1.15063.726 という、より新しいバージョンがインストールされていることが確認できます。

 

<Azure AD PowerShell インストール方法>

上記の前提条件を満たしたうえで、次の手順でインストールを実施します。

 

  1. 管理者で PowerShell を起動します。

 

  1. 下記のコマンドを実行し、モジュールをダウンロードします。

 

MSOnline (Azure AD v1):

Save-Module -Name MSOnline -Path "C:\Program Files\WindowsPowerShell\Modules\"

 

Azure AD for Graph (Azure AD v2):

Save-Module -Name AzureAD -Path "C:\Program Files\WindowsPowerShell\Modules\"

 

Azure AD for Graph preview (Azure AD v2 preview):

Save-Module -Name AzureADPreview -Path "C:\Program Files\WindowsPowerShell\Modules\"

 

-Path で指定するフォルダ名は上記以外の任意のものに指定できますが、存在するフォルダを指定する必要があります。

Nuget プロバイダーが必要というメッセージが表示された場合には Y をクリックして進めます。

※ 明示的にバージョン番号を指定する場合にはコマンドに -RequiredVersion 2.0.0.115 というようにバージョン情報を追加します。

MSOnline については、以下のサイトからインストールパッケージをダウンロードすることも可能です。

http://connect.microsoft.com/site1164/Downloads/DownloadDetails.aspx?DownloadID=59185

 

  1. 下記のコマンドを実行し、2. でダウンロードしたモジュールをインストールします。

 

MSOnline (Azure AD v1):

Install-Module -Name MSOnline

 

Azure AD for Graph (Azure AD v2):

Install-Module -Name AzureAD

 

Azure AD for Graph preview (Azure AD v2 preview):

Install-Module -Name AzureADPreview

 

以上です。

では、最後に参考資料をご紹介しまして今回の記事はここまでとします。

 

参考資料

Azure Active Directory PowerShell for Graph

https://docs.microsoft.com/ja-jp/powershell/azure/active-directory/install-adv2?view=azureadps-2.0

 

AzureAD (Azure AD v2 コマンド一覧)

https://docs.microsoft.com/en-us/powershell/azuread/v2/azureactivedirectory

 

AzureAD PowerShell's Profile (Azure AD PowerShell 最新版リスト。 V1 V2 V2Preview)

https://www.powershellgallery.com/profiles/AzureADPowerShell/

 

変更履歴

2017/12/04 公開しました。

2017/12/20 前提条件について追記を行いました。


Comments (0)

Skip to main content