获取域

命名空间：microsoft.graph

检索域对象的属性和关系。

此 API 可用于以下国家级云部署。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	✅	✅	✅

权限

为此 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 信息保护管理员
• 桌面分析管理员
• 许可证管理员
• Microsoft托管桌面管理员
• 特权身份验证管理员
• Teams 通信管理员
• Teams 通信支持工程师
• 身份验证管理员
• Teams 通信支持专家
• Teams 管理员
• Insights 管理员
• 合规数据管理员
• 安全操作员
• Kaizala 管理员
• 全局读取者
• 批量许可业务中心用户
• 批量许可服务中心用户
• 新式商务管理员
• 适用于企业的 Microsoft Store用户
• 目录审阅者
• 域名管理员
• 用户
• 来宾用户
• 受限来宾用户

HTTP 请求

GET /domains/{id}

对于 {id}，请使用其完全限定的域名指定该域。

可选的查询参数

此方法支持 OData 查询参数 来帮助自定义响应。

请求标头

名称	说明
Authorization	持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type	application/json

请求正文

请勿提供此方法的请求正文。

响应

如果成功，此方法在响应正文中返回响应 200 OK 代码和 域 对象。

示例

请求

HTTP

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

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["{domain-id}"].GetAsync();

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

CLI

mgc domains get --domain-id {domain-id}

有关如何将 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().ByDomainId("domain-id").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);

Domain result = graphClient.domains().byDomainId("{domain-id}").get();

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

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

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->domains()->byDomainId('domain-id')->get()->wait();

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PowerShell

Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgDomain -DomainId $domainId

有关如何将 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.by_domain_id('domain-id').get()

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

响应

注意：为了提高可读性，可能缩短了此处显示的响应对象。

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#domains/$entity",
    "authenticationType": "Managed",
    "availabilityStatus": null,
    "id": "contoso.com",
    "isAdminManaged": true,
    "isDefault": true,
    "isInitial": true,
    "isRoot": true,
    "isVerified": true,
    "supportedServices": [
        "Email",
        "OfficeCommunicationsOnline"
    ],
    "passwordValidityPeriodInDays": null,
    "passwordNotificationWindowInDays": null,
    "state": null
}