ドメインを一覧表示する

名前空間: microsoft.graph

ドメイン オブジェクトの一覧を取得します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類	最小特権アクセス許可	より高い特権のアクセス許可
委任 (職場または学校のアカウント)	Domain.Read.All	Domain.ReadWrite.All、Directory.Read.All
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	Domain.Read.All	Domain.ReadWrite.All、Directory.Read.All

重要

職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーに、サポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 この操作では、次の最小特権ロールがサポートされています。

• ユーザー管理者
• ヘルプデスク管理者
• サービス サポート管理者
• 課金管理者
• メールボックスの管理者
• ディレクトリ リーダー
• ディレクトリ製作者
• AdHoc ライセンス管理者
• アプリケーション管理者
• セキュリティ閲覧者
• セキュリティ管理者
• 特権ロール管理者
• クラウド アプリケーション管理者
• カスタマー ロックボックス アクセス承認者
• Dynamics 365管理者
• Power BI 管理者
• Azure Information Protection 管理者
• Desktop Analytics管理者
• ライセンス管理者
• Microsoft マネージド デスクトップ管理者
• 特権認証管理者
• Teams 通信管理者
• Teams 通信サポート エンジニア
• 認証管理者
• Teams 通信サポート スペシャリスト
• Teams 管理者
• Insights 管理者
• コンプライアンス データ管理者
• セキュリティ オペレーター
• Kaizala 管理者
• グローバル閲覧者
• ボリューム ライセンス ビジネス センター ユーザー
• ボリューム ライセンス Service Center ユーザー
• モダン コマース管理者
• ビジネス向け Microsoft Store ユーザー
• ディレクトリレビュー担当者
• ドメイン名管理者
• ユーザー
• ゲスト ユーザー
• 制限付きゲスト ユーザー

HTTP 要求

GET /domains

オプションのクエリ パラメーター

このメソッドは、応答をカスタマイズするための OData クエリ パラメーターをサポートします。

注:

この API には、 パラメーターに関連する 既知 の $search 問題があります。

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
承諾	application/json;

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文内の ドメイン オブジェクトのコレクションを返します。

例

要求

HTTP

GET https://graph.microsoft.com/v1.0/domains

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Domains.GetAsync();

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

CLI

mgc domains list

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
domains, err := graphClient.Domains().Get(context.Background(), nil)

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DomainCollectionResponse result = graphClient.domains().get();

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let domains = await client.api('/domains')
	.get();

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->domains()->get()->wait();

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

PowerShell

Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgDomain

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.domains.get()

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

**注:*> - 読みやすくするために、ここに示されている応答オブジェクトが短縮される場合があります。

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "authenticationType": "authenticationType-value",
      "availabilityStatus": "availabilityStatus-value",
      "isAdminManaged": true,
      "isDefault": true,
      "isInitial": true,
      "isRoot": true,
      "id": "contoso.com",
      "supportedServices": [
        "Email",
        "OfficeCommunicationsOnline"
      ]
    }
  ]
}