英語で読む

次の方法で共有


Microsoft Graph コマンド ライン インターフェイスの移動 (CLI)

Microsoft Graph API は巨大であり、常に成長しています。 そのため、Microsoft Graph コマンド ライン インターフェイス (CLI) のコマンドの数も多くなります。 達成する目的に適したコマンドを見つけることは困難な場合があります。特に、Microsoft Graph に慣れていない場合は困難です。 このトピックでは、特定のコマンドを見つけるのに役立ついくつかの方法について説明します。

注意

Microsoft Entra リソースに対する一部の要求では、高度なクエリ機能を使用する必要があります。 不適切な要求、サポートされていないクエリ、または $count クエリ パラメーターや ConsistencyLevel ヘッダーなど、予期しない結果を含む応答を示す応答を取得すると、要求が成功する可能性があります。 詳細と例については、「 ディレクトリ オブジェクトの高度なクエリ機能」を参照してください。

コマンドの名前付け規則

CLI のコマンドは REST API から直接生成されるため、名前は API の影響を受けます。 Microsoft Graph CLI を使用するために API の詳細を理解する必要はありませんが、名前付け規則を理解するのに役立ちます。

Microsoft Graph CLI コマンドは、Microsoft Graph のリソースと、それらのリソースに対して実行できるアクションを表します。 コマンドの一般的な構造は、次のパターンに従います。

mgc <path-to-resource> <action>

<path-to-resource>は、ターゲット API の URL 構造に従う 1 つ以上のコマンドです。 <action>はシーケンスの最後のコマンドであり、ターゲット リソースに対して実行するアクションを示します。

リソース コマンドへのパス

ターゲット リソースへのパスは、REST API によって指定されたリソースの URL を表す 1 つ以上のコマンドのシーケンスによって構築されます。 GET /meのような単純な API の場合、パスを表すには 1 つのコマンド (me) で十分です。

次に、 メッセージの取得 API というより複雑な例を見てみましょう。 この API の HTTP 要求を確認します。 URL に /me を含む要求を無視する場合、この API を呼び出すには、他に 2 つの方法があります。

GET /users/{id | userPrincipalName}/messages/{id}
GET /users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}

同等の CLI コマンドは、URL 内のセグメントにマップされます。 たとえば、最初の URL のセグメントは次のコマンドにマップされます。

  • /users にマップします users
  • /{id | userPrincipalName} マップは --user-id にマップされます (詳細については、以下を参照してください)
  • /messages にマップします messages
  • /{id} にマップします --message-id

これらすべてをまとめると、同等のコマンドが users messages --user-id <user-id> --message-id <message-id>されます。

コレクション内の項目へのアクセス

複数形の名詞を使用する API の URL セグメントは、コレクションを示します。 API がそのコレクション内の特定の項目に対して動作する場合、URL には ID を持つセグメントが含まれます。 前の例では、セグメント /users/{id | userPrincipalName} 組み合わせて、ユーザーのコレクション内の特定のユーザーにアクセスします。 これらの "ID セグメント" は、必要な ID オプションによって Microsoft Graph CLI で表され、 --<name of resource>-idのように名前が付けられます。 これらのオプションは、アクション コマンドの に表示されます。 --help オプションを使用して、特定のコマンドに必要なオプションを表示します。

操作コマンド

基本的な REST 操作の場合、動詞は API に使用される HTTP メソッドによって決定されます。

HTTP メソッド コマンド動詞
GET (単一項目) get mgc me get API リファレンス
GET (コレクション) list mgc users list API リファレンス
POST create mgc me messages create API リファレンス
PUT put mgc drives items content put API リファレンス
PATCH patch mgc me events patch API リファレンス
DELETE delete mgc drives items delete API リファレンス

前のセクションのメッセージ API の取得の例を考えてみましょう。 リソースへのパスは users messages で表され、この API の HTTP メソッドは GET で、1 つの項目を返します。 つまり、この API の結果のコマンドは mgc users messages get --user-id <user-id> --message-id <message-id>

パラメーターの一覧表示

適切なコマンドが見つかったら、 --help オプションを使用して、使用可能なすべてのパラメーターを調べることができます。 たとえば、次のコマンドは、 mgc users messages get コマンドで使用可能なすべてのパラメーターを一覧表示します。

mgc users messages get --help

使用可能なコマンドの検索

名前付け規則を知っているだけでは、適切なコマンドを推測できない場合があります。 この場合、 --help オプションを繰り返し使用して、CLI で使用可能なコマンドを検索できます。 たとえば、 mgc --help は、シーケンスの最初のコマンドとして有効な使用可能なコマンドの完全な一覧を返します。 使用可能なコマンドのいずれかを選択し、前のコマンドに追加して、次のレベルのコマンドを見つけることができます。

$ mgc --help
Description:
  Microsoft Graph CLI

Usage:
  mgc [command] [options] [[--] <additional arguments>...]]

Options:
  -?, -h, --help  Show help and usage information
  --version       Show version information

Commands:
  admin
  agreement-acceptances
  agreements
  app-catalogs
  applications
  ...

$ mgc applications --help
Description:
  Provides operations to manage the collection of application entities.

Usage:
  mgc applications [command] [options]

Options:
  -?, -h, --help  Show help and usage information

Commands:
  add-key                             Provides operations to call the addKey method.
  add-password                        Provides operations to call the addPassword method.
  app-management-policies             Provides operations to manage the appManagementPolicies property of the
                                      microsoft.graph.application entity.
  check-member-groups                 Provides operations to call the checkMemberGroups method.
  ...