Azure PowerShell を使用してユーザー割り当てマネージド ID を作成、一覧表示、削除する

Azure リソースのマネージド ID は、Azure Active Directory で管理される ID を Azure サービスに提供します。 この ID を使用すると、コード内に資格情報を埋め込む必要なく、Azure AD の認証をサポートするサービスに認証することができます。

この記事では、Azure PowerShell を使って、ユーザー割り当てマネージド ID を作成、一覧表示、削除する方法について説明します。

注意

この記事は、Azure Az PowerShell モジュールを使用するように更新されています。 Az PowerShell モジュールは、Azure と対話するために推奨される PowerShell モジュールです。 Az PowerShell モジュールの使用を開始するには、「Azure PowerShell をインストールする」を参照してください。 Az PowerShell モジュールに移行する方法については、「AzureRM から Az への Azure PowerShell の移行」を参照してください。

前提条件

  • Azure リソースのマネージド ID の基本点な事柄については、概要に関するセクションを参照してください。 システム割り当てマネージド ID とユーザー割り当てマネージド ID の違いを必ず確認してください
  • まだ Azure アカウントを持っていない場合は、無料のアカウントにサインアップしてから先に進んでください。
  • サンプル スクリプトを実行するには、次の 2 つのオプションがあります。
    • Azure Cloud Shell を使用します。これは、コード ブロックの右上隅にある [使ってみる] ボタンを使用して開くことができます。
    • Azure PowerShell を使用して、スクリプトをローカルで実行します。次のセクションの説明を参照してください。

ローカルで Azure PowerShell を構成する

この記事で、(Cloud Shell ではなく) ローカルで Azure PowerShell を使用するには、次の手順を実行します。

  1. 最新バージョンの Azure PowerShell をインストールします (まだインストールしていない場合)。

  2. Azure にサインインします。

    Connect-AzAccount
    
  3. PowerShellGet の最新バージョンをインストールします。

    Install-Module -Name PowerShellGet -AllowPrerelease
    

    次の手順に備えて、このコマンドを実行した後に現在の PowerShell セッションから Exit する必要がある場合があります。

  4. この記事のユーザー割り当てマネージド ID 操作を実行するために、Az.ManagedServiceIdentity モジュールのプレリリース バージョンをインストールします。

    Install-Module -Name Az.ManagedServiceIdentity -AllowPrerelease
    

ユーザー割り当てマネージド ID を作成する

ユーザー割り当てマネージド ID を作成するには、お使いのアカウントにマネージド ID 共同作成者ロールの割り当てが必要です。

ユーザー割り当てマネージド ID を作成するには、New-AzUserAssignedIdentity コマンドを使用します。 ResourceGroupName パラメーターにはユーザー割り当てマネージド ID を作成するリソース グループを指定し、-Name パラメーターにはその名前を指定します。 <RESOURCE GROUP> および <USER ASSIGNED IDENTITY NAME> パラメーターの値は、実際の値に置き換えます。

重要

ユーザー割り当て済みマネージド ID を作成するときは、英数字 (0-9、a-z、A-Z) とハイフン (-) のみがサポートされます。 仮想マシンまたは仮想マシン スケール セットへの割り当てが適切に動作するように、名前は 24 文字に制限されています。 詳細については、FAQ と既知の問題に関するページを参照してください。

New-AzUserAssignedIdentity -ResourceGroupName <RESOURCEGROUP> -Name <USER ASSIGNED IDENTITY NAME>

ユーザー割り当てマネージド ID を一覧表示する

ユーザー割り当てマネージド ID の一覧表示/読み取りには、お使いのアカウントにマネージド ID オペレーターロールまたはマネージド ID 共同作成者ロールの割り当てが必要です。

ユーザー割り当てマネージド ID を一覧表示するには、[Get-AzUserAssigned] コマンドを使います。 -ResourceGroupName パラメーターでは、ユーザー割り当てマネージド ID を作成したリソース グループを指定します。 <RESOURCE GROUP> は実際の値に置き換えます。

Get-AzUserAssignedIdentity -ResourceGroupName <RESOURCE GROUP>

応答内のユーザー割り当てマネージド ID には、キー Type に対して返された "Microsoft.ManagedIdentity/userAssignedIdentities" の値が含まれます。

Type :Microsoft.ManagedIdentity/userAssignedIdentities

ユーザー割り当てマネージド ID を削除する

ユーザー割り当てマネージド ID を削除するには、お使いのアカウントにマネージド ID 共同作成者ロールの割り当てが必要です。

ユーザー割り当てマネージド ID を削除するには、Remove-AzUserAssignedIdentity コマンドを使用します。 -ResourceGroupName パラメーターではユーザー割り当て ID を作成したリソース グループを指定し、-Name パラメーターではその名前を指定します。 <RESOURCE GROUP> および <USER ASSIGNED IDENTITY NAME> パラメーターの値は、実際の値に置き換えます。

Remove-AzUserAssignedIdentity -ResourceGroupName <RESOURCE GROUP> -Name <USER ASSIGNED IDENTITY NAME>

注意

ユーザー割り当てマネージド ID を削除しても、それが割り当てられていたリソースから参照が削除されることはありません。 ID の割り当ては、別に削除する必要があります。

次のステップ

Azure リソースの Azure PowerShell マネージド ID コマンドの詳細については、「Az.ManagedServiceIdentity」を参照してください。